commandbar 1.8.6 → 1.9.0
Sign up to get free protection for your applications and to get access to all the features.
- package/build/commandbar-js/src/index.js +1 -1
- package/build/internal/src/client/AddContextOptions.d.ts +4 -0
- package/build/internal/src/client/AnalyticsEventTypes.d.ts +1 -1
- package/build/internal/src/client/CommandBarClientSDK.d.ts +25 -7
- package/build/internal/src/client/CommandBarProxySDK.d.ts +3 -3
- package/build/internal/src/client/CommandBarSDK.d.ts +23 -12
- package/build/internal/src/client/EventHandler.d.ts +19 -5
- package/build/internal/src/client/globals.d.ts +6 -0
- package/build/internal/src/client/symbols.d.ts +11 -6
- package/build/internal/src/middleware/CommandFromClientV.d.ts +68 -10
- package/build/internal/src/middleware/OrganizationV.d.ts +124 -20
- package/build/internal/src/middleware/additionalResource.d.ts +178 -16
- package/build/internal/src/middleware/billing.d.ts +33 -0
- package/build/internal/src/middleware/chat.d.ts +10913 -0
- package/build/internal/src/middleware/checklist.d.ts +106 -28
- package/build/internal/src/middleware/command.d.ts +3778 -446
- package/build/internal/src/middleware/detailPreview.d.ts +12 -1
- package/build/internal/src/middleware/endUser.d.ts +104 -0
- package/build/internal/src/middleware/generics.d.ts +12 -11
- package/build/internal/src/middleware/helpDocsIntegration.d.ts +54 -8
- package/build/internal/src/middleware/helpDocsSearch.d.ts +2204 -0
- package/build/internal/src/middleware/helpHub.d.ts +26 -0
- package/build/internal/src/middleware/helpers/actions.d.ts +116 -8
- package/build/internal/src/middleware/helpers/commandTemplate.d.ts +82 -2
- package/build/internal/src/middleware/helpers/pushTrigger.d.ts +6 -0
- package/build/internal/src/middleware/helpers/rules.d.ts +285 -26
- package/build/internal/src/middleware/network.d.ts +18 -3
- package/build/internal/src/middleware/nudge.d.ts +1193 -43
- package/build/internal/src/middleware/organization.d.ts +1051 -141
- package/build/internal/src/middleware/organizationSettings.d.ts +129 -22
- package/build/internal/src/middleware/recommendationSet.d.ts +408 -1007
- package/build/internal/src/middleware/types.d.ts +43 -25
- package/build/internal/src/util/dispatchCustomEvent.d.ts +3 -1
- package/build/internal/src/util/operatingSystem.d.ts +13 -0
- package/build/internal/src/util/sentry.d.ts +23 -0
- package/package.json +4 -4
- package/build/internal/src/client/SentryReporter.d.ts +0 -63
- package/build/internal/src/middleware/chatAnalytics.d.ts +0 -2601
- package/build/internal/src/middleware/helpers/endUser.d.ts +0 -11
- package/build/internal/src/middleware/qaPair.d.ts +0 -676
- package/build/internal/src/util/integrations.d.ts +0 -1
- package/src/commandbar-launcher.d.ts +0 -7
@@ -12,7 +12,7 @@ export declare const OrganizationStatusV: t.TypeC<{
|
|
12
12
|
export declare const KeyEventV: t.UnionC<[t.LiteralC<"Client-Error">, t.LiteralC<"Command execution">, t.LiteralC<"Command suggestion">, t.LiteralC<"Abandoned search">, t.LiteralC<"Search miss">]>;
|
13
13
|
export declare const InternalSettingsV: t.TypeC<{
|
14
14
|
id: t.StringC;
|
15
|
-
integrations: t.RecordC<t.StringC, t.RecordC<t.StringC, t.
|
15
|
+
integrations: t.RecordC<t.StringC, t.RecordC<t.StringC, t.AnyC>>;
|
16
16
|
}>;
|
17
17
|
export declare const read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
|
18
18
|
onSuccess?: (() => void) | undefined;
|
@@ -23,16 +23,11 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
23
23
|
created: string;
|
24
24
|
} & {} & {
|
25
25
|
launcher_type: "alternate" | "none" | "prompt" | "minimal";
|
26
|
-
launcher_position: "
|
26
|
+
launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
27
27
|
show_launcher_recommendations: boolean;
|
28
28
|
recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
|
29
29
|
launcher_offset_x: number;
|
30
30
|
launcher_offset_y: number;
|
31
|
-
helphub_launcher_offset_x: number;
|
32
|
-
helphub_launcher_offset_y: number;
|
33
|
-
helphub_launcher_anchor: string;
|
34
|
-
helphub_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
35
|
-
helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle";
|
36
31
|
base_url: string;
|
37
32
|
theme: object;
|
38
33
|
icon: string;
|
@@ -77,23 +72,23 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
77
72
|
setting_pin_to_bottom?: boolean | undefined;
|
78
73
|
track_recents?: boolean | undefined;
|
79
74
|
detail?: string | ({
|
80
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
75
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
81
76
|
value: string;
|
82
77
|
} & {
|
83
78
|
position?: "inline" | "popover" | undefined;
|
84
79
|
}) | (string | ({
|
85
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
80
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
86
81
|
value: string;
|
87
82
|
} & {
|
88
83
|
position?: "inline" | "popover" | undefined;
|
89
84
|
}))[] | null | undefined;
|
90
85
|
content?: string | ({
|
91
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
86
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
92
87
|
value: string;
|
93
88
|
} & {
|
94
89
|
position?: "inline" | "popover" | undefined;
|
95
90
|
}) | (string | ({
|
96
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
91
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
97
92
|
value: string;
|
98
93
|
} & {
|
99
94
|
position?: "inline" | "popover" | undefined;
|
@@ -134,10 +129,8 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
134
129
|
bar_enabled: boolean;
|
135
130
|
in_bar_doc_search: boolean;
|
136
131
|
featured_item_cards: boolean;
|
137
|
-
helphub_ai_enabled: boolean;
|
138
132
|
helphub_suggested_queries_enabled: boolean;
|
139
133
|
helphub_continuations_enabled: boolean;
|
140
|
-
helphub_chat_only_mode: boolean;
|
141
134
|
helphub_enabled: boolean;
|
142
135
|
helphub_chat_fallback_message: string | null;
|
143
136
|
helphub_chat_fallback_actions: {
|
@@ -147,8 +140,6 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
147
140
|
meta: {
|
148
141
|
command: string;
|
149
142
|
};
|
150
|
-
} | {
|
151
|
-
type: "no_action";
|
152
143
|
} | {
|
153
144
|
type: "click";
|
154
145
|
value: string;
|
@@ -164,12 +155,33 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
164
155
|
};
|
165
156
|
} | {
|
166
157
|
type: "dismiss";
|
158
|
+
} | {
|
159
|
+
type: "snooze";
|
160
|
+
} | {
|
161
|
+
type: "questlist";
|
162
|
+
value: number;
|
163
|
+
} | {
|
164
|
+
type: "step_back";
|
165
|
+
} | {
|
166
|
+
type: "nudge";
|
167
|
+
value: number;
|
168
|
+
} | {
|
169
|
+
type: "go_to_step";
|
170
|
+
value: number;
|
171
|
+
} | ({
|
172
|
+
type: "open_bar";
|
173
|
+
} & {
|
174
|
+
value?: string | undefined;
|
175
|
+
categoryFilter?: number | undefined;
|
176
|
+
}) | {
|
177
|
+
type: "no_action";
|
167
178
|
};
|
168
179
|
}[];
|
169
180
|
helphub_manual_suggested_queries: string[];
|
170
181
|
nudge_rate_limit: number | null;
|
171
182
|
bar_hide_completed_nudges_questlists: boolean;
|
172
183
|
nudge_rate_period: "day" | "week" | "session";
|
184
|
+
share_link_param: string;
|
173
185
|
installed_at: string | null;
|
174
186
|
integrations: {
|
175
187
|
algolia?: {
|
@@ -187,7 +199,46 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
187
199
|
};
|
188
200
|
send_events_to_heap: boolean;
|
189
201
|
} | undefined;
|
202
|
+
amplitude?: {
|
203
|
+
enabled: boolean;
|
204
|
+
} | undefined;
|
205
|
+
logrocket?: {
|
206
|
+
enabled: boolean;
|
207
|
+
} | undefined;
|
208
|
+
mixpanel?: {
|
209
|
+
enabled: boolean;
|
210
|
+
} | undefined;
|
211
|
+
posthog?: {
|
212
|
+
enabled: boolean;
|
213
|
+
} | undefined;
|
214
|
+
slack?: {
|
215
|
+
channelId: string;
|
216
|
+
configuration: {
|
217
|
+
analytic_events: string[];
|
218
|
+
};
|
219
|
+
} | undefined;
|
220
|
+
hubspot?: {
|
221
|
+
send_events_to_hubspot?: boolean | undefined;
|
222
|
+
lists?: {
|
223
|
+
[x: string]: string;
|
224
|
+
} | undefined;
|
225
|
+
} | undefined;
|
190
226
|
};
|
227
|
+
copilot_enabled: boolean;
|
228
|
+
helphub_ai_enabled: boolean;
|
229
|
+
copilot_experiences_enabled: boolean;
|
230
|
+
helphub_chat_only_mode: boolean;
|
231
|
+
} & {
|
232
|
+
helphub_launcher_offset_x: number;
|
233
|
+
helphub_launcher_offset_y: number;
|
234
|
+
helphub_launcher_anchor: string;
|
235
|
+
helphub_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
236
|
+
helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
|
237
|
+
helphub_mobile_launcher_offset_x: number;
|
238
|
+
helphub_mobile_launcher_offset_y: number;
|
239
|
+
helphub_mobile_launcher_anchor: string;
|
240
|
+
helphub_mobile_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
241
|
+
helphub_mobile_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
|
191
242
|
}>;
|
192
243
|
export declare const update: (object: {
|
193
244
|
id: string | number;
|
@@ -195,16 +246,11 @@ export declare const update: (object: {
|
|
195
246
|
created: string;
|
196
247
|
} & {} & {
|
197
248
|
launcher_type: "alternate" | "none" | "prompt" | "minimal";
|
198
|
-
launcher_position: "
|
249
|
+
launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
199
250
|
show_launcher_recommendations: boolean;
|
200
251
|
recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
|
201
252
|
launcher_offset_x: number;
|
202
253
|
launcher_offset_y: number;
|
203
|
-
helphub_launcher_offset_x: number;
|
204
|
-
helphub_launcher_offset_y: number;
|
205
|
-
helphub_launcher_anchor: string;
|
206
|
-
helphub_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
207
|
-
helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle";
|
208
254
|
base_url: string;
|
209
255
|
theme: object;
|
210
256
|
icon: string;
|
@@ -249,23 +295,23 @@ export declare const update: (object: {
|
|
249
295
|
setting_pin_to_bottom?: boolean | undefined;
|
250
296
|
track_recents?: boolean | undefined;
|
251
297
|
detail?: string | ({
|
252
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
298
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
253
299
|
value: string;
|
254
300
|
} & {
|
255
301
|
position?: "inline" | "popover" | undefined;
|
256
302
|
}) | (string | ({
|
257
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
303
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
258
304
|
value: string;
|
259
305
|
} & {
|
260
306
|
position?: "inline" | "popover" | undefined;
|
261
307
|
}))[] | null | undefined;
|
262
308
|
content?: string | ({
|
263
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
309
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
264
310
|
value: string;
|
265
311
|
} & {
|
266
312
|
position?: "inline" | "popover" | undefined;
|
267
313
|
}) | (string | ({
|
268
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
314
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
269
315
|
value: string;
|
270
316
|
} & {
|
271
317
|
position?: "inline" | "popover" | undefined;
|
@@ -306,10 +352,8 @@ export declare const update: (object: {
|
|
306
352
|
bar_enabled: boolean;
|
307
353
|
in_bar_doc_search: boolean;
|
308
354
|
featured_item_cards: boolean;
|
309
|
-
helphub_ai_enabled: boolean;
|
310
355
|
helphub_suggested_queries_enabled: boolean;
|
311
356
|
helphub_continuations_enabled: boolean;
|
312
|
-
helphub_chat_only_mode: boolean;
|
313
357
|
helphub_enabled: boolean;
|
314
358
|
helphub_chat_fallback_message: string | null;
|
315
359
|
helphub_chat_fallback_actions: {
|
@@ -319,8 +363,6 @@ export declare const update: (object: {
|
|
319
363
|
meta: {
|
320
364
|
command: string;
|
321
365
|
};
|
322
|
-
} | {
|
323
|
-
type: "no_action";
|
324
366
|
} | {
|
325
367
|
type: "click";
|
326
368
|
value: string;
|
@@ -336,12 +378,33 @@ export declare const update: (object: {
|
|
336
378
|
};
|
337
379
|
} | {
|
338
380
|
type: "dismiss";
|
381
|
+
} | {
|
382
|
+
type: "snooze";
|
383
|
+
} | {
|
384
|
+
type: "questlist";
|
385
|
+
value: number;
|
386
|
+
} | {
|
387
|
+
type: "step_back";
|
388
|
+
} | {
|
389
|
+
type: "nudge";
|
390
|
+
value: number;
|
391
|
+
} | {
|
392
|
+
type: "go_to_step";
|
393
|
+
value: number;
|
394
|
+
} | ({
|
395
|
+
type: "open_bar";
|
396
|
+
} & {
|
397
|
+
value?: string | undefined;
|
398
|
+
categoryFilter?: number | undefined;
|
399
|
+
}) | {
|
400
|
+
type: "no_action";
|
339
401
|
};
|
340
402
|
}[];
|
341
403
|
helphub_manual_suggested_queries: string[];
|
342
404
|
nudge_rate_limit: number | null;
|
343
405
|
bar_hide_completed_nudges_questlists: boolean;
|
344
406
|
nudge_rate_period: "day" | "week" | "session";
|
407
|
+
share_link_param: string;
|
345
408
|
installed_at: string | null;
|
346
409
|
integrations: {
|
347
410
|
algolia?: {
|
@@ -359,23 +422,57 @@ export declare const update: (object: {
|
|
359
422
|
};
|
360
423
|
send_events_to_heap: boolean;
|
361
424
|
} | undefined;
|
425
|
+
amplitude?: {
|
426
|
+
enabled: boolean;
|
427
|
+
} | undefined;
|
428
|
+
logrocket?: {
|
429
|
+
enabled: boolean;
|
430
|
+
} | undefined;
|
431
|
+
mixpanel?: {
|
432
|
+
enabled: boolean;
|
433
|
+
} | undefined;
|
434
|
+
posthog?: {
|
435
|
+
enabled: boolean;
|
436
|
+
} | undefined;
|
437
|
+
slack?: {
|
438
|
+
channelId: string;
|
439
|
+
configuration: {
|
440
|
+
analytic_events: string[];
|
441
|
+
};
|
442
|
+
} | undefined;
|
443
|
+
hubspot?: {
|
444
|
+
send_events_to_hubspot?: boolean | undefined;
|
445
|
+
lists?: {
|
446
|
+
[x: string]: string;
|
447
|
+
} | undefined;
|
448
|
+
} | undefined;
|
362
449
|
};
|
450
|
+
copilot_enabled: boolean;
|
451
|
+
helphub_ai_enabled: boolean;
|
452
|
+
copilot_experiences_enabled: boolean;
|
453
|
+
helphub_chat_only_mode: boolean;
|
454
|
+
} & {
|
455
|
+
helphub_launcher_offset_x: number;
|
456
|
+
helphub_launcher_offset_y: number;
|
457
|
+
helphub_launcher_anchor: string;
|
458
|
+
helphub_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
459
|
+
helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
|
460
|
+
helphub_mobile_launcher_offset_x: number;
|
461
|
+
helphub_mobile_launcher_offset_y: number;
|
462
|
+
helphub_mobile_launcher_anchor: string;
|
463
|
+
helphub_mobile_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
464
|
+
helphub_mobile_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
|
363
465
|
}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
364
466
|
id: string | number;
|
365
467
|
name: string;
|
366
468
|
created: string;
|
367
469
|
} & {} & {
|
368
470
|
launcher_type: "alternate" | "none" | "prompt" | "minimal";
|
369
|
-
launcher_position: "
|
471
|
+
launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
370
472
|
show_launcher_recommendations: boolean;
|
371
473
|
recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
|
372
474
|
launcher_offset_x: number;
|
373
475
|
launcher_offset_y: number;
|
374
|
-
helphub_launcher_offset_x: number;
|
375
|
-
helphub_launcher_offset_y: number;
|
376
|
-
helphub_launcher_anchor: string;
|
377
|
-
helphub_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
378
|
-
helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle";
|
379
476
|
base_url: string;
|
380
477
|
theme: object;
|
381
478
|
icon: string;
|
@@ -420,23 +517,23 @@ export declare const update: (object: {
|
|
420
517
|
setting_pin_to_bottom?: boolean | undefined;
|
421
518
|
track_recents?: boolean | undefined;
|
422
519
|
detail?: string | ({
|
423
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
520
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
424
521
|
value: string;
|
425
522
|
} & {
|
426
523
|
position?: "inline" | "popover" | undefined;
|
427
524
|
}) | (string | ({
|
428
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
525
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
429
526
|
value: string;
|
430
527
|
} & {
|
431
528
|
position?: "inline" | "popover" | undefined;
|
432
529
|
}))[] | null | undefined;
|
433
530
|
content?: string | ({
|
434
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
531
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
435
532
|
value: string;
|
436
533
|
} & {
|
437
534
|
position?: "inline" | "popover" | undefined;
|
438
535
|
}) | (string | ({
|
439
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
536
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
440
537
|
value: string;
|
441
538
|
} & {
|
442
539
|
position?: "inline" | "popover" | undefined;
|
@@ -477,10 +574,8 @@ export declare const update: (object: {
|
|
477
574
|
bar_enabled: boolean;
|
478
575
|
in_bar_doc_search: boolean;
|
479
576
|
featured_item_cards: boolean;
|
480
|
-
helphub_ai_enabled: boolean;
|
481
577
|
helphub_suggested_queries_enabled: boolean;
|
482
578
|
helphub_continuations_enabled: boolean;
|
483
|
-
helphub_chat_only_mode: boolean;
|
484
579
|
helphub_enabled: boolean;
|
485
580
|
helphub_chat_fallback_message: string | null;
|
486
581
|
helphub_chat_fallback_actions: {
|
@@ -490,8 +585,6 @@ export declare const update: (object: {
|
|
490
585
|
meta: {
|
491
586
|
command: string;
|
492
587
|
};
|
493
|
-
} | {
|
494
|
-
type: "no_action";
|
495
588
|
} | {
|
496
589
|
type: "click";
|
497
590
|
value: string;
|
@@ -507,12 +600,33 @@ export declare const update: (object: {
|
|
507
600
|
};
|
508
601
|
} | {
|
509
602
|
type: "dismiss";
|
603
|
+
} | {
|
604
|
+
type: "snooze";
|
605
|
+
} | {
|
606
|
+
type: "questlist";
|
607
|
+
value: number;
|
608
|
+
} | {
|
609
|
+
type: "step_back";
|
610
|
+
} | {
|
611
|
+
type: "nudge";
|
612
|
+
value: number;
|
613
|
+
} | {
|
614
|
+
type: "go_to_step";
|
615
|
+
value: number;
|
616
|
+
} | ({
|
617
|
+
type: "open_bar";
|
618
|
+
} & {
|
619
|
+
value?: string | undefined;
|
620
|
+
categoryFilter?: number | undefined;
|
621
|
+
}) | {
|
622
|
+
type: "no_action";
|
510
623
|
};
|
511
624
|
}[];
|
512
625
|
helphub_manual_suggested_queries: string[];
|
513
626
|
nudge_rate_limit: number | null;
|
514
627
|
bar_hide_completed_nudges_questlists: boolean;
|
515
628
|
nudge_rate_period: "day" | "week" | "session";
|
629
|
+
share_link_param: string;
|
516
630
|
installed_at: string | null;
|
517
631
|
integrations: {
|
518
632
|
algolia?: {
|
@@ -530,11 +644,49 @@ export declare const update: (object: {
|
|
530
644
|
};
|
531
645
|
send_events_to_heap: boolean;
|
532
646
|
} | undefined;
|
647
|
+
amplitude?: {
|
648
|
+
enabled: boolean;
|
649
|
+
} | undefined;
|
650
|
+
logrocket?: {
|
651
|
+
enabled: boolean;
|
652
|
+
} | undefined;
|
653
|
+
mixpanel?: {
|
654
|
+
enabled: boolean;
|
655
|
+
} | undefined;
|
656
|
+
posthog?: {
|
657
|
+
enabled: boolean;
|
658
|
+
} | undefined;
|
659
|
+
slack?: {
|
660
|
+
channelId: string;
|
661
|
+
configuration: {
|
662
|
+
analytic_events: string[];
|
663
|
+
};
|
664
|
+
} | undefined;
|
665
|
+
hubspot?: {
|
666
|
+
send_events_to_hubspot?: boolean | undefined;
|
667
|
+
lists?: {
|
668
|
+
[x: string]: string;
|
669
|
+
} | undefined;
|
670
|
+
} | undefined;
|
533
671
|
};
|
672
|
+
copilot_enabled: boolean;
|
673
|
+
helphub_ai_enabled: boolean;
|
674
|
+
copilot_experiences_enabled: boolean;
|
675
|
+
helphub_chat_only_mode: boolean;
|
676
|
+
} & {
|
677
|
+
helphub_launcher_offset_x: number;
|
678
|
+
helphub_launcher_offset_y: number;
|
679
|
+
helphub_launcher_anchor: string;
|
680
|
+
helphub_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
681
|
+
helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
|
682
|
+
helphub_mobile_launcher_offset_x: number;
|
683
|
+
helphub_mobile_launcher_offset_y: number;
|
684
|
+
helphub_mobile_launcher_anchor: string;
|
685
|
+
helphub_mobile_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
686
|
+
helphub_mobile_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
|
534
687
|
}>;
|
535
688
|
export declare const listCommands: (orgUID: string) => Promise<({
|
536
689
|
id: number;
|
537
|
-
organization: string | number;
|
538
690
|
text: string;
|
539
691
|
template: ({
|
540
692
|
type: "admin";
|
@@ -597,7 +749,7 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
597
749
|
}) | ({
|
598
750
|
type: "request";
|
599
751
|
value: {
|
600
|
-
method: "head" | "options" | "get" | "
|
752
|
+
method: "head" | "options" | "get" | "post" | "put" | "delete" | "patch";
|
601
753
|
url: string;
|
602
754
|
} & {
|
603
755
|
headers?: {
|
@@ -649,7 +801,47 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
649
801
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
650
802
|
}) | ({
|
651
803
|
type: "trigger";
|
652
|
-
value:
|
804
|
+
value: {
|
805
|
+
type: "execute_command";
|
806
|
+
meta: {
|
807
|
+
command: string;
|
808
|
+
};
|
809
|
+
} | {
|
810
|
+
type: "click";
|
811
|
+
value: string;
|
812
|
+
} | ({
|
813
|
+
type: "link";
|
814
|
+
value: string;
|
815
|
+
} & {
|
816
|
+
operation?: "self" | "router" | "blank" | undefined;
|
817
|
+
}) | {
|
818
|
+
type: "open_chat";
|
819
|
+
meta: {
|
820
|
+
type: string;
|
821
|
+
};
|
822
|
+
} | {
|
823
|
+
type: "dismiss";
|
824
|
+
} | {
|
825
|
+
type: "snooze";
|
826
|
+
} | {
|
827
|
+
type: "questlist";
|
828
|
+
value: number;
|
829
|
+
} | {
|
830
|
+
type: "step_back";
|
831
|
+
} | {
|
832
|
+
type: "nudge";
|
833
|
+
value: number;
|
834
|
+
} | {
|
835
|
+
type: "go_to_step";
|
836
|
+
value: number;
|
837
|
+
} | ({
|
838
|
+
type: "open_bar";
|
839
|
+
} & {
|
840
|
+
value?: string | undefined;
|
841
|
+
categoryFilter?: number | undefined;
|
842
|
+
}) | {
|
843
|
+
type: "no_action";
|
844
|
+
};
|
653
845
|
} & {} & {
|
654
846
|
commandType?: "object" | "help" | "independent" | undefined;
|
655
847
|
object?: string | undefined;
|
@@ -668,25 +860,12 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
668
860
|
confirm: string;
|
669
861
|
icon: string | null;
|
670
862
|
heading: string;
|
671
|
-
icon_color: string | null;
|
672
|
-
image_color: string | null;
|
673
863
|
sort_key: number | null;
|
674
|
-
show_preview: boolean;
|
675
864
|
is_live: boolean;
|
676
|
-
|
677
|
-
|
678
|
-
|
679
|
-
|
680
|
-
height?: string | undefined;
|
681
|
-
duration?: number | undefined;
|
682
|
-
dragFriction?: number | undefined;
|
683
|
-
stagger?: number | undefined;
|
684
|
-
startVelocity?: number | undefined;
|
685
|
-
elementCount?: number | undefined;
|
686
|
-
decay?: number | undefined;
|
687
|
-
colors?: string[] | undefined;
|
688
|
-
random?: any;
|
689
|
-
} | null;
|
865
|
+
copilot_suggest: boolean;
|
866
|
+
copilot_cta_label: string;
|
867
|
+
copilot_description: string;
|
868
|
+
tags: string[];
|
690
869
|
arguments: {
|
691
870
|
[x: string]: ({
|
692
871
|
type: "context";
|
@@ -765,37 +944,113 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
765
944
|
auto_choose?: boolean | undefined;
|
766
945
|
});
|
767
946
|
};
|
768
|
-
|
769
|
-
|
770
|
-
|
771
|
-
|
947
|
+
celebrate: boolean | {
|
948
|
+
angle?: number | undefined;
|
949
|
+
spread?: number | undefined;
|
950
|
+
width?: string | undefined;
|
951
|
+
height?: string | undefined;
|
952
|
+
duration?: number | undefined;
|
953
|
+
dragFriction?: number | undefined;
|
954
|
+
stagger?: number | undefined;
|
955
|
+
startVelocity?: number | undefined;
|
956
|
+
elementCount?: number | undefined;
|
957
|
+
decay?: number | undefined;
|
958
|
+
colors?: string[] | undefined;
|
959
|
+
random?: any;
|
960
|
+
} | null;
|
961
|
+
icon_color: string | null;
|
962
|
+
image_color: string | null;
|
963
|
+
show_preview: boolean;
|
964
|
+
availability_rules: (({
|
965
|
+
type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "hubspot";
|
966
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot";
|
772
967
|
} & {
|
773
968
|
field?: string | undefined;
|
774
969
|
value?: string | undefined;
|
775
970
|
reason?: string | undefined;
|
776
971
|
rule_id?: string | number | undefined;
|
777
|
-
})
|
972
|
+
}) | ({
|
973
|
+
type: "nudge_interaction";
|
974
|
+
operator: "is" | "isNot";
|
975
|
+
value: "completed" | "dismissed" | "viewed";
|
976
|
+
nudge_id: number;
|
977
|
+
} & {
|
978
|
+
reason?: string | undefined;
|
979
|
+
}) | ({
|
980
|
+
type: "questlist_interaction";
|
981
|
+
operator: "is" | "isNot";
|
982
|
+
value: "completed" | "dismissed" | "viewed";
|
983
|
+
questlist_id: number;
|
984
|
+
} & {
|
985
|
+
reason?: string | undefined;
|
986
|
+
}) | ({
|
987
|
+
type: "browser" | "language" | "os";
|
988
|
+
operator: "includes" | "doesNotInclude";
|
989
|
+
values: string[];
|
990
|
+
} & {
|
991
|
+
reason?: string | undefined;
|
992
|
+
}))[] | (({
|
778
993
|
type: "named_rule";
|
779
994
|
rule_id: string | number;
|
780
995
|
} & {
|
781
996
|
reason?: string | undefined;
|
782
997
|
}) | ({
|
783
|
-
type: "url" | "element" | "context" | "
|
784
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "
|
998
|
+
type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "hubspot";
|
999
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot";
|
785
1000
|
} & {
|
786
1001
|
field?: string | undefined;
|
787
1002
|
value?: string | undefined;
|
788
1003
|
reason?: string | undefined;
|
789
1004
|
rule_id?: string | number | undefined;
|
1005
|
+
}) | ({
|
1006
|
+
type: "nudge_interaction";
|
1007
|
+
operator: "is" | "isNot";
|
1008
|
+
value: "completed" | "dismissed" | "viewed";
|
1009
|
+
nudge_id: number;
|
1010
|
+
} & {
|
1011
|
+
reason?: string | undefined;
|
1012
|
+
}) | ({
|
1013
|
+
type: "questlist_interaction";
|
1014
|
+
operator: "is" | "isNot";
|
1015
|
+
value: "completed" | "dismissed" | "viewed";
|
1016
|
+
questlist_id: number;
|
1017
|
+
} & {
|
1018
|
+
reason?: string | undefined;
|
1019
|
+
}) | ({
|
1020
|
+
type: "browser" | "language" | "os";
|
1021
|
+
operator: "includes" | "doesNotInclude";
|
1022
|
+
values: string[];
|
1023
|
+
} & {
|
1024
|
+
reason?: string | undefined;
|
790
1025
|
}))[];
|
791
1026
|
recommend_rules: (({
|
792
|
-
type: "url" | "element" | "context" | "
|
793
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "
|
1027
|
+
type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "hubspot";
|
1028
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot";
|
794
1029
|
} & {
|
795
1030
|
field?: string | undefined;
|
796
1031
|
value?: string | undefined;
|
797
1032
|
reason?: string | undefined;
|
798
1033
|
rule_id?: string | number | undefined;
|
1034
|
+
}) | ({
|
1035
|
+
type: "nudge_interaction";
|
1036
|
+
operator: "is" | "isNot";
|
1037
|
+
value: "completed" | "dismissed" | "viewed";
|
1038
|
+
nudge_id: number;
|
1039
|
+
} & {
|
1040
|
+
reason?: string | undefined;
|
1041
|
+
}) | ({
|
1042
|
+
type: "questlist_interaction";
|
1043
|
+
operator: "is" | "isNot";
|
1044
|
+
value: "completed" | "dismissed" | "viewed";
|
1045
|
+
questlist_id: number;
|
1046
|
+
} & {
|
1047
|
+
reason?: string | undefined;
|
1048
|
+
}) | ({
|
1049
|
+
type: "browser" | "language" | "os";
|
1050
|
+
operator: "includes" | "doesNotInclude";
|
1051
|
+
values: string[];
|
1052
|
+
} & {
|
1053
|
+
reason?: string | undefined;
|
799
1054
|
}) | ({
|
800
1055
|
type: "always";
|
801
1056
|
} & {
|
@@ -810,13 +1065,33 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
810
1065
|
} & {
|
811
1066
|
reason?: string | undefined;
|
812
1067
|
}) | ({
|
813
|
-
type: "url" | "element" | "context" | "
|
814
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "
|
1068
|
+
type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "hubspot";
|
1069
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot";
|
815
1070
|
} & {
|
816
1071
|
field?: string | undefined;
|
817
1072
|
value?: string | undefined;
|
818
1073
|
reason?: string | undefined;
|
819
1074
|
rule_id?: string | number | undefined;
|
1075
|
+
}) | ({
|
1076
|
+
type: "nudge_interaction";
|
1077
|
+
operator: "is" | "isNot";
|
1078
|
+
value: "completed" | "dismissed" | "viewed";
|
1079
|
+
nudge_id: number;
|
1080
|
+
} & {
|
1081
|
+
reason?: string | undefined;
|
1082
|
+
}) | ({
|
1083
|
+
type: "questlist_interaction";
|
1084
|
+
operator: "is" | "isNot";
|
1085
|
+
value: "completed" | "dismissed" | "viewed";
|
1086
|
+
questlist_id: number;
|
1087
|
+
} & {
|
1088
|
+
reason?: string | undefined;
|
1089
|
+
}) | ({
|
1090
|
+
type: "browser" | "language" | "os";
|
1091
|
+
operator: "includes" | "doesNotInclude";
|
1092
|
+
values: string[];
|
1093
|
+
} & {
|
1094
|
+
reason?: string | undefined;
|
820
1095
|
}) | ({
|
821
1096
|
type: "always";
|
822
1097
|
} & {
|
@@ -843,8 +1118,6 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
843
1118
|
meta: {
|
844
1119
|
command: string;
|
845
1120
|
};
|
846
|
-
} | {
|
847
|
-
type: "no_action";
|
848
1121
|
} | {
|
849
1122
|
type: "click";
|
850
1123
|
value: string;
|
@@ -860,6 +1133,26 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
860
1133
|
};
|
861
1134
|
} | {
|
862
1135
|
type: "dismiss";
|
1136
|
+
} | {
|
1137
|
+
type: "snooze";
|
1138
|
+
} | {
|
1139
|
+
type: "questlist";
|
1140
|
+
value: number;
|
1141
|
+
} | {
|
1142
|
+
type: "step_back";
|
1143
|
+
} | {
|
1144
|
+
type: "nudge";
|
1145
|
+
value: number;
|
1146
|
+
} | {
|
1147
|
+
type: "go_to_step";
|
1148
|
+
value: number;
|
1149
|
+
} | ({
|
1150
|
+
type: "open_bar";
|
1151
|
+
} & {
|
1152
|
+
value?: string | undefined;
|
1153
|
+
categoryFilter?: number | undefined;
|
1154
|
+
}) | {
|
1155
|
+
type: "no_action";
|
863
1156
|
};
|
864
1157
|
})[];
|
865
1158
|
thumbnail: {
|
@@ -876,10 +1169,13 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
876
1169
|
third_party_source?: string | null | undefined;
|
877
1170
|
third_party_id?: string | null | undefined;
|
878
1171
|
training_only?: boolean | undefined;
|
1172
|
+
integration?: {
|
1173
|
+
id: number;
|
1174
|
+
helphub_view_article_button_hidden: boolean | undefined;
|
1175
|
+
} | null | undefined;
|
879
1176
|
})[]>;
|
880
|
-
export declare const
|
1177
|
+
export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
881
1178
|
id: number;
|
882
|
-
organization: string | number;
|
883
1179
|
text: string;
|
884
1180
|
template: ({
|
885
1181
|
type: "admin";
|
@@ -942,7 +1238,7 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
942
1238
|
}) | ({
|
943
1239
|
type: "request";
|
944
1240
|
value: {
|
945
|
-
method: "head" | "options" | "get" | "
|
1241
|
+
method: "head" | "options" | "get" | "post" | "put" | "delete" | "patch";
|
946
1242
|
url: string;
|
947
1243
|
} & {
|
948
1244
|
headers?: {
|
@@ -994,7 +1290,47 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
994
1290
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
995
1291
|
}) | ({
|
996
1292
|
type: "trigger";
|
997
|
-
value:
|
1293
|
+
value: {
|
1294
|
+
type: "execute_command";
|
1295
|
+
meta: {
|
1296
|
+
command: string;
|
1297
|
+
};
|
1298
|
+
} | {
|
1299
|
+
type: "click";
|
1300
|
+
value: string;
|
1301
|
+
} | ({
|
1302
|
+
type: "link";
|
1303
|
+
value: string;
|
1304
|
+
} & {
|
1305
|
+
operation?: "self" | "router" | "blank" | undefined;
|
1306
|
+
}) | {
|
1307
|
+
type: "open_chat";
|
1308
|
+
meta: {
|
1309
|
+
type: string;
|
1310
|
+
};
|
1311
|
+
} | {
|
1312
|
+
type: "dismiss";
|
1313
|
+
} | {
|
1314
|
+
type: "snooze";
|
1315
|
+
} | {
|
1316
|
+
type: "questlist";
|
1317
|
+
value: number;
|
1318
|
+
} | {
|
1319
|
+
type: "step_back";
|
1320
|
+
} | {
|
1321
|
+
type: "nudge";
|
1322
|
+
value: number;
|
1323
|
+
} | {
|
1324
|
+
type: "go_to_step";
|
1325
|
+
value: number;
|
1326
|
+
} | ({
|
1327
|
+
type: "open_bar";
|
1328
|
+
} & {
|
1329
|
+
value?: string | undefined;
|
1330
|
+
categoryFilter?: number | undefined;
|
1331
|
+
}) | {
|
1332
|
+
type: "no_action";
|
1333
|
+
};
|
998
1334
|
} & {} & {
|
999
1335
|
commandType?: "object" | "help" | "independent" | undefined;
|
1000
1336
|
object?: string | undefined;
|
@@ -1088,57 +1424,571 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
1088
1424
|
});
|
1089
1425
|
};
|
1090
1426
|
tags: string[];
|
1091
|
-
availability_rules: ({
|
1092
|
-
type: "url" | "element" | "context" | "
|
1093
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "
|
1427
|
+
availability_rules: (({
|
1428
|
+
type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "hubspot";
|
1429
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot";
|
1094
1430
|
} & {
|
1095
1431
|
field?: string | undefined;
|
1096
1432
|
value?: string | undefined;
|
1097
1433
|
reason?: string | undefined;
|
1098
1434
|
rule_id?: string | number | undefined;
|
1099
|
-
})
|
1100
|
-
type: "
|
1101
|
-
|
1435
|
+
}) | ({
|
1436
|
+
type: "nudge_interaction";
|
1437
|
+
operator: "is" | "isNot";
|
1438
|
+
value: "completed" | "dismissed" | "viewed";
|
1439
|
+
nudge_id: number;
|
1102
1440
|
} & {
|
1103
1441
|
reason?: string | undefined;
|
1104
1442
|
}) | ({
|
1105
|
-
type: "
|
1106
|
-
operator: "
|
1443
|
+
type: "questlist_interaction";
|
1444
|
+
operator: "is" | "isNot";
|
1445
|
+
value: "completed" | "dismissed" | "viewed";
|
1446
|
+
questlist_id: number;
|
1447
|
+
} & {
|
1448
|
+
reason?: string | undefined;
|
1449
|
+
}) | ({
|
1450
|
+
type: "browser" | "language" | "os";
|
1451
|
+
operator: "includes" | "doesNotInclude";
|
1452
|
+
values: string[];
|
1107
1453
|
} & {
|
1108
|
-
field?: string | undefined;
|
1109
|
-
value?: string | undefined;
|
1110
1454
|
reason?: string | undefined;
|
1111
|
-
rule_id?: string | number | undefined;
|
1112
1455
|
}))[];
|
1113
1456
|
recommend_rules: (({
|
1114
|
-
type: "url" | "element" | "context" | "
|
1115
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "
|
1457
|
+
type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "hubspot";
|
1458
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot";
|
1116
1459
|
} & {
|
1117
1460
|
field?: string | undefined;
|
1118
1461
|
value?: string | undefined;
|
1119
1462
|
reason?: string | undefined;
|
1120
1463
|
rule_id?: string | number | undefined;
|
1121
1464
|
}) | ({
|
1122
|
-
type: "
|
1465
|
+
type: "nudge_interaction";
|
1466
|
+
operator: "is" | "isNot";
|
1467
|
+
value: "completed" | "dismissed" | "viewed";
|
1468
|
+
nudge_id: number;
|
1123
1469
|
} & {
|
1124
|
-
|
1125
|
-
|
1126
|
-
|
1127
|
-
|
1128
|
-
|
1129
|
-
|
1470
|
+
reason?: string | undefined;
|
1471
|
+
}) | ({
|
1472
|
+
type: "questlist_interaction";
|
1473
|
+
operator: "is" | "isNot";
|
1474
|
+
value: "completed" | "dismissed" | "viewed";
|
1475
|
+
questlist_id: number;
|
1476
|
+
} & {
|
1477
|
+
reason?: string | undefined;
|
1478
|
+
}) | ({
|
1479
|
+
type: "browser" | "language" | "os";
|
1480
|
+
operator: "includes" | "doesNotInclude";
|
1481
|
+
values: string[];
|
1482
|
+
} & {
|
1483
|
+
reason?: string | undefined;
|
1484
|
+
}) | ({
|
1485
|
+
type: "always";
|
1486
|
+
} & {
|
1487
|
+
operator?: null | undefined;
|
1488
|
+
field?: null | undefined;
|
1489
|
+
value?: null | undefined;
|
1490
|
+
reason?: null | undefined;
|
1491
|
+
rule_id?: string | number | undefined;
|
1492
|
+
}))[];
|
1493
|
+
availability_expression: import("./helpers/rules").RuleExpression | null;
|
1494
|
+
recommend_expression: import("./helpers/rules").RuleExpression | null;
|
1495
|
+
always_recommend: boolean;
|
1496
|
+
confirm: string;
|
1497
|
+
shortcut: string[];
|
1498
|
+
explanation: string;
|
1499
|
+
heading: string;
|
1500
|
+
is_live: boolean;
|
1501
|
+
category: number | null;
|
1502
|
+
sort_key: number | null;
|
1503
|
+
icon: string | null;
|
1504
|
+
icon_color: string | null;
|
1505
|
+
image_color: string | null;
|
1506
|
+
image: string | null;
|
1507
|
+
celebrate: boolean | {
|
1508
|
+
angle?: number | undefined;
|
1509
|
+
spread?: number | undefined;
|
1510
|
+
width?: string | undefined;
|
1511
|
+
height?: string | undefined;
|
1512
|
+
duration?: number | undefined;
|
1513
|
+
dragFriction?: number | undefined;
|
1514
|
+
stagger?: number | undefined;
|
1515
|
+
startVelocity?: number | undefined;
|
1516
|
+
elementCount?: number | undefined;
|
1517
|
+
decay?: number | undefined;
|
1518
|
+
colors?: string[] | undefined;
|
1519
|
+
random?: any;
|
1520
|
+
} | null;
|
1521
|
+
recommend_sort_key: number | null;
|
1522
|
+
shortcut_mac: string[];
|
1523
|
+
shortcut_win: string[];
|
1524
|
+
hotkey_mac: string;
|
1525
|
+
hotkey_win: string;
|
1526
|
+
detail: string | ({
|
1527
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
1528
|
+
value: string;
|
1529
|
+
} & {
|
1530
|
+
position?: "inline" | "popover" | undefined;
|
1531
|
+
}) | (string | ({
|
1532
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
1533
|
+
value: string;
|
1534
|
+
} & {
|
1535
|
+
position?: "inline" | "popover" | undefined;
|
1536
|
+
}))[] | null;
|
1537
|
+
content: string | ({
|
1538
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
1539
|
+
value: string;
|
1540
|
+
} & {
|
1541
|
+
position?: "inline" | "popover" | undefined;
|
1542
|
+
}) | (string | ({
|
1543
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
1544
|
+
value: string;
|
1545
|
+
} & {
|
1546
|
+
position?: "inline" | "popover" | undefined;
|
1547
|
+
}))[] | null;
|
1548
|
+
show_preview: boolean;
|
1549
|
+
next_steps: (string | number | {
|
1550
|
+
cta: string;
|
1551
|
+
action: {
|
1552
|
+
type: "execute_command";
|
1553
|
+
meta: {
|
1554
|
+
command: string;
|
1555
|
+
};
|
1556
|
+
} | {
|
1557
|
+
type: "click";
|
1558
|
+
value: string;
|
1559
|
+
} | ({
|
1560
|
+
type: "link";
|
1561
|
+
value: string;
|
1562
|
+
} & {
|
1563
|
+
operation?: "self" | "router" | "blank" | undefined;
|
1564
|
+
}) | {
|
1565
|
+
type: "open_chat";
|
1566
|
+
meta: {
|
1567
|
+
type: string;
|
1568
|
+
};
|
1569
|
+
} | {
|
1570
|
+
type: "dismiss";
|
1571
|
+
} | {
|
1572
|
+
type: "snooze";
|
1573
|
+
} | {
|
1574
|
+
type: "questlist";
|
1575
|
+
value: number;
|
1576
|
+
} | {
|
1577
|
+
type: "step_back";
|
1578
|
+
} | {
|
1579
|
+
type: "nudge";
|
1580
|
+
value: number;
|
1581
|
+
} | {
|
1582
|
+
type: "go_to_step";
|
1583
|
+
value: number;
|
1584
|
+
} | ({
|
1585
|
+
type: "open_bar";
|
1586
|
+
} & {
|
1587
|
+
value?: string | undefined;
|
1588
|
+
categoryFilter?: number | undefined;
|
1589
|
+
}) | {
|
1590
|
+
type: "no_action";
|
1591
|
+
};
|
1592
|
+
})[];
|
1593
|
+
extra: string | null;
|
1594
|
+
thumbnail: {
|
1595
|
+
src: string;
|
1596
|
+
file_name: string;
|
1597
|
+
size: string;
|
1598
|
+
} | null;
|
1599
|
+
copilot_suggest: boolean;
|
1600
|
+
copilot_cta_label: string;
|
1601
|
+
copilot_description: string;
|
1602
|
+
} & {
|
1603
|
+
third_party_source?: string | null | undefined;
|
1604
|
+
third_party_id?: string | null | undefined;
|
1605
|
+
training_only?: boolean | undefined;
|
1606
|
+
integration?: {
|
1607
|
+
id: number;
|
1608
|
+
helphub_view_article_button_hidden: boolean | undefined;
|
1609
|
+
} | null | undefined;
|
1610
|
+
}>;
|
1611
|
+
export declare const listAnswers: (orgUID: string) => Promise<({
|
1612
|
+
id: number;
|
1613
|
+
text: string;
|
1614
|
+
template: ({
|
1615
|
+
type: "admin";
|
1616
|
+
value: string;
|
1617
|
+
} & {} & {
|
1618
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
1619
|
+
object?: string | undefined;
|
1620
|
+
hoverTooltip?: boolean | undefined;
|
1621
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1622
|
+
}) | ({
|
1623
|
+
type: "callback";
|
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
|
+
}) | ({
|
1631
|
+
type: "link";
|
1632
|
+
value: string;
|
1633
|
+
} & {
|
1634
|
+
operation?: "self" | "router" | "blank" | undefined;
|
1635
|
+
} & {} & {
|
1636
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
1637
|
+
object?: string | undefined;
|
1638
|
+
hoverTooltip?: boolean | undefined;
|
1639
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1640
|
+
}) | ({
|
1641
|
+
type: "click" | "clickByXpath" | "clickBySelector";
|
1642
|
+
value: string[];
|
1643
|
+
} & {} & {
|
1644
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
1645
|
+
object?: string | undefined;
|
1646
|
+
hoverTooltip?: boolean | undefined;
|
1647
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1648
|
+
}) | ({
|
1649
|
+
type: "builtin";
|
1650
|
+
value: string;
|
1651
|
+
} & {} & {
|
1652
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
1653
|
+
object?: string | undefined;
|
1654
|
+
hoverTooltip?: boolean | undefined;
|
1655
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1656
|
+
}) | ({
|
1657
|
+
type: "webhook";
|
1658
|
+
value: string;
|
1659
|
+
} & {} & {
|
1660
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
1661
|
+
object?: string | undefined;
|
1662
|
+
hoverTooltip?: boolean | undefined;
|
1663
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1664
|
+
}) | ({
|
1665
|
+
type: "script";
|
1666
|
+
value: string;
|
1667
|
+
} & {} & {
|
1668
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
1669
|
+
object?: string | undefined;
|
1670
|
+
hoverTooltip?: boolean | undefined;
|
1671
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1672
|
+
}) | ({
|
1673
|
+
type: "request";
|
1674
|
+
value: {
|
1675
|
+
method: "head" | "options" | "get" | "post" | "put" | "delete" | "patch";
|
1676
|
+
url: string;
|
1677
|
+
} & {
|
1678
|
+
headers?: {
|
1679
|
+
[key: string]: unknown;
|
1680
|
+
} | undefined;
|
1681
|
+
body?: {
|
1682
|
+
[key: string]: unknown;
|
1683
|
+
} | undefined;
|
1684
|
+
onSend?: string | undefined;
|
1685
|
+
onSuccess?: string | undefined;
|
1686
|
+
onError?: string | undefined;
|
1687
|
+
};
|
1688
|
+
} & {} & {
|
1689
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
1690
|
+
object?: string | undefined;
|
1691
|
+
hoverTooltip?: boolean | undefined;
|
1692
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1693
|
+
}) | ({
|
1694
|
+
type: "appcues";
|
1695
|
+
value: string;
|
1696
|
+
} & {} & {
|
1697
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
1698
|
+
object?: string | undefined;
|
1699
|
+
hoverTooltip?: boolean | undefined;
|
1700
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1701
|
+
}) | ({
|
1702
|
+
type: "video";
|
1703
|
+
value: string;
|
1704
|
+
} & {} & {
|
1705
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
1706
|
+
object?: string | undefined;
|
1707
|
+
hoverTooltip?: boolean | undefined;
|
1708
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1709
|
+
}) | ({
|
1710
|
+
type: "helpdoc";
|
1711
|
+
value: string;
|
1712
|
+
} & {
|
1713
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1714
|
+
doc_metadata?: {
|
1715
|
+
content_type?: string | undefined;
|
1716
|
+
date?: string | undefined;
|
1717
|
+
} | undefined;
|
1718
|
+
} & {
|
1719
|
+
doc_type?: "answer" | "doc" | undefined;
|
1720
|
+
} & {} & {
|
1721
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
1722
|
+
object?: string | undefined;
|
1723
|
+
hoverTooltip?: boolean | undefined;
|
1724
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1725
|
+
}) | ({
|
1726
|
+
type: "trigger";
|
1727
|
+
value: {
|
1728
|
+
type: "execute_command";
|
1729
|
+
meta: {
|
1730
|
+
command: string;
|
1731
|
+
};
|
1732
|
+
} | {
|
1733
|
+
type: "click";
|
1734
|
+
value: string;
|
1735
|
+
} | ({
|
1736
|
+
type: "link";
|
1737
|
+
value: string;
|
1738
|
+
} & {
|
1739
|
+
operation?: "self" | "router" | "blank" | undefined;
|
1740
|
+
}) | {
|
1741
|
+
type: "open_chat";
|
1742
|
+
meta: {
|
1743
|
+
type: string;
|
1744
|
+
};
|
1745
|
+
} | {
|
1746
|
+
type: "dismiss";
|
1747
|
+
} | {
|
1748
|
+
type: "snooze";
|
1749
|
+
} | {
|
1750
|
+
type: "questlist";
|
1751
|
+
value: number;
|
1752
|
+
} | {
|
1753
|
+
type: "step_back";
|
1754
|
+
} | {
|
1755
|
+
type: "nudge";
|
1756
|
+
value: number;
|
1757
|
+
} | {
|
1758
|
+
type: "go_to_step";
|
1759
|
+
value: number;
|
1760
|
+
} | ({
|
1761
|
+
type: "open_bar";
|
1762
|
+
} & {
|
1763
|
+
value?: string | undefined;
|
1764
|
+
categoryFilter?: number | undefined;
|
1765
|
+
}) | {
|
1766
|
+
type: "no_action";
|
1767
|
+
};
|
1768
|
+
} & {} & {
|
1769
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
1770
|
+
object?: string | undefined;
|
1771
|
+
hoverTooltip?: boolean | undefined;
|
1772
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1773
|
+
});
|
1774
|
+
} & {
|
1775
|
+
disabledReason?: string | undefined;
|
1776
|
+
source?: string | undefined;
|
1777
|
+
name?: string | undefined;
|
1778
|
+
last_available?: string | null | undefined;
|
1779
|
+
modified?: string | undefined;
|
1780
|
+
isAsync?: boolean | undefined;
|
1781
|
+
} & {
|
1782
|
+
arguments: {
|
1783
|
+
[x: string]: ({
|
1784
|
+
type: "context";
|
1785
|
+
value: string;
|
1786
|
+
order_key: number;
|
1787
|
+
} & {
|
1788
|
+
label?: string | undefined;
|
1789
|
+
chosen?: string | number | undefined;
|
1790
|
+
selected?: any[] | undefined;
|
1791
|
+
input_type?: string | undefined;
|
1792
|
+
preselected_key?: string | undefined;
|
1793
|
+
label_field?: string | undefined;
|
1794
|
+
loaded?: any[] | undefined;
|
1795
|
+
allow_create?: boolean | undefined;
|
1796
|
+
allow_create_label?: string | undefined;
|
1797
|
+
show_in_record_action_list?: boolean | undefined;
|
1798
|
+
show_in_default_list?: boolean | undefined;
|
1799
|
+
auto_choose?: boolean | undefined;
|
1800
|
+
is_private?: boolean | undefined;
|
1801
|
+
}) | ({
|
1802
|
+
type: "set";
|
1803
|
+
value: string[] | number[] | {
|
1804
|
+
[key: string]: unknown;
|
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
|
+
auto_choose?: boolean | undefined;
|
1818
|
+
is_private?: boolean | undefined;
|
1819
|
+
}) | ({
|
1820
|
+
type: "provided";
|
1821
|
+
value: "time" | "text";
|
1822
|
+
order_key: number;
|
1823
|
+
} & {
|
1824
|
+
label?: string | undefined;
|
1825
|
+
chosen?: string | number | undefined;
|
1826
|
+
selected?: any[] | undefined;
|
1827
|
+
input_type?: string | undefined;
|
1828
|
+
preselected_key?: string | undefined;
|
1829
|
+
label_field?: string | undefined;
|
1830
|
+
loaded?: any[] | undefined;
|
1831
|
+
dateTimeArgumentTypeId?: number | undefined;
|
1832
|
+
allow_create?: boolean | undefined;
|
1833
|
+
allow_create_label?: string | undefined;
|
1834
|
+
auto_choose?: boolean | undefined;
|
1835
|
+
is_private?: boolean | undefined;
|
1836
|
+
}) | ({
|
1837
|
+
type: "html" | "video";
|
1838
|
+
value: {
|
1839
|
+
source: string;
|
1840
|
+
} & {
|
1841
|
+
title?: string | undefined;
|
1842
|
+
description?: string | undefined;
|
1843
|
+
url?: string | undefined;
|
1844
|
+
};
|
1845
|
+
order_key: number;
|
1846
|
+
} & {
|
1847
|
+
label?: string | undefined;
|
1848
|
+
chosen?: string | number | undefined;
|
1849
|
+
selected?: any[] | undefined;
|
1850
|
+
input_type?: string | undefined;
|
1851
|
+
preselected_key?: string | undefined;
|
1852
|
+
label_field?: string | undefined;
|
1853
|
+
loaded?: any[] | undefined;
|
1854
|
+
allow_create?: boolean | undefined;
|
1855
|
+
allow_create_label?: string | undefined;
|
1856
|
+
is_private?: boolean | undefined;
|
1857
|
+
auto_choose?: boolean | undefined;
|
1858
|
+
});
|
1859
|
+
};
|
1860
|
+
tags: string[];
|
1861
|
+
availability_rules: (({
|
1862
|
+
type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "hubspot";
|
1863
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot";
|
1864
|
+
} & {
|
1865
|
+
field?: string | undefined;
|
1866
|
+
value?: string | undefined;
|
1867
|
+
reason?: string | undefined;
|
1868
|
+
rule_id?: string | number | undefined;
|
1869
|
+
}) | ({
|
1870
|
+
type: "nudge_interaction";
|
1871
|
+
operator: "is" | "isNot";
|
1872
|
+
value: "completed" | "dismissed" | "viewed";
|
1873
|
+
nudge_id: number;
|
1874
|
+
} & {
|
1875
|
+
reason?: string | undefined;
|
1876
|
+
}) | ({
|
1877
|
+
type: "questlist_interaction";
|
1878
|
+
operator: "is" | "isNot";
|
1879
|
+
value: "completed" | "dismissed" | "viewed";
|
1880
|
+
questlist_id: number;
|
1881
|
+
} & {
|
1882
|
+
reason?: string | undefined;
|
1883
|
+
}) | ({
|
1884
|
+
type: "browser" | "language" | "os";
|
1885
|
+
operator: "includes" | "doesNotInclude";
|
1886
|
+
values: string[];
|
1887
|
+
} & {
|
1888
|
+
reason?: string | undefined;
|
1889
|
+
}))[] | (({
|
1890
|
+
type: "named_rule";
|
1891
|
+
rule_id: string | number;
|
1892
|
+
} & {
|
1893
|
+
reason?: string | undefined;
|
1894
|
+
}) | ({
|
1895
|
+
type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "hubspot";
|
1896
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot";
|
1897
|
+
} & {
|
1898
|
+
field?: string | undefined;
|
1899
|
+
value?: string | undefined;
|
1900
|
+
reason?: string | undefined;
|
1901
|
+
rule_id?: string | number | undefined;
|
1902
|
+
}) | ({
|
1903
|
+
type: "nudge_interaction";
|
1904
|
+
operator: "is" | "isNot";
|
1905
|
+
value: "completed" | "dismissed" | "viewed";
|
1906
|
+
nudge_id: number;
|
1907
|
+
} & {
|
1908
|
+
reason?: string | undefined;
|
1909
|
+
}) | ({
|
1910
|
+
type: "questlist_interaction";
|
1911
|
+
operator: "is" | "isNot";
|
1912
|
+
value: "completed" | "dismissed" | "viewed";
|
1913
|
+
questlist_id: number;
|
1914
|
+
} & {
|
1915
|
+
reason?: string | undefined;
|
1916
|
+
}) | ({
|
1917
|
+
type: "browser" | "language" | "os";
|
1918
|
+
operator: "includes" | "doesNotInclude";
|
1919
|
+
values: string[];
|
1920
|
+
} & {
|
1921
|
+
reason?: string | undefined;
|
1922
|
+
}))[];
|
1923
|
+
recommend_rules: (({
|
1924
|
+
type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "hubspot";
|
1925
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot";
|
1926
|
+
} & {
|
1927
|
+
field?: string | undefined;
|
1928
|
+
value?: string | undefined;
|
1929
|
+
reason?: string | undefined;
|
1930
|
+
rule_id?: string | number | undefined;
|
1931
|
+
}) | ({
|
1932
|
+
type: "nudge_interaction";
|
1933
|
+
operator: "is" | "isNot";
|
1934
|
+
value: "completed" | "dismissed" | "viewed";
|
1935
|
+
nudge_id: number;
|
1936
|
+
} & {
|
1937
|
+
reason?: string | undefined;
|
1938
|
+
}) | ({
|
1939
|
+
type: "questlist_interaction";
|
1940
|
+
operator: "is" | "isNot";
|
1941
|
+
value: "completed" | "dismissed" | "viewed";
|
1942
|
+
questlist_id: number;
|
1943
|
+
} & {
|
1944
|
+
reason?: string | undefined;
|
1945
|
+
}) | ({
|
1946
|
+
type: "browser" | "language" | "os";
|
1947
|
+
operator: "includes" | "doesNotInclude";
|
1948
|
+
values: string[];
|
1949
|
+
} & {
|
1950
|
+
reason?: string | undefined;
|
1951
|
+
}) | ({
|
1952
|
+
type: "always";
|
1953
|
+
} & {
|
1954
|
+
operator?: null | undefined;
|
1955
|
+
field?: null | undefined;
|
1956
|
+
value?: null | undefined;
|
1957
|
+
reason?: null | undefined;
|
1958
|
+
rule_id?: string | number | undefined;
|
1959
|
+
}))[] | (({
|
1130
1960
|
type: "named_rule";
|
1131
1961
|
rule_id: string | number;
|
1132
1962
|
} & {
|
1133
1963
|
reason?: string | undefined;
|
1134
1964
|
}) | ({
|
1135
|
-
type: "url" | "element" | "context" | "
|
1136
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "
|
1965
|
+
type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "hubspot";
|
1966
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot";
|
1137
1967
|
} & {
|
1138
1968
|
field?: string | undefined;
|
1139
1969
|
value?: string | undefined;
|
1140
1970
|
reason?: string | undefined;
|
1141
1971
|
rule_id?: string | number | undefined;
|
1972
|
+
}) | ({
|
1973
|
+
type: "nudge_interaction";
|
1974
|
+
operator: "is" | "isNot";
|
1975
|
+
value: "completed" | "dismissed" | "viewed";
|
1976
|
+
nudge_id: number;
|
1977
|
+
} & {
|
1978
|
+
reason?: string | undefined;
|
1979
|
+
}) | ({
|
1980
|
+
type: "questlist_interaction";
|
1981
|
+
operator: "is" | "isNot";
|
1982
|
+
value: "completed" | "dismissed" | "viewed";
|
1983
|
+
questlist_id: number;
|
1984
|
+
} & {
|
1985
|
+
reason?: string | undefined;
|
1986
|
+
}) | ({
|
1987
|
+
type: "browser" | "language" | "os";
|
1988
|
+
operator: "includes" | "doesNotInclude";
|
1989
|
+
values: string[];
|
1990
|
+
} & {
|
1991
|
+
reason?: string | undefined;
|
1142
1992
|
}) | ({
|
1143
1993
|
type: "always";
|
1144
1994
|
} & {
|
@@ -1182,23 +2032,23 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
1182
2032
|
hotkey_mac: string;
|
1183
2033
|
hotkey_win: string;
|
1184
2034
|
detail: string | ({
|
1185
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
2035
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
1186
2036
|
value: string;
|
1187
2037
|
} & {
|
1188
2038
|
position?: "inline" | "popover" | undefined;
|
1189
2039
|
}) | (string | ({
|
1190
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
2040
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
1191
2041
|
value: string;
|
1192
2042
|
} & {
|
1193
2043
|
position?: "inline" | "popover" | undefined;
|
1194
2044
|
}))[] | null;
|
1195
2045
|
content: string | ({
|
1196
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
2046
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
1197
2047
|
value: string;
|
1198
2048
|
} & {
|
1199
2049
|
position?: "inline" | "popover" | undefined;
|
1200
2050
|
}) | (string | ({
|
1201
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
2051
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
1202
2052
|
value: string;
|
1203
2053
|
} & {
|
1204
2054
|
position?: "inline" | "popover" | undefined;
|
@@ -1216,8 +2066,6 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
1216
2066
|
meta: {
|
1217
2067
|
command: string;
|
1218
2068
|
};
|
1219
|
-
} | {
|
1220
|
-
type: "no_action";
|
1221
2069
|
} | {
|
1222
2070
|
type: "click";
|
1223
2071
|
value: string;
|
@@ -1233,6 +2081,26 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
1233
2081
|
};
|
1234
2082
|
} | {
|
1235
2083
|
type: "dismiss";
|
2084
|
+
} | {
|
2085
|
+
type: "snooze";
|
2086
|
+
} | {
|
2087
|
+
type: "questlist";
|
2088
|
+
value: number;
|
2089
|
+
} | {
|
2090
|
+
type: "step_back";
|
2091
|
+
} | {
|
2092
|
+
type: "nudge";
|
2093
|
+
value: number;
|
2094
|
+
} | {
|
2095
|
+
type: "go_to_step";
|
2096
|
+
value: number;
|
2097
|
+
} | ({
|
2098
|
+
type: "open_bar";
|
2099
|
+
} & {
|
2100
|
+
value?: string | undefined;
|
2101
|
+
categoryFilter?: number | undefined;
|
2102
|
+
}) | {
|
2103
|
+
type: "no_action";
|
1236
2104
|
};
|
1237
2105
|
})[];
|
1238
2106
|
generated_tags: {
|
@@ -1240,10 +2108,17 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
1240
2108
|
manual?: string[] | null | undefined;
|
1241
2109
|
deny?: string[] | null | undefined;
|
1242
2110
|
};
|
2111
|
+
copilot_suggest: boolean;
|
2112
|
+
copilot_cta_label: string;
|
2113
|
+
copilot_description: string;
|
1243
2114
|
} & {
|
1244
2115
|
third_party_source?: string | null | undefined;
|
1245
2116
|
third_party_id?: string | null | undefined;
|
1246
2117
|
training_only?: boolean | undefined;
|
2118
|
+
integration?: {
|
2119
|
+
id: number;
|
2120
|
+
helphub_view_article_button_hidden: boolean | undefined;
|
2121
|
+
} | null | undefined;
|
1247
2122
|
})[]>;
|
1248
2123
|
export declare const listCommandCategories: (orgUID: string) => Promise<({
|
1249
2124
|
id: number;
|
@@ -1296,16 +2171,6 @@ export declare const listRules: (orgUID: string) => Promise<({
|
|
1296
2171
|
} & {
|
1297
2172
|
is_audience: boolean;
|
1298
2173
|
})[]>;
|
1299
|
-
export declare const userHasAccess: (uuid: string, user: string) => Promise<{
|
1300
|
-
username: string;
|
1301
|
-
slug: string;
|
1302
|
-
organization: string;
|
1303
|
-
has_access: boolean;
|
1304
|
-
has_opened: boolean;
|
1305
|
-
hotkeys_debug: boolean;
|
1306
|
-
hmac: string | undefined;
|
1307
|
-
identifier: string;
|
1308
|
-
}>;
|
1309
2174
|
export declare const readHealth: (arg0: string, urlArgs?: {
|
1310
2175
|
[arg: string]: string;
|
1311
2176
|
} | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
@@ -1322,9 +2187,7 @@ export declare const readInternal: (arg0: string, urlArgs?: {
|
|
1322
2187
|
id: string;
|
1323
2188
|
integrations: {
|
1324
2189
|
[x: string]: {
|
1325
|
-
[x: string]:
|
1326
|
-
[x: string]: string;
|
1327
|
-
};
|
2190
|
+
[x: string]: any;
|
1328
2191
|
};
|
1329
2192
|
};
|
1330
2193
|
}>;
|
@@ -1332,9 +2195,7 @@ export declare const updateInternal: (object: {
|
|
1332
2195
|
id: string;
|
1333
2196
|
integrations: {
|
1334
2197
|
[x: string]: {
|
1335
|
-
[x: string]:
|
1336
|
-
[x: string]: string;
|
1337
|
-
};
|
2198
|
+
[x: string]: any;
|
1338
2199
|
};
|
1339
2200
|
};
|
1340
2201
|
}, urlArgs?: {
|
@@ -1343,9 +2204,7 @@ export declare const updateInternal: (object: {
|
|
1343
2204
|
id: string;
|
1344
2205
|
integrations: {
|
1345
2206
|
[x: string]: {
|
1346
|
-
[x: string]:
|
1347
|
-
[x: string]: string;
|
1348
|
-
};
|
2207
|
+
[x: string]: any;
|
1349
2208
|
};
|
1350
2209
|
};
|
1351
2210
|
}>;
|
@@ -1372,16 +2231,11 @@ export declare const decode: (data: any) => {
|
|
1372
2231
|
created: string;
|
1373
2232
|
} & {} & {
|
1374
2233
|
launcher_type: "alternate" | "none" | "prompt" | "minimal";
|
1375
|
-
launcher_position: "
|
2234
|
+
launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
1376
2235
|
show_launcher_recommendations: boolean;
|
1377
2236
|
recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
|
1378
2237
|
launcher_offset_x: number;
|
1379
2238
|
launcher_offset_y: number;
|
1380
|
-
helphub_launcher_offset_x: number;
|
1381
|
-
helphub_launcher_offset_y: number;
|
1382
|
-
helphub_launcher_anchor: string;
|
1383
|
-
helphub_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
1384
|
-
helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle";
|
1385
2239
|
base_url: string;
|
1386
2240
|
theme: object;
|
1387
2241
|
icon: string;
|
@@ -1426,23 +2280,23 @@ export declare const decode: (data: any) => {
|
|
1426
2280
|
setting_pin_to_bottom?: boolean | undefined;
|
1427
2281
|
track_recents?: boolean | undefined;
|
1428
2282
|
detail?: string | ({
|
1429
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
2283
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
1430
2284
|
value: string;
|
1431
2285
|
} & {
|
1432
2286
|
position?: "inline" | "popover" | undefined;
|
1433
2287
|
}) | (string | ({
|
1434
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
2288
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
1435
2289
|
value: string;
|
1436
2290
|
} & {
|
1437
2291
|
position?: "inline" | "popover" | undefined;
|
1438
2292
|
}))[] | null | undefined;
|
1439
2293
|
content?: string | ({
|
1440
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
2294
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
1441
2295
|
value: string;
|
1442
2296
|
} & {
|
1443
2297
|
position?: "inline" | "popover" | undefined;
|
1444
2298
|
}) | (string | ({
|
1445
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
2299
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
1446
2300
|
value: string;
|
1447
2301
|
} & {
|
1448
2302
|
position?: "inline" | "popover" | undefined;
|
@@ -1483,10 +2337,8 @@ export declare const decode: (data: any) => {
|
|
1483
2337
|
bar_enabled: boolean;
|
1484
2338
|
in_bar_doc_search: boolean;
|
1485
2339
|
featured_item_cards: boolean;
|
1486
|
-
helphub_ai_enabled: boolean;
|
1487
2340
|
helphub_suggested_queries_enabled: boolean;
|
1488
2341
|
helphub_continuations_enabled: boolean;
|
1489
|
-
helphub_chat_only_mode: boolean;
|
1490
2342
|
helphub_enabled: boolean;
|
1491
2343
|
helphub_chat_fallback_message: string | null;
|
1492
2344
|
helphub_chat_fallback_actions: {
|
@@ -1496,8 +2348,6 @@ export declare const decode: (data: any) => {
|
|
1496
2348
|
meta: {
|
1497
2349
|
command: string;
|
1498
2350
|
};
|
1499
|
-
} | {
|
1500
|
-
type: "no_action";
|
1501
2351
|
} | {
|
1502
2352
|
type: "click";
|
1503
2353
|
value: string;
|
@@ -1513,12 +2363,33 @@ export declare const decode: (data: any) => {
|
|
1513
2363
|
};
|
1514
2364
|
} | {
|
1515
2365
|
type: "dismiss";
|
2366
|
+
} | {
|
2367
|
+
type: "snooze";
|
2368
|
+
} | {
|
2369
|
+
type: "questlist";
|
2370
|
+
value: number;
|
2371
|
+
} | {
|
2372
|
+
type: "step_back";
|
2373
|
+
} | {
|
2374
|
+
type: "nudge";
|
2375
|
+
value: number;
|
2376
|
+
} | {
|
2377
|
+
type: "go_to_step";
|
2378
|
+
value: number;
|
2379
|
+
} | ({
|
2380
|
+
type: "open_bar";
|
2381
|
+
} & {
|
2382
|
+
value?: string | undefined;
|
2383
|
+
categoryFilter?: number | undefined;
|
2384
|
+
}) | {
|
2385
|
+
type: "no_action";
|
1516
2386
|
};
|
1517
2387
|
}[];
|
1518
2388
|
helphub_manual_suggested_queries: string[];
|
1519
2389
|
nudge_rate_limit: number | null;
|
1520
2390
|
bar_hide_completed_nudges_questlists: boolean;
|
1521
2391
|
nudge_rate_period: "day" | "week" | "session";
|
2392
|
+
share_link_param: string;
|
1522
2393
|
installed_at: string | null;
|
1523
2394
|
integrations: {
|
1524
2395
|
algolia?: {
|
@@ -1536,5 +2407,44 @@ export declare const decode: (data: any) => {
|
|
1536
2407
|
};
|
1537
2408
|
send_events_to_heap: boolean;
|
1538
2409
|
} | undefined;
|
2410
|
+
amplitude?: {
|
2411
|
+
enabled: boolean;
|
2412
|
+
} | undefined;
|
2413
|
+
logrocket?: {
|
2414
|
+
enabled: boolean;
|
2415
|
+
} | undefined;
|
2416
|
+
mixpanel?: {
|
2417
|
+
enabled: boolean;
|
2418
|
+
} | undefined;
|
2419
|
+
posthog?: {
|
2420
|
+
enabled: boolean;
|
2421
|
+
} | undefined;
|
2422
|
+
slack?: {
|
2423
|
+
channelId: string;
|
2424
|
+
configuration: {
|
2425
|
+
analytic_events: string[];
|
2426
|
+
};
|
2427
|
+
} | undefined;
|
2428
|
+
hubspot?: {
|
2429
|
+
send_events_to_hubspot?: boolean | undefined;
|
2430
|
+
lists?: {
|
2431
|
+
[x: string]: string;
|
2432
|
+
} | undefined;
|
2433
|
+
} | undefined;
|
1539
2434
|
};
|
2435
|
+
copilot_enabled: boolean;
|
2436
|
+
helphub_ai_enabled: boolean;
|
2437
|
+
copilot_experiences_enabled: boolean;
|
2438
|
+
helphub_chat_only_mode: boolean;
|
2439
|
+
} & {
|
2440
|
+
helphub_launcher_offset_x: number;
|
2441
|
+
helphub_launcher_offset_y: number;
|
2442
|
+
helphub_launcher_anchor: string;
|
2443
|
+
helphub_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
2444
|
+
helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
|
2445
|
+
helphub_mobile_launcher_offset_x: number;
|
2446
|
+
helphub_mobile_launcher_offset_y: number;
|
2447
|
+
helphub_mobile_launcher_anchor: string;
|
2448
|
+
helphub_mobile_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
2449
|
+
helphub_mobile_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
|
1540
2450
|
};
|