commandbar 1.12.0 → 1.13.1
Sign up to get free protection for your applications and to get access to all the features.
- package/build/commandbar/src/shared/services/analytics/EventHandler.d.ts +2 -0
- package/build/commandbar-js/src/index.js +1 -1
- package/build/commandbar-js/src/init.d.ts +10 -1
- package/build/commandbar-js/src/snippet.d.ts +0 -1
- package/build/internal/src/client/CommandBarClientSDK.d.ts +5 -0
- package/build/internal/src/client/CommandBarProxySDK.d.ts +2 -3
- package/build/internal/src/client/SDKConfig.d.ts +1 -0
- package/build/internal/src/client/symbols.d.ts +2 -0
- package/build/internal/src/middleware/CommandFromClientV.d.ts +7 -0
- package/build/internal/src/middleware/OrganizationV.d.ts +104 -12
- package/build/internal/src/middleware/additionalResource.d.ts +208 -118
- package/build/internal/src/middleware/api.d.ts +7 -7
- package/build/internal/src/middleware/chat.d.ts +23641 -12011
- package/build/internal/src/middleware/checklist.d.ts +221 -121
- package/build/internal/src/middleware/command.d.ts +2611 -2021
- package/build/internal/src/middleware/endUser.d.ts +0 -32
- package/build/internal/src/middleware/experienceTemplate.d.ts +407 -223
- package/build/internal/src/middleware/experiencesSearch.d.ts +818 -657
- package/build/internal/src/middleware/flags.d.ts +9 -8
- package/build/internal/src/middleware/helpDocsSearch.d.ts +586 -471
- package/build/internal/src/middleware/helpers/actions.d.ts +83 -30
- package/build/internal/src/middleware/helpers/commandTemplate.d.ts +32 -6
- package/build/internal/src/middleware/helpers/rules.d.ts +19 -4
- package/build/internal/src/middleware/keyword.d.ts +82 -0
- package/build/internal/src/middleware/network.d.ts +2 -2
- package/build/internal/src/middleware/nudge.d.ts +520 -247
- package/build/internal/src/middleware/organization.d.ts +886 -607
- package/build/internal/src/middleware/organizationSettings.d.ts +282 -114
- package/build/internal/src/middleware/profile.d.ts +1 -1
- package/build/internal/src/middleware/recommendationSet.d.ts +208 -118
- package/build/internal/src/middleware/theme.d.ts +7 -0
- package/build/internal/src/middleware/types.d.ts +21 -20
- package/package.json +1 -1
- package/src/init.ts +13 -2
- package/src/snippet.ts +1 -14
- package/build/commandbar/src/shared/services/analytics/event-queue.d.ts +0 -13
- package/build/commandbar/src/shared/services/analytics/v2/client.d.ts +0 -54
- package/build/commandbar/src/shared/services/analytics/v2/helpers.d.ts +0 -6
- package/build/commandbar/src/shared/services/analytics/v2/schema.d.ts +0 -152
- package/build/commandbar/src/shared/services/analytics/v2/types.d.ts +0 -4
- package/build/internal/src/client/CommandBarSDK.d.ts +0 -99
- package/build/internal/src/client/globals.d.ts +0 -27
- package/build/internal/src/util/dispatchCustomEvent.d.ts +0 -14
- package/build/internal/src/util/sentry.d.ts +0 -23
@@ -24,7 +24,7 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
24
24
|
} & {} & {
|
25
25
|
disabled: boolean;
|
26
26
|
launcher_type: "alternate" | "none" | "prompt" | "minimal";
|
27
|
-
launcher_position: "
|
27
|
+
launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
28
28
|
show_launcher_recommendations: boolean;
|
29
29
|
recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
|
30
30
|
launcher_offset_x: number;
|
@@ -104,23 +104,23 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
104
104
|
setting_pin_to_bottom?: boolean | undefined;
|
105
105
|
track_recents?: boolean | undefined;
|
106
106
|
detail?: string | ({
|
107
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
107
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
108
108
|
value: string;
|
109
109
|
} & {
|
110
110
|
position?: "inline" | "popover" | undefined;
|
111
111
|
}) | (string | ({
|
112
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
112
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
113
113
|
value: string;
|
114
114
|
} & {
|
115
115
|
position?: "inline" | "popover" | undefined;
|
116
116
|
}))[] | null | undefined;
|
117
117
|
content?: string | ({
|
118
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
118
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
119
119
|
value: string;
|
120
120
|
} & {
|
121
121
|
position?: "inline" | "popover" | undefined;
|
122
122
|
}) | (string | ({
|
123
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
123
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
124
124
|
value: string;
|
125
125
|
} & {
|
126
126
|
position?: "inline" | "popover" | undefined;
|
@@ -168,28 +168,38 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
168
168
|
helphub_chat_fallback_message: string | null;
|
169
169
|
helphub_chat_fallback_actions: {
|
170
170
|
cta: string;
|
171
|
-
action: {
|
171
|
+
action: ({
|
172
|
+
type: "link";
|
173
|
+
value: string;
|
174
|
+
} & {
|
175
|
+
operation?: "self" | "router" | "blank" | undefined;
|
176
|
+
meta?: {
|
177
|
+
command: string;
|
178
|
+
} | undefined;
|
179
|
+
}) | {
|
180
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
181
|
+
value: string[];
|
182
|
+
} | {
|
172
183
|
type: "execute_command";
|
173
184
|
meta: {
|
174
185
|
command: string;
|
175
186
|
} & {
|
176
187
|
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
177
188
|
};
|
189
|
+
} | {
|
190
|
+
type: "no_action";
|
178
191
|
} | {
|
179
192
|
type: "click";
|
180
193
|
value: string;
|
181
194
|
} | {
|
182
|
-
type: "click" | "clickBySelector" | "clickByXpath";
|
183
|
-
value: string[];
|
184
|
-
} | ({
|
185
|
-
type: "link";
|
186
|
-
value: string;
|
187
|
-
} & {
|
188
|
-
operation?: "self" | "router" | "blank" | undefined;
|
189
|
-
}) | {
|
190
195
|
type: "open_chat";
|
191
196
|
meta: {
|
192
|
-
type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "
|
197
|
+
type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
|
198
|
+
};
|
199
|
+
} | {
|
200
|
+
type: "chat_handoff";
|
201
|
+
meta: {
|
202
|
+
type: "" | "intercom" | "freshchat" | "zendesk";
|
193
203
|
};
|
194
204
|
} | {
|
195
205
|
type: "dismiss";
|
@@ -198,14 +208,14 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
198
208
|
} | {
|
199
209
|
type: "questlist";
|
200
210
|
value: number;
|
201
|
-
} | {
|
202
|
-
type: "step_back";
|
203
211
|
} | {
|
204
212
|
type: "nudge";
|
205
213
|
value: number;
|
206
214
|
} | {
|
207
215
|
type: "go_to_step";
|
208
216
|
value: number;
|
217
|
+
} | {
|
218
|
+
type: "step_back";
|
209
219
|
} | ({
|
210
220
|
type: "open_bar";
|
211
221
|
} & {
|
@@ -213,39 +223,51 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
213
223
|
categoryFilter?: number | undefined;
|
214
224
|
}) | {
|
215
225
|
type: "open_helphub";
|
216
|
-
} | {
|
226
|
+
} | ({
|
217
227
|
type: "open_copilot";
|
218
|
-
}
|
219
|
-
|
220
|
-
};
|
228
|
+
} & {
|
229
|
+
query?: string | undefined;
|
230
|
+
});
|
221
231
|
}[];
|
222
232
|
helphub_search_action: "search" | "ask";
|
233
|
+
helphub_custom_theme: string | null;
|
234
|
+
copilot_chat_history_enabled: boolean;
|
223
235
|
copilot_negative_feedback_fallback_enabled: boolean;
|
224
236
|
copilot_negative_feedback_fallback_message: string | null;
|
225
237
|
copilot_negative_feedback_fallback_actions: {
|
226
238
|
cta: string;
|
227
|
-
action: {
|
239
|
+
action: ({
|
240
|
+
type: "link";
|
241
|
+
value: string;
|
242
|
+
} & {
|
243
|
+
operation?: "self" | "router" | "blank" | undefined;
|
244
|
+
meta?: {
|
245
|
+
command: string;
|
246
|
+
} | undefined;
|
247
|
+
}) | {
|
248
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
249
|
+
value: string[];
|
250
|
+
} | {
|
228
251
|
type: "execute_command";
|
229
252
|
meta: {
|
230
253
|
command: string;
|
231
254
|
} & {
|
232
255
|
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
233
256
|
};
|
257
|
+
} | {
|
258
|
+
type: "no_action";
|
234
259
|
} | {
|
235
260
|
type: "click";
|
236
261
|
value: string;
|
237
262
|
} | {
|
238
|
-
type: "click" | "clickBySelector" | "clickByXpath";
|
239
|
-
value: string[];
|
240
|
-
} | ({
|
241
|
-
type: "link";
|
242
|
-
value: string;
|
243
|
-
} & {
|
244
|
-
operation?: "self" | "router" | "blank" | undefined;
|
245
|
-
}) | {
|
246
263
|
type: "open_chat";
|
247
264
|
meta: {
|
248
|
-
type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "
|
265
|
+
type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
|
266
|
+
};
|
267
|
+
} | {
|
268
|
+
type: "chat_handoff";
|
269
|
+
meta: {
|
270
|
+
type: "" | "intercom" | "freshchat" | "zendesk";
|
249
271
|
};
|
250
272
|
} | {
|
251
273
|
type: "dismiss";
|
@@ -254,14 +276,14 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
254
276
|
} | {
|
255
277
|
type: "questlist";
|
256
278
|
value: number;
|
257
|
-
} | {
|
258
|
-
type: "step_back";
|
259
279
|
} | {
|
260
280
|
type: "nudge";
|
261
281
|
value: number;
|
262
282
|
} | {
|
263
283
|
type: "go_to_step";
|
264
284
|
value: number;
|
285
|
+
} | {
|
286
|
+
type: "step_back";
|
265
287
|
} | ({
|
266
288
|
type: "open_bar";
|
267
289
|
} & {
|
@@ -269,15 +291,20 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
269
291
|
categoryFilter?: number | undefined;
|
270
292
|
}) | {
|
271
293
|
type: "open_helphub";
|
272
|
-
} | {
|
294
|
+
} | ({
|
273
295
|
type: "open_copilot";
|
274
|
-
}
|
275
|
-
|
276
|
-
};
|
296
|
+
} & {
|
297
|
+
query?: string | undefined;
|
298
|
+
});
|
277
299
|
}[];
|
278
300
|
helphub_manual_suggested_queries: string[];
|
279
301
|
copilot_name: string;
|
280
302
|
copilot_avatar: string;
|
303
|
+
copilot_avatar_v2: {
|
304
|
+
src: string;
|
305
|
+
file_name: string;
|
306
|
+
size: string;
|
307
|
+
} | null;
|
281
308
|
copilot_personality: {
|
282
309
|
template: "professional" | "friendly" | "confident" | "serious" | "empathetic";
|
283
310
|
} | {
|
@@ -352,12 +379,31 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
352
379
|
topic_name?: string | null | undefined;
|
353
380
|
conversation_property_name?: string | null | undefined;
|
354
381
|
} | undefined;
|
382
|
+
intercom?: {
|
383
|
+
enabled?: boolean | undefined;
|
384
|
+
token?: string | undefined;
|
385
|
+
} | undefined;
|
355
386
|
};
|
356
387
|
copilot_enabled: boolean;
|
357
388
|
user_property_targeting: boolean;
|
358
389
|
ab_test_conditions: boolean;
|
359
390
|
spotlight_ask_copilot_enabled: boolean;
|
360
391
|
spotlight_ask_copilot_label: string | null;
|
392
|
+
spotlight_custom_theme: string | null;
|
393
|
+
spotlight_ask_copilot_audience: {
|
394
|
+
type: "all_users";
|
395
|
+
} | {
|
396
|
+
type: "rule_expression";
|
397
|
+
expression: import("./helpers/rules").RuleExpression;
|
398
|
+
} | {
|
399
|
+
type: "named_rule_reference";
|
400
|
+
rule_reference: {
|
401
|
+
type: "named_rule";
|
402
|
+
rule_id: string | number;
|
403
|
+
} & {
|
404
|
+
reason?: string | undefined;
|
405
|
+
};
|
406
|
+
} | null;
|
361
407
|
helphub_ai_enabled: boolean;
|
362
408
|
copilot_experiences_enabled: boolean;
|
363
409
|
helphub_chat_only_mode: boolean;
|
@@ -365,13 +411,13 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
365
411
|
helphub_launcher_offset_x: number;
|
366
412
|
helphub_launcher_offset_y: number;
|
367
413
|
helphub_launcher_anchor: string;
|
368
|
-
helphub_launcher_position: "
|
369
|
-
helphub_launcher_type: "none" | "custom" | "
|
414
|
+
helphub_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
415
|
+
helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
|
370
416
|
helphub_mobile_launcher_offset_x: number;
|
371
417
|
helphub_mobile_launcher_offset_y: number;
|
372
418
|
helphub_mobile_launcher_anchor: string;
|
373
|
-
helphub_mobile_launcher_position: "
|
374
|
-
helphub_mobile_launcher_type: "none" | "custom" | "
|
419
|
+
helphub_mobile_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
420
|
+
helphub_mobile_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
|
375
421
|
}>;
|
376
422
|
export declare const update: (object: {
|
377
423
|
id: string | number;
|
@@ -380,7 +426,7 @@ export declare const update: (object: {
|
|
380
426
|
} & {} & {
|
381
427
|
disabled: boolean;
|
382
428
|
launcher_type: "alternate" | "none" | "prompt" | "minimal";
|
383
|
-
launcher_position: "
|
429
|
+
launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
384
430
|
show_launcher_recommendations: boolean;
|
385
431
|
recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
|
386
432
|
launcher_offset_x: number;
|
@@ -460,23 +506,23 @@ export declare const update: (object: {
|
|
460
506
|
setting_pin_to_bottom?: boolean | undefined;
|
461
507
|
track_recents?: boolean | undefined;
|
462
508
|
detail?: string | ({
|
463
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
509
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
464
510
|
value: string;
|
465
511
|
} & {
|
466
512
|
position?: "inline" | "popover" | undefined;
|
467
513
|
}) | (string | ({
|
468
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
514
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
469
515
|
value: string;
|
470
516
|
} & {
|
471
517
|
position?: "inline" | "popover" | undefined;
|
472
518
|
}))[] | null | undefined;
|
473
519
|
content?: string | ({
|
474
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
520
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
475
521
|
value: string;
|
476
522
|
} & {
|
477
523
|
position?: "inline" | "popover" | undefined;
|
478
524
|
}) | (string | ({
|
479
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
525
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
480
526
|
value: string;
|
481
527
|
} & {
|
482
528
|
position?: "inline" | "popover" | undefined;
|
@@ -524,28 +570,38 @@ export declare const update: (object: {
|
|
524
570
|
helphub_chat_fallback_message: string | null;
|
525
571
|
helphub_chat_fallback_actions: {
|
526
572
|
cta: string;
|
527
|
-
action: {
|
573
|
+
action: ({
|
574
|
+
type: "link";
|
575
|
+
value: string;
|
576
|
+
} & {
|
577
|
+
operation?: "self" | "router" | "blank" | undefined;
|
578
|
+
meta?: {
|
579
|
+
command: string;
|
580
|
+
} | undefined;
|
581
|
+
}) | {
|
582
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
583
|
+
value: string[];
|
584
|
+
} | {
|
528
585
|
type: "execute_command";
|
529
586
|
meta: {
|
530
587
|
command: string;
|
531
588
|
} & {
|
532
589
|
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
533
590
|
};
|
591
|
+
} | {
|
592
|
+
type: "no_action";
|
534
593
|
} | {
|
535
594
|
type: "click";
|
536
595
|
value: string;
|
537
596
|
} | {
|
538
|
-
type: "click" | "clickBySelector" | "clickByXpath";
|
539
|
-
value: string[];
|
540
|
-
} | ({
|
541
|
-
type: "link";
|
542
|
-
value: string;
|
543
|
-
} & {
|
544
|
-
operation?: "self" | "router" | "blank" | undefined;
|
545
|
-
}) | {
|
546
597
|
type: "open_chat";
|
547
598
|
meta: {
|
548
|
-
type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "
|
599
|
+
type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
|
600
|
+
};
|
601
|
+
} | {
|
602
|
+
type: "chat_handoff";
|
603
|
+
meta: {
|
604
|
+
type: "" | "intercom" | "freshchat" | "zendesk";
|
549
605
|
};
|
550
606
|
} | {
|
551
607
|
type: "dismiss";
|
@@ -554,14 +610,14 @@ export declare const update: (object: {
|
|
554
610
|
} | {
|
555
611
|
type: "questlist";
|
556
612
|
value: number;
|
557
|
-
} | {
|
558
|
-
type: "step_back";
|
559
613
|
} | {
|
560
614
|
type: "nudge";
|
561
615
|
value: number;
|
562
616
|
} | {
|
563
617
|
type: "go_to_step";
|
564
618
|
value: number;
|
619
|
+
} | {
|
620
|
+
type: "step_back";
|
565
621
|
} | ({
|
566
622
|
type: "open_bar";
|
567
623
|
} & {
|
@@ -569,39 +625,51 @@ export declare const update: (object: {
|
|
569
625
|
categoryFilter?: number | undefined;
|
570
626
|
}) | {
|
571
627
|
type: "open_helphub";
|
572
|
-
} | {
|
628
|
+
} | ({
|
573
629
|
type: "open_copilot";
|
574
|
-
}
|
575
|
-
|
576
|
-
};
|
630
|
+
} & {
|
631
|
+
query?: string | undefined;
|
632
|
+
});
|
577
633
|
}[];
|
578
634
|
helphub_search_action: "search" | "ask";
|
635
|
+
helphub_custom_theme: string | null;
|
636
|
+
copilot_chat_history_enabled: boolean;
|
579
637
|
copilot_negative_feedback_fallback_enabled: boolean;
|
580
638
|
copilot_negative_feedback_fallback_message: string | null;
|
581
639
|
copilot_negative_feedback_fallback_actions: {
|
582
640
|
cta: string;
|
583
|
-
action: {
|
641
|
+
action: ({
|
642
|
+
type: "link";
|
643
|
+
value: string;
|
644
|
+
} & {
|
645
|
+
operation?: "self" | "router" | "blank" | undefined;
|
646
|
+
meta?: {
|
647
|
+
command: string;
|
648
|
+
} | undefined;
|
649
|
+
}) | {
|
650
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
651
|
+
value: string[];
|
652
|
+
} | {
|
584
653
|
type: "execute_command";
|
585
654
|
meta: {
|
586
655
|
command: string;
|
587
656
|
} & {
|
588
657
|
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
589
658
|
};
|
659
|
+
} | {
|
660
|
+
type: "no_action";
|
590
661
|
} | {
|
591
662
|
type: "click";
|
592
663
|
value: string;
|
593
664
|
} | {
|
594
|
-
type: "click" | "clickBySelector" | "clickByXpath";
|
595
|
-
value: string[];
|
596
|
-
} | ({
|
597
|
-
type: "link";
|
598
|
-
value: string;
|
599
|
-
} & {
|
600
|
-
operation?: "self" | "router" | "blank" | undefined;
|
601
|
-
}) | {
|
602
665
|
type: "open_chat";
|
603
666
|
meta: {
|
604
|
-
type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "
|
667
|
+
type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
|
668
|
+
};
|
669
|
+
} | {
|
670
|
+
type: "chat_handoff";
|
671
|
+
meta: {
|
672
|
+
type: "" | "intercom" | "freshchat" | "zendesk";
|
605
673
|
};
|
606
674
|
} | {
|
607
675
|
type: "dismiss";
|
@@ -610,14 +678,14 @@ export declare const update: (object: {
|
|
610
678
|
} | {
|
611
679
|
type: "questlist";
|
612
680
|
value: number;
|
613
|
-
} | {
|
614
|
-
type: "step_back";
|
615
681
|
} | {
|
616
682
|
type: "nudge";
|
617
683
|
value: number;
|
618
684
|
} | {
|
619
685
|
type: "go_to_step";
|
620
686
|
value: number;
|
687
|
+
} | {
|
688
|
+
type: "step_back";
|
621
689
|
} | ({
|
622
690
|
type: "open_bar";
|
623
691
|
} & {
|
@@ -625,15 +693,20 @@ export declare const update: (object: {
|
|
625
693
|
categoryFilter?: number | undefined;
|
626
694
|
}) | {
|
627
695
|
type: "open_helphub";
|
628
|
-
} | {
|
696
|
+
} | ({
|
629
697
|
type: "open_copilot";
|
630
|
-
}
|
631
|
-
|
632
|
-
};
|
698
|
+
} & {
|
699
|
+
query?: string | undefined;
|
700
|
+
});
|
633
701
|
}[];
|
634
702
|
helphub_manual_suggested_queries: string[];
|
635
703
|
copilot_name: string;
|
636
704
|
copilot_avatar: string;
|
705
|
+
copilot_avatar_v2: {
|
706
|
+
src: string;
|
707
|
+
file_name: string;
|
708
|
+
size: string;
|
709
|
+
} | null;
|
637
710
|
copilot_personality: {
|
638
711
|
template: "professional" | "friendly" | "confident" | "serious" | "empathetic";
|
639
712
|
} | {
|
@@ -708,12 +781,31 @@ export declare const update: (object: {
|
|
708
781
|
topic_name?: string | null | undefined;
|
709
782
|
conversation_property_name?: string | null | undefined;
|
710
783
|
} | undefined;
|
784
|
+
intercom?: {
|
785
|
+
enabled?: boolean | undefined;
|
786
|
+
token?: string | undefined;
|
787
|
+
} | undefined;
|
711
788
|
};
|
712
789
|
copilot_enabled: boolean;
|
713
790
|
user_property_targeting: boolean;
|
714
791
|
ab_test_conditions: boolean;
|
715
792
|
spotlight_ask_copilot_enabled: boolean;
|
716
793
|
spotlight_ask_copilot_label: string | null;
|
794
|
+
spotlight_custom_theme: string | null;
|
795
|
+
spotlight_ask_copilot_audience: {
|
796
|
+
type: "all_users";
|
797
|
+
} | {
|
798
|
+
type: "rule_expression";
|
799
|
+
expression: import("./helpers/rules").RuleExpression;
|
800
|
+
} | {
|
801
|
+
type: "named_rule_reference";
|
802
|
+
rule_reference: {
|
803
|
+
type: "named_rule";
|
804
|
+
rule_id: string | number;
|
805
|
+
} & {
|
806
|
+
reason?: string | undefined;
|
807
|
+
};
|
808
|
+
} | null;
|
717
809
|
helphub_ai_enabled: boolean;
|
718
810
|
copilot_experiences_enabled: boolean;
|
719
811
|
helphub_chat_only_mode: boolean;
|
@@ -721,13 +813,13 @@ export declare const update: (object: {
|
|
721
813
|
helphub_launcher_offset_x: number;
|
722
814
|
helphub_launcher_offset_y: number;
|
723
815
|
helphub_launcher_anchor: string;
|
724
|
-
helphub_launcher_position: "
|
725
|
-
helphub_launcher_type: "none" | "custom" | "
|
816
|
+
helphub_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
817
|
+
helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
|
726
818
|
helphub_mobile_launcher_offset_x: number;
|
727
819
|
helphub_mobile_launcher_offset_y: number;
|
728
820
|
helphub_mobile_launcher_anchor: string;
|
729
|
-
helphub_mobile_launcher_position: "
|
730
|
-
helphub_mobile_launcher_type: "none" | "custom" | "
|
821
|
+
helphub_mobile_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
822
|
+
helphub_mobile_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
|
731
823
|
}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
732
824
|
id: string | number;
|
733
825
|
name: string;
|
@@ -735,7 +827,7 @@ export declare const update: (object: {
|
|
735
827
|
} & {} & {
|
736
828
|
disabled: boolean;
|
737
829
|
launcher_type: "alternate" | "none" | "prompt" | "minimal";
|
738
|
-
launcher_position: "
|
830
|
+
launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
739
831
|
show_launcher_recommendations: boolean;
|
740
832
|
recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
|
741
833
|
launcher_offset_x: number;
|
@@ -815,23 +907,23 @@ export declare const update: (object: {
|
|
815
907
|
setting_pin_to_bottom?: boolean | undefined;
|
816
908
|
track_recents?: boolean | undefined;
|
817
909
|
detail?: string | ({
|
818
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
910
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
819
911
|
value: string;
|
820
912
|
} & {
|
821
913
|
position?: "inline" | "popover" | undefined;
|
822
914
|
}) | (string | ({
|
823
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
915
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
824
916
|
value: string;
|
825
917
|
} & {
|
826
918
|
position?: "inline" | "popover" | undefined;
|
827
919
|
}))[] | null | undefined;
|
828
920
|
content?: string | ({
|
829
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
921
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
830
922
|
value: string;
|
831
923
|
} & {
|
832
924
|
position?: "inline" | "popover" | undefined;
|
833
925
|
}) | (string | ({
|
834
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
926
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
835
927
|
value: string;
|
836
928
|
} & {
|
837
929
|
position?: "inline" | "popover" | undefined;
|
@@ -879,28 +971,38 @@ export declare const update: (object: {
|
|
879
971
|
helphub_chat_fallback_message: string | null;
|
880
972
|
helphub_chat_fallback_actions: {
|
881
973
|
cta: string;
|
882
|
-
action: {
|
974
|
+
action: ({
|
975
|
+
type: "link";
|
976
|
+
value: string;
|
977
|
+
} & {
|
978
|
+
operation?: "self" | "router" | "blank" | undefined;
|
979
|
+
meta?: {
|
980
|
+
command: string;
|
981
|
+
} | undefined;
|
982
|
+
}) | {
|
983
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
984
|
+
value: string[];
|
985
|
+
} | {
|
883
986
|
type: "execute_command";
|
884
987
|
meta: {
|
885
988
|
command: string;
|
886
989
|
} & {
|
887
990
|
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
888
991
|
};
|
992
|
+
} | {
|
993
|
+
type: "no_action";
|
889
994
|
} | {
|
890
995
|
type: "click";
|
891
996
|
value: string;
|
892
997
|
} | {
|
893
|
-
type: "click" | "clickBySelector" | "clickByXpath";
|
894
|
-
value: string[];
|
895
|
-
} | ({
|
896
|
-
type: "link";
|
897
|
-
value: string;
|
898
|
-
} & {
|
899
|
-
operation?: "self" | "router" | "blank" | undefined;
|
900
|
-
}) | {
|
901
998
|
type: "open_chat";
|
902
999
|
meta: {
|
903
|
-
type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "
|
1000
|
+
type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
|
1001
|
+
};
|
1002
|
+
} | {
|
1003
|
+
type: "chat_handoff";
|
1004
|
+
meta: {
|
1005
|
+
type: "" | "intercom" | "freshchat" | "zendesk";
|
904
1006
|
};
|
905
1007
|
} | {
|
906
1008
|
type: "dismiss";
|
@@ -909,14 +1011,14 @@ export declare const update: (object: {
|
|
909
1011
|
} | {
|
910
1012
|
type: "questlist";
|
911
1013
|
value: number;
|
912
|
-
} | {
|
913
|
-
type: "step_back";
|
914
1014
|
} | {
|
915
1015
|
type: "nudge";
|
916
1016
|
value: number;
|
917
1017
|
} | {
|
918
1018
|
type: "go_to_step";
|
919
1019
|
value: number;
|
1020
|
+
} | {
|
1021
|
+
type: "step_back";
|
920
1022
|
} | ({
|
921
1023
|
type: "open_bar";
|
922
1024
|
} & {
|
@@ -924,39 +1026,51 @@ export declare const update: (object: {
|
|
924
1026
|
categoryFilter?: number | undefined;
|
925
1027
|
}) | {
|
926
1028
|
type: "open_helphub";
|
927
|
-
} | {
|
1029
|
+
} | ({
|
928
1030
|
type: "open_copilot";
|
929
|
-
}
|
930
|
-
|
931
|
-
};
|
1031
|
+
} & {
|
1032
|
+
query?: string | undefined;
|
1033
|
+
});
|
932
1034
|
}[];
|
933
1035
|
helphub_search_action: "search" | "ask";
|
1036
|
+
helphub_custom_theme: string | null;
|
1037
|
+
copilot_chat_history_enabled: boolean;
|
934
1038
|
copilot_negative_feedback_fallback_enabled: boolean;
|
935
1039
|
copilot_negative_feedback_fallback_message: string | null;
|
936
1040
|
copilot_negative_feedback_fallback_actions: {
|
937
1041
|
cta: string;
|
938
|
-
action: {
|
1042
|
+
action: ({
|
1043
|
+
type: "link";
|
1044
|
+
value: string;
|
1045
|
+
} & {
|
1046
|
+
operation?: "self" | "router" | "blank" | undefined;
|
1047
|
+
meta?: {
|
1048
|
+
command: string;
|
1049
|
+
} | undefined;
|
1050
|
+
}) | {
|
1051
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
1052
|
+
value: string[];
|
1053
|
+
} | {
|
939
1054
|
type: "execute_command";
|
940
1055
|
meta: {
|
941
1056
|
command: string;
|
942
1057
|
} & {
|
943
1058
|
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
944
1059
|
};
|
1060
|
+
} | {
|
1061
|
+
type: "no_action";
|
945
1062
|
} | {
|
946
1063
|
type: "click";
|
947
1064
|
value: string;
|
948
1065
|
} | {
|
949
|
-
type: "click" | "clickBySelector" | "clickByXpath";
|
950
|
-
value: string[];
|
951
|
-
} | ({
|
952
|
-
type: "link";
|
953
|
-
value: string;
|
954
|
-
} & {
|
955
|
-
operation?: "self" | "router" | "blank" | undefined;
|
956
|
-
}) | {
|
957
1066
|
type: "open_chat";
|
958
1067
|
meta: {
|
959
|
-
type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "
|
1068
|
+
type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
|
1069
|
+
};
|
1070
|
+
} | {
|
1071
|
+
type: "chat_handoff";
|
1072
|
+
meta: {
|
1073
|
+
type: "" | "intercom" | "freshchat" | "zendesk";
|
960
1074
|
};
|
961
1075
|
} | {
|
962
1076
|
type: "dismiss";
|
@@ -965,14 +1079,14 @@ export declare const update: (object: {
|
|
965
1079
|
} | {
|
966
1080
|
type: "questlist";
|
967
1081
|
value: number;
|
968
|
-
} | {
|
969
|
-
type: "step_back";
|
970
1082
|
} | {
|
971
1083
|
type: "nudge";
|
972
1084
|
value: number;
|
973
1085
|
} | {
|
974
1086
|
type: "go_to_step";
|
975
1087
|
value: number;
|
1088
|
+
} | {
|
1089
|
+
type: "step_back";
|
976
1090
|
} | ({
|
977
1091
|
type: "open_bar";
|
978
1092
|
} & {
|
@@ -980,15 +1094,20 @@ export declare const update: (object: {
|
|
980
1094
|
categoryFilter?: number | undefined;
|
981
1095
|
}) | {
|
982
1096
|
type: "open_helphub";
|
983
|
-
} | {
|
1097
|
+
} | ({
|
984
1098
|
type: "open_copilot";
|
985
|
-
}
|
986
|
-
|
987
|
-
};
|
1099
|
+
} & {
|
1100
|
+
query?: string | undefined;
|
1101
|
+
});
|
988
1102
|
}[];
|
989
1103
|
helphub_manual_suggested_queries: string[];
|
990
1104
|
copilot_name: string;
|
991
1105
|
copilot_avatar: string;
|
1106
|
+
copilot_avatar_v2: {
|
1107
|
+
src: string;
|
1108
|
+
file_name: string;
|
1109
|
+
size: string;
|
1110
|
+
} | null;
|
992
1111
|
copilot_personality: {
|
993
1112
|
template: "professional" | "friendly" | "confident" | "serious" | "empathetic";
|
994
1113
|
} | {
|
@@ -1063,12 +1182,31 @@ export declare const update: (object: {
|
|
1063
1182
|
topic_name?: string | null | undefined;
|
1064
1183
|
conversation_property_name?: string | null | undefined;
|
1065
1184
|
} | undefined;
|
1185
|
+
intercom?: {
|
1186
|
+
enabled?: boolean | undefined;
|
1187
|
+
token?: string | undefined;
|
1188
|
+
} | undefined;
|
1066
1189
|
};
|
1067
1190
|
copilot_enabled: boolean;
|
1068
1191
|
user_property_targeting: boolean;
|
1069
1192
|
ab_test_conditions: boolean;
|
1070
1193
|
spotlight_ask_copilot_enabled: boolean;
|
1071
1194
|
spotlight_ask_copilot_label: string | null;
|
1195
|
+
spotlight_custom_theme: string | null;
|
1196
|
+
spotlight_ask_copilot_audience: {
|
1197
|
+
type: "all_users";
|
1198
|
+
} | {
|
1199
|
+
type: "rule_expression";
|
1200
|
+
expression: import("./helpers/rules").RuleExpression;
|
1201
|
+
} | {
|
1202
|
+
type: "named_rule_reference";
|
1203
|
+
rule_reference: {
|
1204
|
+
type: "named_rule";
|
1205
|
+
rule_id: string | number;
|
1206
|
+
} & {
|
1207
|
+
reason?: string | undefined;
|
1208
|
+
};
|
1209
|
+
} | null;
|
1072
1210
|
helphub_ai_enabled: boolean;
|
1073
1211
|
copilot_experiences_enabled: boolean;
|
1074
1212
|
helphub_chat_only_mode: boolean;
|
@@ -1076,49 +1214,52 @@ export declare const update: (object: {
|
|
1076
1214
|
helphub_launcher_offset_x: number;
|
1077
1215
|
helphub_launcher_offset_y: number;
|
1078
1216
|
helphub_launcher_anchor: string;
|
1079
|
-
helphub_launcher_position: "
|
1080
|
-
helphub_launcher_type: "none" | "custom" | "
|
1217
|
+
helphub_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
1218
|
+
helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
|
1081
1219
|
helphub_mobile_launcher_offset_x: number;
|
1082
1220
|
helphub_mobile_launcher_offset_y: number;
|
1083
1221
|
helphub_mobile_launcher_anchor: string;
|
1084
|
-
helphub_mobile_launcher_position: "
|
1085
|
-
helphub_mobile_launcher_type: "none" | "custom" | "
|
1222
|
+
helphub_mobile_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
1223
|
+
helphub_mobile_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
|
1086
1224
|
}>;
|
1087
1225
|
export declare const listCommands: (orgUID: string) => Promise<({
|
1088
1226
|
id: number;
|
1089
1227
|
text: string;
|
1090
1228
|
template: ({
|
1091
|
-
type: "
|
1229
|
+
type: "callback";
|
1092
1230
|
value: string;
|
1093
1231
|
} & {} & {
|
1094
1232
|
commandType?: "object" | "help" | "independent" | undefined;
|
1095
1233
|
object?: string | undefined;
|
1096
1234
|
hoverTooltip?: boolean | undefined;
|
1097
|
-
operation?: "self" | "router" | "
|
1235
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1098
1236
|
metadata?: {
|
1099
1237
|
[key: string]: unknown;
|
1100
1238
|
} | undefined;
|
1101
1239
|
}) | ({
|
1102
|
-
type: "
|
1240
|
+
type: "link";
|
1103
1241
|
value: string;
|
1242
|
+
} & {
|
1243
|
+
operation?: "self" | "router" | "blank" | undefined;
|
1244
|
+
meta?: {
|
1245
|
+
command: string;
|
1246
|
+
} | undefined;
|
1104
1247
|
} & {} & {
|
1105
1248
|
commandType?: "object" | "help" | "independent" | undefined;
|
1106
1249
|
object?: string | undefined;
|
1107
1250
|
hoverTooltip?: boolean | undefined;
|
1108
|
-
operation?: "self" | "router" | "
|
1251
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1109
1252
|
metadata?: {
|
1110
1253
|
[key: string]: unknown;
|
1111
1254
|
} | undefined;
|
1112
1255
|
}) | ({
|
1113
|
-
type: "
|
1256
|
+
type: "webhook";
|
1114
1257
|
value: string;
|
1115
|
-
} & {
|
1116
|
-
operation?: "self" | "router" | "blank" | undefined;
|
1117
1258
|
} & {} & {
|
1118
1259
|
commandType?: "object" | "help" | "independent" | undefined;
|
1119
1260
|
object?: string | undefined;
|
1120
1261
|
hoverTooltip?: boolean | undefined;
|
1121
|
-
operation?: "self" | "router" | "
|
1262
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1122
1263
|
metadata?: {
|
1123
1264
|
[key: string]: unknown;
|
1124
1265
|
} | undefined;
|
@@ -1129,143 +1270,153 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
1129
1270
|
commandType?: "object" | "help" | "independent" | undefined;
|
1130
1271
|
object?: string | undefined;
|
1131
1272
|
hoverTooltip?: boolean | undefined;
|
1132
|
-
operation?: "self" | "router" | "
|
1273
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1133
1274
|
metadata?: {
|
1134
1275
|
[key: string]: unknown;
|
1135
1276
|
} | undefined;
|
1136
1277
|
}) | ({
|
1137
|
-
type: "
|
1138
|
-
value:
|
1278
|
+
type: "request";
|
1279
|
+
value: {
|
1280
|
+
method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
|
1281
|
+
url: string;
|
1282
|
+
} & {
|
1283
|
+
headers?: {
|
1284
|
+
[key: string]: unknown;
|
1285
|
+
} | undefined;
|
1286
|
+
body?: {
|
1287
|
+
[key: string]: unknown;
|
1288
|
+
} | undefined;
|
1289
|
+
onSend?: string | undefined;
|
1290
|
+
onSuccess?: string | undefined;
|
1291
|
+
onError?: string | undefined;
|
1292
|
+
};
|
1139
1293
|
} & {} & {
|
1140
1294
|
commandType?: "object" | "help" | "independent" | undefined;
|
1141
1295
|
object?: string | undefined;
|
1142
1296
|
hoverTooltip?: boolean | undefined;
|
1143
|
-
operation?: "self" | "router" | "
|
1297
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1144
1298
|
metadata?: {
|
1145
1299
|
[key: string]: unknown;
|
1146
1300
|
} | undefined;
|
1147
1301
|
}) | ({
|
1148
|
-
type: "
|
1302
|
+
type: "appcues";
|
1149
1303
|
value: string;
|
1150
1304
|
} & {} & {
|
1151
1305
|
commandType?: "object" | "help" | "independent" | undefined;
|
1152
1306
|
object?: string | undefined;
|
1153
1307
|
hoverTooltip?: boolean | undefined;
|
1154
|
-
operation?: "self" | "router" | "
|
1308
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1155
1309
|
metadata?: {
|
1156
1310
|
[key: string]: unknown;
|
1157
1311
|
} | undefined;
|
1158
1312
|
}) | ({
|
1159
|
-
type: "
|
1313
|
+
type: "pendo_guide";
|
1160
1314
|
value: string;
|
1161
1315
|
} & {} & {
|
1162
1316
|
commandType?: "object" | "help" | "independent" | undefined;
|
1163
1317
|
object?: string | undefined;
|
1164
1318
|
hoverTooltip?: boolean | undefined;
|
1165
|
-
operation?: "self" | "router" | "
|
1319
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1166
1320
|
metadata?: {
|
1167
1321
|
[key: string]: unknown;
|
1168
1322
|
} | undefined;
|
1169
1323
|
}) | ({
|
1170
|
-
type: "
|
1171
|
-
value:
|
1172
|
-
|
1173
|
-
|
1174
|
-
|
1175
|
-
|
1176
|
-
|
1177
|
-
|
1178
|
-
|
1179
|
-
|
1180
|
-
} | undefined;
|
1181
|
-
onSend?: string | undefined;
|
1182
|
-
onSuccess?: string | undefined;
|
1183
|
-
onError?: string | undefined;
|
1184
|
-
};
|
1324
|
+
type: "helpdoc";
|
1325
|
+
value: string;
|
1326
|
+
} & {
|
1327
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1328
|
+
doc_metadata?: {
|
1329
|
+
content_type?: string | undefined;
|
1330
|
+
date?: string | undefined;
|
1331
|
+
} | undefined;
|
1332
|
+
} & {
|
1333
|
+
doc_type?: "answer" | "doc" | undefined;
|
1185
1334
|
} & {} & {
|
1186
1335
|
commandType?: "object" | "help" | "independent" | undefined;
|
1187
1336
|
object?: string | undefined;
|
1188
1337
|
hoverTooltip?: boolean | undefined;
|
1189
|
-
operation?: "self" | "router" | "
|
1338
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1190
1339
|
metadata?: {
|
1191
1340
|
[key: string]: unknown;
|
1192
1341
|
} | undefined;
|
1193
1342
|
}) | ({
|
1194
|
-
type: "
|
1343
|
+
type: "admin";
|
1195
1344
|
value: string;
|
1196
1345
|
} & {} & {
|
1197
1346
|
commandType?: "object" | "help" | "independent" | undefined;
|
1198
1347
|
object?: string | undefined;
|
1199
1348
|
hoverTooltip?: boolean | undefined;
|
1200
|
-
operation?: "self" | "router" | "
|
1349
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1201
1350
|
metadata?: {
|
1202
1351
|
[key: string]: unknown;
|
1203
1352
|
} | undefined;
|
1204
1353
|
}) | ({
|
1205
|
-
type: "
|
1354
|
+
type: "builtin";
|
1206
1355
|
value: string;
|
1207
1356
|
} & {} & {
|
1208
1357
|
commandType?: "object" | "help" | "independent" | undefined;
|
1209
1358
|
object?: string | undefined;
|
1210
1359
|
hoverTooltip?: boolean | undefined;
|
1211
|
-
operation?: "self" | "router" | "
|
1360
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1212
1361
|
metadata?: {
|
1213
1362
|
[key: string]: unknown;
|
1214
1363
|
} | undefined;
|
1215
1364
|
}) | ({
|
1216
|
-
type: "
|
1365
|
+
type: "script";
|
1217
1366
|
value: string;
|
1218
1367
|
} & {} & {
|
1219
1368
|
commandType?: "object" | "help" | "independent" | undefined;
|
1220
1369
|
object?: string | undefined;
|
1221
1370
|
hoverTooltip?: boolean | undefined;
|
1222
|
-
operation?: "self" | "router" | "
|
1371
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1223
1372
|
metadata?: {
|
1224
1373
|
[key: string]: unknown;
|
1225
1374
|
} | undefined;
|
1226
1375
|
}) | ({
|
1227
|
-
type: "
|
1376
|
+
type: "video";
|
1228
1377
|
value: string;
|
1229
|
-
} & {
|
1230
|
-
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1231
|
-
doc_metadata?: {
|
1232
|
-
content_type?: string | undefined;
|
1233
|
-
date?: string | undefined;
|
1234
|
-
} | undefined;
|
1235
|
-
} & {
|
1236
|
-
doc_type?: "answer" | "doc" | undefined;
|
1237
1378
|
} & {} & {
|
1238
1379
|
commandType?: "object" | "help" | "independent" | undefined;
|
1239
1380
|
object?: string | undefined;
|
1240
1381
|
hoverTooltip?: boolean | undefined;
|
1241
|
-
operation?: "self" | "router" | "
|
1382
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1242
1383
|
metadata?: {
|
1243
1384
|
[key: string]: unknown;
|
1244
1385
|
} | undefined;
|
1245
1386
|
}) | ({
|
1246
1387
|
type: "trigger";
|
1247
|
-
value: {
|
1388
|
+
value: ({
|
1389
|
+
type: "link";
|
1390
|
+
value: string;
|
1391
|
+
} & {
|
1392
|
+
operation?: "self" | "router" | "blank" | undefined;
|
1393
|
+
meta?: {
|
1394
|
+
command: string;
|
1395
|
+
} | undefined;
|
1396
|
+
}) | {
|
1397
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
1398
|
+
value: string[];
|
1399
|
+
} | {
|
1248
1400
|
type: "execute_command";
|
1249
1401
|
meta: {
|
1250
1402
|
command: string;
|
1251
1403
|
} & {
|
1252
1404
|
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
1253
1405
|
};
|
1406
|
+
} | {
|
1407
|
+
type: "no_action";
|
1254
1408
|
} | {
|
1255
1409
|
type: "click";
|
1256
1410
|
value: string;
|
1257
1411
|
} | {
|
1258
|
-
type: "click" | "clickBySelector" | "clickByXpath";
|
1259
|
-
value: string[];
|
1260
|
-
} | ({
|
1261
|
-
type: "link";
|
1262
|
-
value: string;
|
1263
|
-
} & {
|
1264
|
-
operation?: "self" | "router" | "blank" | undefined;
|
1265
|
-
}) | {
|
1266
1412
|
type: "open_chat";
|
1267
1413
|
meta: {
|
1268
|
-
type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "
|
1414
|
+
type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
|
1415
|
+
};
|
1416
|
+
} | {
|
1417
|
+
type: "chat_handoff";
|
1418
|
+
meta: {
|
1419
|
+
type: "" | "intercom" | "freshchat" | "zendesk";
|
1269
1420
|
};
|
1270
1421
|
} | {
|
1271
1422
|
type: "dismiss";
|
@@ -1274,14 +1425,14 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
1274
1425
|
} | {
|
1275
1426
|
type: "questlist";
|
1276
1427
|
value: number;
|
1277
|
-
} | {
|
1278
|
-
type: "step_back";
|
1279
1428
|
} | {
|
1280
1429
|
type: "nudge";
|
1281
1430
|
value: number;
|
1282
1431
|
} | {
|
1283
1432
|
type: "go_to_step";
|
1284
1433
|
value: number;
|
1434
|
+
} | {
|
1435
|
+
type: "step_back";
|
1285
1436
|
} | ({
|
1286
1437
|
type: "open_bar";
|
1287
1438
|
} & {
|
@@ -1289,16 +1440,16 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
1289
1440
|
categoryFilter?: number | undefined;
|
1290
1441
|
}) | {
|
1291
1442
|
type: "open_helphub";
|
1292
|
-
} | {
|
1443
|
+
} | ({
|
1293
1444
|
type: "open_copilot";
|
1294
|
-
}
|
1295
|
-
|
1296
|
-
};
|
1445
|
+
} & {
|
1446
|
+
query?: string | undefined;
|
1447
|
+
});
|
1297
1448
|
} & {} & {
|
1298
1449
|
commandType?: "object" | "help" | "independent" | undefined;
|
1299
1450
|
object?: string | undefined;
|
1300
1451
|
hoverTooltip?: boolean | undefined;
|
1301
|
-
operation?: "self" | "router" | "
|
1452
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1302
1453
|
metadata?: {
|
1303
1454
|
[key: string]: unknown;
|
1304
1455
|
} | undefined;
|
@@ -1312,17 +1463,18 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
1312
1463
|
isAsync?: boolean | undefined;
|
1313
1464
|
} & {
|
1314
1465
|
image: string | null;
|
1466
|
+
labels: string[] | null;
|
1315
1467
|
confirm: string;
|
1316
1468
|
icon: string | null;
|
1317
1469
|
heading: string;
|
1470
|
+
icon_color: string | null;
|
1471
|
+
image_color: string | null;
|
1318
1472
|
sort_key: number | null;
|
1319
|
-
|
1320
|
-
|
1321
|
-
|
1322
|
-
|
1323
|
-
|
1324
|
-
copilot_description: string;
|
1325
|
-
editor_tags: string[];
|
1473
|
+
show_preview: boolean;
|
1474
|
+
shortcut_mac: string[];
|
1475
|
+
shortcut_win: string[];
|
1476
|
+
hotkey_mac: string;
|
1477
|
+
hotkey_win: string;
|
1326
1478
|
tags: string[];
|
1327
1479
|
arguments: {
|
1328
1480
|
[x: string]: ({
|
@@ -1402,14 +1554,6 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
1402
1554
|
auto_choose?: boolean | undefined;
|
1403
1555
|
});
|
1404
1556
|
};
|
1405
|
-
shortcut: string[];
|
1406
|
-
icon_color: string | null;
|
1407
|
-
image_color: string | null;
|
1408
|
-
show_preview: boolean;
|
1409
|
-
shortcut_mac: string[];
|
1410
|
-
shortcut_win: string[];
|
1411
|
-
hotkey_mac: string;
|
1412
|
-
hotkey_win: string;
|
1413
1557
|
category: number | null;
|
1414
1558
|
celebrate: boolean | {
|
1415
1559
|
angle?: number | undefined;
|
@@ -1426,8 +1570,8 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
1426
1570
|
random?: any;
|
1427
1571
|
} | null;
|
1428
1572
|
availability_rules: (({
|
1429
|
-
type: "url" | "element" | "amplitude" | "context" | "
|
1430
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
1573
|
+
type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
|
1574
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
1431
1575
|
} & {
|
1432
1576
|
field?: string | undefined;
|
1433
1577
|
value?: string | undefined;
|
@@ -1436,14 +1580,14 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
1436
1580
|
}) | ({
|
1437
1581
|
type: "nudge_interaction";
|
1438
1582
|
operator: "is" | "isNot";
|
1439
|
-
value: "completed" | "
|
1583
|
+
value: "completed" | "viewed" | "dismissed";
|
1440
1584
|
nudge_id: number;
|
1441
1585
|
} & {
|
1442
1586
|
reason?: string | undefined;
|
1443
1587
|
}) | ({
|
1444
1588
|
type: "questlist_interaction";
|
1445
1589
|
operator: "is" | "isNot";
|
1446
|
-
value: "completed" | "
|
1590
|
+
value: "completed" | "viewed" | "dismissed";
|
1447
1591
|
questlist_id: number;
|
1448
1592
|
} & {
|
1449
1593
|
reason?: string | undefined;
|
@@ -1454,13 +1598,8 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
1454
1598
|
} & {
|
1455
1599
|
reason?: string | undefined;
|
1456
1600
|
}))[] | (({
|
1457
|
-
type: "
|
1458
|
-
|
1459
|
-
} & {
|
1460
|
-
reason?: string | undefined;
|
1461
|
-
}) | ({
|
1462
|
-
type: "url" | "element" | "amplitude" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
|
1463
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
1601
|
+
type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
|
1602
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
1464
1603
|
} & {
|
1465
1604
|
field?: string | undefined;
|
1466
1605
|
value?: string | undefined;
|
@@ -1469,14 +1608,14 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
1469
1608
|
}) | ({
|
1470
1609
|
type: "nudge_interaction";
|
1471
1610
|
operator: "is" | "isNot";
|
1472
|
-
value: "completed" | "
|
1611
|
+
value: "completed" | "viewed" | "dismissed";
|
1473
1612
|
nudge_id: number;
|
1474
1613
|
} & {
|
1475
1614
|
reason?: string | undefined;
|
1476
1615
|
}) | ({
|
1477
1616
|
type: "questlist_interaction";
|
1478
1617
|
operator: "is" | "isNot";
|
1479
|
-
value: "completed" | "
|
1618
|
+
value: "completed" | "viewed" | "dismissed";
|
1480
1619
|
questlist_id: number;
|
1481
1620
|
} & {
|
1482
1621
|
reason?: string | undefined;
|
@@ -1486,10 +1625,15 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
1486
1625
|
values: string[];
|
1487
1626
|
} & {
|
1488
1627
|
reason?: string | undefined;
|
1628
|
+
}) | ({
|
1629
|
+
type: "named_rule";
|
1630
|
+
rule_id: string | number;
|
1631
|
+
} & {
|
1632
|
+
reason?: string | undefined;
|
1489
1633
|
}))[];
|
1490
1634
|
recommend_rules: (({
|
1491
|
-
type: "url" | "element" | "amplitude" | "context" | "
|
1492
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
1635
|
+
type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
|
1636
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
1493
1637
|
} & {
|
1494
1638
|
field?: string | undefined;
|
1495
1639
|
value?: string | undefined;
|
@@ -1498,14 +1642,14 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
1498
1642
|
}) | ({
|
1499
1643
|
type: "nudge_interaction";
|
1500
1644
|
operator: "is" | "isNot";
|
1501
|
-
value: "completed" | "
|
1645
|
+
value: "completed" | "viewed" | "dismissed";
|
1502
1646
|
nudge_id: number;
|
1503
1647
|
} & {
|
1504
1648
|
reason?: string | undefined;
|
1505
1649
|
}) | ({
|
1506
1650
|
type: "questlist_interaction";
|
1507
1651
|
operator: "is" | "isNot";
|
1508
|
-
value: "completed" | "
|
1652
|
+
value: "completed" | "viewed" | "dismissed";
|
1509
1653
|
questlist_id: number;
|
1510
1654
|
} & {
|
1511
1655
|
reason?: string | undefined;
|
@@ -1524,13 +1668,8 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
1524
1668
|
reason?: null | undefined;
|
1525
1669
|
rule_id?: string | number | undefined;
|
1526
1670
|
}))[] | (({
|
1527
|
-
type: "
|
1528
|
-
|
1529
|
-
} & {
|
1530
|
-
reason?: string | undefined;
|
1531
|
-
}) | ({
|
1532
|
-
type: "url" | "element" | "amplitude" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
|
1533
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
1671
|
+
type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
|
1672
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
1534
1673
|
} & {
|
1535
1674
|
field?: string | undefined;
|
1536
1675
|
value?: string | undefined;
|
@@ -1539,14 +1678,14 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
1539
1678
|
}) | ({
|
1540
1679
|
type: "nudge_interaction";
|
1541
1680
|
operator: "is" | "isNot";
|
1542
|
-
value: "completed" | "
|
1681
|
+
value: "completed" | "viewed" | "dismissed";
|
1543
1682
|
nudge_id: number;
|
1544
1683
|
} & {
|
1545
1684
|
reason?: string | undefined;
|
1546
1685
|
}) | ({
|
1547
1686
|
type: "questlist_interaction";
|
1548
1687
|
operator: "is" | "isNot";
|
1549
|
-
value: "completed" | "
|
1688
|
+
value: "completed" | "viewed" | "dismissed";
|
1550
1689
|
questlist_id: number;
|
1551
1690
|
} & {
|
1552
1691
|
reason?: string | undefined;
|
@@ -1564,35 +1703,57 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
1564
1703
|
value?: null | undefined;
|
1565
1704
|
reason?: null | undefined;
|
1566
1705
|
rule_id?: string | number | undefined;
|
1706
|
+
}) | ({
|
1707
|
+
type: "named_rule";
|
1708
|
+
rule_id: string | number;
|
1709
|
+
} & {
|
1710
|
+
reason?: string | undefined;
|
1567
1711
|
}))[];
|
1568
1712
|
availability_expression: import("./helpers/rules").RuleExpression;
|
1569
1713
|
recommend_expression: import("./helpers/rules").RuleExpression;
|
1714
|
+
is_live: boolean;
|
1570
1715
|
always_recommend: boolean;
|
1716
|
+
shortcut: string[];
|
1571
1717
|
recommend_sort_key: number | null;
|
1718
|
+
thumbnail: {
|
1719
|
+
src: string;
|
1720
|
+
file_name: string;
|
1721
|
+
size: string;
|
1722
|
+
} | null;
|
1572
1723
|
next_steps: (string | number | {
|
1573
1724
|
cta: string;
|
1574
|
-
action: {
|
1725
|
+
action: ({
|
1726
|
+
type: "link";
|
1727
|
+
value: string;
|
1728
|
+
} & {
|
1729
|
+
operation?: "self" | "router" | "blank" | undefined;
|
1730
|
+
meta?: {
|
1731
|
+
command: string;
|
1732
|
+
} | undefined;
|
1733
|
+
}) | {
|
1734
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
1735
|
+
value: string[];
|
1736
|
+
} | {
|
1575
1737
|
type: "execute_command";
|
1576
1738
|
meta: {
|
1577
1739
|
command: string;
|
1578
1740
|
} & {
|
1579
1741
|
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
1580
1742
|
};
|
1743
|
+
} | {
|
1744
|
+
type: "no_action";
|
1581
1745
|
} | {
|
1582
1746
|
type: "click";
|
1583
1747
|
value: string;
|
1584
1748
|
} | {
|
1585
|
-
type: "click" | "clickBySelector" | "clickByXpath";
|
1586
|
-
value: string[];
|
1587
|
-
} | ({
|
1588
|
-
type: "link";
|
1589
|
-
value: string;
|
1590
|
-
} & {
|
1591
|
-
operation?: "self" | "router" | "blank" | undefined;
|
1592
|
-
}) | {
|
1593
1749
|
type: "open_chat";
|
1594
1750
|
meta: {
|
1595
|
-
type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "
|
1751
|
+
type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
|
1752
|
+
};
|
1753
|
+
} | {
|
1754
|
+
type: "chat_handoff";
|
1755
|
+
meta: {
|
1756
|
+
type: "" | "intercom" | "freshchat" | "zendesk";
|
1596
1757
|
};
|
1597
1758
|
} | {
|
1598
1759
|
type: "dismiss";
|
@@ -1601,14 +1762,14 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
1601
1762
|
} | {
|
1602
1763
|
type: "questlist";
|
1603
1764
|
value: number;
|
1604
|
-
} | {
|
1605
|
-
type: "step_back";
|
1606
1765
|
} | {
|
1607
1766
|
type: "nudge";
|
1608
1767
|
value: number;
|
1609
1768
|
} | {
|
1610
1769
|
type: "go_to_step";
|
1611
1770
|
value: number;
|
1771
|
+
} | {
|
1772
|
+
type: "step_back";
|
1612
1773
|
} | ({
|
1613
1774
|
type: "open_bar";
|
1614
1775
|
} & {
|
@@ -1616,23 +1777,24 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
1616
1777
|
categoryFilter?: number | undefined;
|
1617
1778
|
}) | {
|
1618
1779
|
type: "open_helphub";
|
1619
|
-
} | {
|
1780
|
+
} | ({
|
1620
1781
|
type: "open_copilot";
|
1621
|
-
}
|
1622
|
-
|
1623
|
-
};
|
1782
|
+
} & {
|
1783
|
+
query?: string | undefined;
|
1784
|
+
});
|
1624
1785
|
})[];
|
1625
|
-
thumbnail: {
|
1626
|
-
src: string;
|
1627
|
-
file_name: string;
|
1628
|
-
size: string;
|
1629
|
-
} | null;
|
1630
|
-
copilot_use_verbatim: boolean;
|
1631
1786
|
generated_tags: {
|
1632
1787
|
automated?: string[] | null | undefined;
|
1633
1788
|
manual?: string[] | null | undefined;
|
1634
1789
|
deny?: string[] | null | undefined;
|
1635
1790
|
};
|
1791
|
+
copilot_suggest: boolean;
|
1792
|
+
show_in_spotlight_search: boolean;
|
1793
|
+
show_in_helphub_search: boolean;
|
1794
|
+
copilot_cta_label: string;
|
1795
|
+
copilot_description: string;
|
1796
|
+
copilot_use_verbatim: boolean;
|
1797
|
+
editor_tags: string[];
|
1636
1798
|
} & {
|
1637
1799
|
third_party_source?: string | null | undefined;
|
1638
1800
|
third_party_id?: string | null | undefined;
|
@@ -1660,37 +1822,40 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
1660
1822
|
id: number;
|
1661
1823
|
text: string;
|
1662
1824
|
template: ({
|
1663
|
-
type: "
|
1825
|
+
type: "callback";
|
1664
1826
|
value: string;
|
1665
1827
|
} & {} & {
|
1666
1828
|
commandType?: "object" | "help" | "independent" | undefined;
|
1667
1829
|
object?: string | undefined;
|
1668
1830
|
hoverTooltip?: boolean | undefined;
|
1669
|
-
operation?: "self" | "router" | "
|
1831
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1670
1832
|
metadata?: {
|
1671
1833
|
[key: string]: unknown;
|
1672
1834
|
} | undefined;
|
1673
1835
|
}) | ({
|
1674
|
-
type: "
|
1836
|
+
type: "link";
|
1675
1837
|
value: string;
|
1838
|
+
} & {
|
1839
|
+
operation?: "self" | "router" | "blank" | undefined;
|
1840
|
+
meta?: {
|
1841
|
+
command: string;
|
1842
|
+
} | undefined;
|
1676
1843
|
} & {} & {
|
1677
1844
|
commandType?: "object" | "help" | "independent" | undefined;
|
1678
1845
|
object?: string | undefined;
|
1679
1846
|
hoverTooltip?: boolean | undefined;
|
1680
|
-
operation?: "self" | "router" | "
|
1847
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1681
1848
|
metadata?: {
|
1682
1849
|
[key: string]: unknown;
|
1683
1850
|
} | undefined;
|
1684
1851
|
}) | ({
|
1685
|
-
type: "
|
1852
|
+
type: "webhook";
|
1686
1853
|
value: string;
|
1687
|
-
} & {
|
1688
|
-
operation?: "self" | "router" | "blank" | undefined;
|
1689
1854
|
} & {} & {
|
1690
1855
|
commandType?: "object" | "help" | "independent" | undefined;
|
1691
1856
|
object?: string | undefined;
|
1692
1857
|
hoverTooltip?: boolean | undefined;
|
1693
|
-
operation?: "self" | "router" | "
|
1858
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1694
1859
|
metadata?: {
|
1695
1860
|
[key: string]: unknown;
|
1696
1861
|
} | undefined;
|
@@ -1701,143 +1866,153 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
1701
1866
|
commandType?: "object" | "help" | "independent" | undefined;
|
1702
1867
|
object?: string | undefined;
|
1703
1868
|
hoverTooltip?: boolean | undefined;
|
1704
|
-
operation?: "self" | "router" | "
|
1869
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1705
1870
|
metadata?: {
|
1706
1871
|
[key: string]: unknown;
|
1707
1872
|
} | undefined;
|
1708
1873
|
}) | ({
|
1709
|
-
type: "
|
1710
|
-
value:
|
1874
|
+
type: "request";
|
1875
|
+
value: {
|
1876
|
+
method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
|
1877
|
+
url: string;
|
1878
|
+
} & {
|
1879
|
+
headers?: {
|
1880
|
+
[key: string]: unknown;
|
1881
|
+
} | undefined;
|
1882
|
+
body?: {
|
1883
|
+
[key: string]: unknown;
|
1884
|
+
} | undefined;
|
1885
|
+
onSend?: string | undefined;
|
1886
|
+
onSuccess?: string | undefined;
|
1887
|
+
onError?: string | undefined;
|
1888
|
+
};
|
1711
1889
|
} & {} & {
|
1712
1890
|
commandType?: "object" | "help" | "independent" | undefined;
|
1713
1891
|
object?: string | undefined;
|
1714
1892
|
hoverTooltip?: boolean | undefined;
|
1715
|
-
operation?: "self" | "router" | "
|
1893
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1716
1894
|
metadata?: {
|
1717
1895
|
[key: string]: unknown;
|
1718
1896
|
} | undefined;
|
1719
1897
|
}) | ({
|
1720
|
-
type: "
|
1898
|
+
type: "appcues";
|
1721
1899
|
value: string;
|
1722
1900
|
} & {} & {
|
1723
1901
|
commandType?: "object" | "help" | "independent" | undefined;
|
1724
1902
|
object?: string | undefined;
|
1725
1903
|
hoverTooltip?: boolean | undefined;
|
1726
|
-
operation?: "self" | "router" | "
|
1904
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1727
1905
|
metadata?: {
|
1728
1906
|
[key: string]: unknown;
|
1729
1907
|
} | undefined;
|
1730
1908
|
}) | ({
|
1731
|
-
type: "
|
1909
|
+
type: "pendo_guide";
|
1732
1910
|
value: string;
|
1733
1911
|
} & {} & {
|
1734
1912
|
commandType?: "object" | "help" | "independent" | undefined;
|
1735
1913
|
object?: string | undefined;
|
1736
1914
|
hoverTooltip?: boolean | undefined;
|
1737
|
-
operation?: "self" | "router" | "
|
1915
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1738
1916
|
metadata?: {
|
1739
1917
|
[key: string]: unknown;
|
1740
1918
|
} | undefined;
|
1741
1919
|
}) | ({
|
1742
|
-
type: "
|
1743
|
-
value:
|
1744
|
-
|
1745
|
-
|
1746
|
-
|
1747
|
-
|
1748
|
-
|
1749
|
-
|
1750
|
-
|
1751
|
-
|
1752
|
-
} | undefined;
|
1753
|
-
onSend?: string | undefined;
|
1754
|
-
onSuccess?: string | undefined;
|
1755
|
-
onError?: string | undefined;
|
1756
|
-
};
|
1920
|
+
type: "helpdoc";
|
1921
|
+
value: string;
|
1922
|
+
} & {
|
1923
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1924
|
+
doc_metadata?: {
|
1925
|
+
content_type?: string | undefined;
|
1926
|
+
date?: string | undefined;
|
1927
|
+
} | undefined;
|
1928
|
+
} & {
|
1929
|
+
doc_type?: "answer" | "doc" | undefined;
|
1757
1930
|
} & {} & {
|
1758
1931
|
commandType?: "object" | "help" | "independent" | undefined;
|
1759
1932
|
object?: string | undefined;
|
1760
1933
|
hoverTooltip?: boolean | undefined;
|
1761
|
-
operation?: "self" | "router" | "
|
1934
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1762
1935
|
metadata?: {
|
1763
1936
|
[key: string]: unknown;
|
1764
1937
|
} | undefined;
|
1765
1938
|
}) | ({
|
1766
|
-
type: "
|
1939
|
+
type: "admin";
|
1767
1940
|
value: string;
|
1768
1941
|
} & {} & {
|
1769
1942
|
commandType?: "object" | "help" | "independent" | undefined;
|
1770
1943
|
object?: string | undefined;
|
1771
1944
|
hoverTooltip?: boolean | undefined;
|
1772
|
-
operation?: "self" | "router" | "
|
1945
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1773
1946
|
metadata?: {
|
1774
1947
|
[key: string]: unknown;
|
1775
1948
|
} | undefined;
|
1776
1949
|
}) | ({
|
1777
|
-
type: "
|
1950
|
+
type: "builtin";
|
1778
1951
|
value: string;
|
1779
1952
|
} & {} & {
|
1780
1953
|
commandType?: "object" | "help" | "independent" | undefined;
|
1781
1954
|
object?: string | undefined;
|
1782
1955
|
hoverTooltip?: boolean | undefined;
|
1783
|
-
operation?: "self" | "router" | "
|
1956
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1784
1957
|
metadata?: {
|
1785
1958
|
[key: string]: unknown;
|
1786
1959
|
} | undefined;
|
1787
1960
|
}) | ({
|
1788
|
-
type: "
|
1961
|
+
type: "script";
|
1789
1962
|
value: string;
|
1790
1963
|
} & {} & {
|
1791
1964
|
commandType?: "object" | "help" | "independent" | undefined;
|
1792
1965
|
object?: string | undefined;
|
1793
1966
|
hoverTooltip?: boolean | undefined;
|
1794
|
-
operation?: "self" | "router" | "
|
1967
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1795
1968
|
metadata?: {
|
1796
1969
|
[key: string]: unknown;
|
1797
1970
|
} | undefined;
|
1798
1971
|
}) | ({
|
1799
|
-
type: "
|
1972
|
+
type: "video";
|
1800
1973
|
value: string;
|
1801
|
-
} & {
|
1802
|
-
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1803
|
-
doc_metadata?: {
|
1804
|
-
content_type?: string | undefined;
|
1805
|
-
date?: string | undefined;
|
1806
|
-
} | undefined;
|
1807
|
-
} & {
|
1808
|
-
doc_type?: "answer" | "doc" | undefined;
|
1809
1974
|
} & {} & {
|
1810
1975
|
commandType?: "object" | "help" | "independent" | undefined;
|
1811
1976
|
object?: string | undefined;
|
1812
1977
|
hoverTooltip?: boolean | undefined;
|
1813
|
-
operation?: "self" | "router" | "
|
1978
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1814
1979
|
metadata?: {
|
1815
1980
|
[key: string]: unknown;
|
1816
1981
|
} | undefined;
|
1817
1982
|
}) | ({
|
1818
1983
|
type: "trigger";
|
1819
|
-
value: {
|
1984
|
+
value: ({
|
1985
|
+
type: "link";
|
1986
|
+
value: string;
|
1987
|
+
} & {
|
1988
|
+
operation?: "self" | "router" | "blank" | undefined;
|
1989
|
+
meta?: {
|
1990
|
+
command: string;
|
1991
|
+
} | undefined;
|
1992
|
+
}) | {
|
1993
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
1994
|
+
value: string[];
|
1995
|
+
} | {
|
1820
1996
|
type: "execute_command";
|
1821
1997
|
meta: {
|
1822
1998
|
command: string;
|
1823
1999
|
} & {
|
1824
2000
|
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
1825
2001
|
};
|
2002
|
+
} | {
|
2003
|
+
type: "no_action";
|
1826
2004
|
} | {
|
1827
2005
|
type: "click";
|
1828
2006
|
value: string;
|
1829
2007
|
} | {
|
1830
|
-
type: "click" | "clickBySelector" | "clickByXpath";
|
1831
|
-
value: string[];
|
1832
|
-
} | ({
|
1833
|
-
type: "link";
|
1834
|
-
value: string;
|
1835
|
-
} & {
|
1836
|
-
operation?: "self" | "router" | "blank" | undefined;
|
1837
|
-
}) | {
|
1838
2008
|
type: "open_chat";
|
1839
2009
|
meta: {
|
1840
|
-
type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "
|
2010
|
+
type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
|
2011
|
+
};
|
2012
|
+
} | {
|
2013
|
+
type: "chat_handoff";
|
2014
|
+
meta: {
|
2015
|
+
type: "" | "intercom" | "freshchat" | "zendesk";
|
1841
2016
|
};
|
1842
2017
|
} | {
|
1843
2018
|
type: "dismiss";
|
@@ -1846,14 +2021,14 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
1846
2021
|
} | {
|
1847
2022
|
type: "questlist";
|
1848
2023
|
value: number;
|
1849
|
-
} | {
|
1850
|
-
type: "step_back";
|
1851
2024
|
} | {
|
1852
2025
|
type: "nudge";
|
1853
2026
|
value: number;
|
1854
2027
|
} | {
|
1855
2028
|
type: "go_to_step";
|
1856
2029
|
value: number;
|
2030
|
+
} | {
|
2031
|
+
type: "step_back";
|
1857
2032
|
} | ({
|
1858
2033
|
type: "open_bar";
|
1859
2034
|
} & {
|
@@ -1861,16 +2036,16 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
1861
2036
|
categoryFilter?: number | undefined;
|
1862
2037
|
}) | {
|
1863
2038
|
type: "open_helphub";
|
1864
|
-
} | {
|
2039
|
+
} | ({
|
1865
2040
|
type: "open_copilot";
|
1866
|
-
}
|
1867
|
-
|
1868
|
-
};
|
2041
|
+
} & {
|
2042
|
+
query?: string | undefined;
|
2043
|
+
});
|
1869
2044
|
} & {} & {
|
1870
2045
|
commandType?: "object" | "help" | "independent" | undefined;
|
1871
2046
|
object?: string | undefined;
|
1872
2047
|
hoverTooltip?: boolean | undefined;
|
1873
|
-
operation?: "self" | "router" | "
|
2048
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
1874
2049
|
metadata?: {
|
1875
2050
|
[key: string]: unknown;
|
1876
2051
|
} | undefined;
|
@@ -1963,8 +2138,8 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
1963
2138
|
};
|
1964
2139
|
tags: string[];
|
1965
2140
|
availability_rules: (({
|
1966
|
-
type: "url" | "element" | "amplitude" | "context" | "
|
1967
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
2141
|
+
type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
|
2142
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
1968
2143
|
} & {
|
1969
2144
|
field?: string | undefined;
|
1970
2145
|
value?: string | undefined;
|
@@ -1973,14 +2148,14 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
1973
2148
|
}) | ({
|
1974
2149
|
type: "nudge_interaction";
|
1975
2150
|
operator: "is" | "isNot";
|
1976
|
-
value: "completed" | "
|
2151
|
+
value: "completed" | "viewed" | "dismissed";
|
1977
2152
|
nudge_id: number;
|
1978
2153
|
} & {
|
1979
2154
|
reason?: string | undefined;
|
1980
2155
|
}) | ({
|
1981
2156
|
type: "questlist_interaction";
|
1982
2157
|
operator: "is" | "isNot";
|
1983
|
-
value: "completed" | "
|
2158
|
+
value: "completed" | "viewed" | "dismissed";
|
1984
2159
|
questlist_id: number;
|
1985
2160
|
} & {
|
1986
2161
|
reason?: string | undefined;
|
@@ -1992,8 +2167,8 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
1992
2167
|
reason?: string | undefined;
|
1993
2168
|
}))[];
|
1994
2169
|
recommend_rules: (({
|
1995
|
-
type: "url" | "element" | "amplitude" | "context" | "
|
1996
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
2170
|
+
type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
|
2171
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
1997
2172
|
} & {
|
1998
2173
|
field?: string | undefined;
|
1999
2174
|
value?: string | undefined;
|
@@ -2002,14 +2177,14 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
2002
2177
|
}) | ({
|
2003
2178
|
type: "nudge_interaction";
|
2004
2179
|
operator: "is" | "isNot";
|
2005
|
-
value: "completed" | "
|
2180
|
+
value: "completed" | "viewed" | "dismissed";
|
2006
2181
|
nudge_id: number;
|
2007
2182
|
} & {
|
2008
2183
|
reason?: string | undefined;
|
2009
2184
|
}) | ({
|
2010
2185
|
type: "questlist_interaction";
|
2011
2186
|
operator: "is" | "isNot";
|
2012
|
-
value: "completed" | "
|
2187
|
+
value: "completed" | "viewed" | "dismissed";
|
2013
2188
|
questlist_id: number;
|
2014
2189
|
} & {
|
2015
2190
|
reason?: string | undefined;
|
@@ -2076,23 +2251,23 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
2076
2251
|
hotkey_mac: string;
|
2077
2252
|
hotkey_win: string;
|
2078
2253
|
detail: string | ({
|
2079
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
2254
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
2080
2255
|
value: string;
|
2081
2256
|
} & {
|
2082
2257
|
position?: "inline" | "popover" | undefined;
|
2083
2258
|
}) | (string | ({
|
2084
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
2259
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
2085
2260
|
value: string;
|
2086
2261
|
} & {
|
2087
2262
|
position?: "inline" | "popover" | undefined;
|
2088
2263
|
}))[] | null;
|
2089
2264
|
content: string | ({
|
2090
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
2265
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
2091
2266
|
value: string;
|
2092
2267
|
} & {
|
2093
2268
|
position?: "inline" | "popover" | undefined;
|
2094
2269
|
}) | (string | ({
|
2095
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
2270
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
2096
2271
|
value: string;
|
2097
2272
|
} & {
|
2098
2273
|
position?: "inline" | "popover" | undefined;
|
@@ -2100,28 +2275,38 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
2100
2275
|
show_preview: boolean;
|
2101
2276
|
next_steps: (string | number | {
|
2102
2277
|
cta: string;
|
2103
|
-
action: {
|
2278
|
+
action: ({
|
2279
|
+
type: "link";
|
2280
|
+
value: string;
|
2281
|
+
} & {
|
2282
|
+
operation?: "self" | "router" | "blank" | undefined;
|
2283
|
+
meta?: {
|
2284
|
+
command: string;
|
2285
|
+
} | undefined;
|
2286
|
+
}) | {
|
2287
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
2288
|
+
value: string[];
|
2289
|
+
} | {
|
2104
2290
|
type: "execute_command";
|
2105
2291
|
meta: {
|
2106
2292
|
command: string;
|
2107
2293
|
} & {
|
2108
2294
|
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
2109
2295
|
};
|
2296
|
+
} | {
|
2297
|
+
type: "no_action";
|
2110
2298
|
} | {
|
2111
2299
|
type: "click";
|
2112
2300
|
value: string;
|
2113
2301
|
} | {
|
2114
|
-
type: "click" | "clickBySelector" | "clickByXpath";
|
2115
|
-
value: string[];
|
2116
|
-
} | ({
|
2117
|
-
type: "link";
|
2118
|
-
value: string;
|
2119
|
-
} & {
|
2120
|
-
operation?: "self" | "router" | "blank" | undefined;
|
2121
|
-
}) | {
|
2122
2302
|
type: "open_chat";
|
2123
2303
|
meta: {
|
2124
|
-
type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "
|
2304
|
+
type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
|
2305
|
+
};
|
2306
|
+
} | {
|
2307
|
+
type: "chat_handoff";
|
2308
|
+
meta: {
|
2309
|
+
type: "" | "intercom" | "freshchat" | "zendesk";
|
2125
2310
|
};
|
2126
2311
|
} | {
|
2127
2312
|
type: "dismiss";
|
@@ -2130,14 +2315,14 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
2130
2315
|
} | {
|
2131
2316
|
type: "questlist";
|
2132
2317
|
value: number;
|
2133
|
-
} | {
|
2134
|
-
type: "step_back";
|
2135
2318
|
} | {
|
2136
2319
|
type: "nudge";
|
2137
2320
|
value: number;
|
2138
2321
|
} | {
|
2139
2322
|
type: "go_to_step";
|
2140
2323
|
value: number;
|
2324
|
+
} | {
|
2325
|
+
type: "step_back";
|
2141
2326
|
} | ({
|
2142
2327
|
type: "open_bar";
|
2143
2328
|
} & {
|
@@ -2145,11 +2330,11 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
2145
2330
|
categoryFilter?: number | undefined;
|
2146
2331
|
}) | {
|
2147
2332
|
type: "open_helphub";
|
2148
|
-
} | {
|
2333
|
+
} | ({
|
2149
2334
|
type: "open_copilot";
|
2150
|
-
}
|
2151
|
-
|
2152
|
-
};
|
2335
|
+
} & {
|
2336
|
+
query?: string | undefined;
|
2337
|
+
});
|
2153
2338
|
})[];
|
2154
2339
|
extra: string | null;
|
2155
2340
|
thumbnail: {
|
@@ -2190,37 +2375,40 @@ export declare const getCommandById: (orgUID: string, commandID: string) => Prom
|
|
2190
2375
|
id: number;
|
2191
2376
|
text: string;
|
2192
2377
|
template: ({
|
2193
|
-
type: "
|
2378
|
+
type: "callback";
|
2194
2379
|
value: string;
|
2195
2380
|
} & {} & {
|
2196
2381
|
commandType?: "object" | "help" | "independent" | undefined;
|
2197
2382
|
object?: string | undefined;
|
2198
2383
|
hoverTooltip?: boolean | undefined;
|
2199
|
-
operation?: "self" | "router" | "
|
2384
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2200
2385
|
metadata?: {
|
2201
2386
|
[key: string]: unknown;
|
2202
2387
|
} | undefined;
|
2203
2388
|
}) | ({
|
2204
|
-
type: "
|
2389
|
+
type: "link";
|
2205
2390
|
value: string;
|
2391
|
+
} & {
|
2392
|
+
operation?: "self" | "router" | "blank" | undefined;
|
2393
|
+
meta?: {
|
2394
|
+
command: string;
|
2395
|
+
} | undefined;
|
2206
2396
|
} & {} & {
|
2207
2397
|
commandType?: "object" | "help" | "independent" | undefined;
|
2208
2398
|
object?: string | undefined;
|
2209
2399
|
hoverTooltip?: boolean | undefined;
|
2210
|
-
operation?: "self" | "router" | "
|
2400
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2211
2401
|
metadata?: {
|
2212
2402
|
[key: string]: unknown;
|
2213
2403
|
} | undefined;
|
2214
2404
|
}) | ({
|
2215
|
-
type: "
|
2405
|
+
type: "webhook";
|
2216
2406
|
value: string;
|
2217
|
-
} & {
|
2218
|
-
operation?: "self" | "router" | "blank" | undefined;
|
2219
2407
|
} & {} & {
|
2220
2408
|
commandType?: "object" | "help" | "independent" | undefined;
|
2221
2409
|
object?: string | undefined;
|
2222
2410
|
hoverTooltip?: boolean | undefined;
|
2223
|
-
operation?: "self" | "router" | "
|
2411
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2224
2412
|
metadata?: {
|
2225
2413
|
[key: string]: unknown;
|
2226
2414
|
} | undefined;
|
@@ -2231,143 +2419,153 @@ export declare const getCommandById: (orgUID: string, commandID: string) => Prom
|
|
2231
2419
|
commandType?: "object" | "help" | "independent" | undefined;
|
2232
2420
|
object?: string | undefined;
|
2233
2421
|
hoverTooltip?: boolean | undefined;
|
2234
|
-
operation?: "self" | "router" | "
|
2422
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2235
2423
|
metadata?: {
|
2236
2424
|
[key: string]: unknown;
|
2237
2425
|
} | undefined;
|
2238
2426
|
}) | ({
|
2239
|
-
type: "
|
2240
|
-
value:
|
2427
|
+
type: "request";
|
2428
|
+
value: {
|
2429
|
+
method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
|
2430
|
+
url: string;
|
2431
|
+
} & {
|
2432
|
+
headers?: {
|
2433
|
+
[key: string]: unknown;
|
2434
|
+
} | undefined;
|
2435
|
+
body?: {
|
2436
|
+
[key: string]: unknown;
|
2437
|
+
} | undefined;
|
2438
|
+
onSend?: string | undefined;
|
2439
|
+
onSuccess?: string | undefined;
|
2440
|
+
onError?: string | undefined;
|
2441
|
+
};
|
2241
2442
|
} & {} & {
|
2242
2443
|
commandType?: "object" | "help" | "independent" | undefined;
|
2243
2444
|
object?: string | undefined;
|
2244
2445
|
hoverTooltip?: boolean | undefined;
|
2245
|
-
operation?: "self" | "router" | "
|
2446
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2246
2447
|
metadata?: {
|
2247
2448
|
[key: string]: unknown;
|
2248
2449
|
} | undefined;
|
2249
2450
|
}) | ({
|
2250
|
-
type: "
|
2451
|
+
type: "appcues";
|
2251
2452
|
value: string;
|
2252
2453
|
} & {} & {
|
2253
2454
|
commandType?: "object" | "help" | "independent" | undefined;
|
2254
2455
|
object?: string | undefined;
|
2255
2456
|
hoverTooltip?: boolean | undefined;
|
2256
|
-
operation?: "self" | "router" | "
|
2457
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2257
2458
|
metadata?: {
|
2258
2459
|
[key: string]: unknown;
|
2259
2460
|
} | undefined;
|
2260
2461
|
}) | ({
|
2261
|
-
type: "
|
2462
|
+
type: "pendo_guide";
|
2262
2463
|
value: string;
|
2263
2464
|
} & {} & {
|
2264
2465
|
commandType?: "object" | "help" | "independent" | undefined;
|
2265
2466
|
object?: string | undefined;
|
2266
2467
|
hoverTooltip?: boolean | undefined;
|
2267
|
-
operation?: "self" | "router" | "
|
2468
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2268
2469
|
metadata?: {
|
2269
2470
|
[key: string]: unknown;
|
2270
2471
|
} | undefined;
|
2271
2472
|
}) | ({
|
2272
|
-
type: "
|
2273
|
-
value:
|
2274
|
-
|
2275
|
-
|
2276
|
-
|
2277
|
-
|
2278
|
-
|
2279
|
-
|
2280
|
-
|
2281
|
-
|
2282
|
-
} | undefined;
|
2283
|
-
onSend?: string | undefined;
|
2284
|
-
onSuccess?: string | undefined;
|
2285
|
-
onError?: string | undefined;
|
2286
|
-
};
|
2473
|
+
type: "helpdoc";
|
2474
|
+
value: string;
|
2475
|
+
} & {
|
2476
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2477
|
+
doc_metadata?: {
|
2478
|
+
content_type?: string | undefined;
|
2479
|
+
date?: string | undefined;
|
2480
|
+
} | undefined;
|
2481
|
+
} & {
|
2482
|
+
doc_type?: "answer" | "doc" | undefined;
|
2287
2483
|
} & {} & {
|
2288
2484
|
commandType?: "object" | "help" | "independent" | undefined;
|
2289
2485
|
object?: string | undefined;
|
2290
2486
|
hoverTooltip?: boolean | undefined;
|
2291
|
-
operation?: "self" | "router" | "
|
2487
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2292
2488
|
metadata?: {
|
2293
2489
|
[key: string]: unknown;
|
2294
2490
|
} | undefined;
|
2295
2491
|
}) | ({
|
2296
|
-
type: "
|
2492
|
+
type: "admin";
|
2297
2493
|
value: string;
|
2298
2494
|
} & {} & {
|
2299
2495
|
commandType?: "object" | "help" | "independent" | undefined;
|
2300
2496
|
object?: string | undefined;
|
2301
2497
|
hoverTooltip?: boolean | undefined;
|
2302
|
-
operation?: "self" | "router" | "
|
2498
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2303
2499
|
metadata?: {
|
2304
2500
|
[key: string]: unknown;
|
2305
2501
|
} | undefined;
|
2306
2502
|
}) | ({
|
2307
|
-
type: "
|
2503
|
+
type: "builtin";
|
2308
2504
|
value: string;
|
2309
2505
|
} & {} & {
|
2310
2506
|
commandType?: "object" | "help" | "independent" | undefined;
|
2311
2507
|
object?: string | undefined;
|
2312
2508
|
hoverTooltip?: boolean | undefined;
|
2313
|
-
operation?: "self" | "router" | "
|
2509
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2314
2510
|
metadata?: {
|
2315
2511
|
[key: string]: unknown;
|
2316
2512
|
} | undefined;
|
2317
2513
|
}) | ({
|
2318
|
-
type: "
|
2514
|
+
type: "script";
|
2319
2515
|
value: string;
|
2320
2516
|
} & {} & {
|
2321
2517
|
commandType?: "object" | "help" | "independent" | undefined;
|
2322
2518
|
object?: string | undefined;
|
2323
2519
|
hoverTooltip?: boolean | undefined;
|
2324
|
-
operation?: "self" | "router" | "
|
2520
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2325
2521
|
metadata?: {
|
2326
2522
|
[key: string]: unknown;
|
2327
2523
|
} | undefined;
|
2328
2524
|
}) | ({
|
2329
|
-
type: "
|
2525
|
+
type: "video";
|
2330
2526
|
value: string;
|
2331
|
-
} & {
|
2332
|
-
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
2333
|
-
doc_metadata?: {
|
2334
|
-
content_type?: string | undefined;
|
2335
|
-
date?: string | undefined;
|
2336
|
-
} | undefined;
|
2337
|
-
} & {
|
2338
|
-
doc_type?: "answer" | "doc" | undefined;
|
2339
2527
|
} & {} & {
|
2340
2528
|
commandType?: "object" | "help" | "independent" | undefined;
|
2341
2529
|
object?: string | undefined;
|
2342
2530
|
hoverTooltip?: boolean | undefined;
|
2343
|
-
operation?: "self" | "router" | "
|
2531
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2344
2532
|
metadata?: {
|
2345
2533
|
[key: string]: unknown;
|
2346
2534
|
} | undefined;
|
2347
2535
|
}) | ({
|
2348
2536
|
type: "trigger";
|
2349
|
-
value: {
|
2537
|
+
value: ({
|
2538
|
+
type: "link";
|
2539
|
+
value: string;
|
2540
|
+
} & {
|
2541
|
+
operation?: "self" | "router" | "blank" | undefined;
|
2542
|
+
meta?: {
|
2543
|
+
command: string;
|
2544
|
+
} | undefined;
|
2545
|
+
}) | {
|
2546
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
2547
|
+
value: string[];
|
2548
|
+
} | {
|
2350
2549
|
type: "execute_command";
|
2351
2550
|
meta: {
|
2352
2551
|
command: string;
|
2353
2552
|
} & {
|
2354
2553
|
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
2355
2554
|
};
|
2555
|
+
} | {
|
2556
|
+
type: "no_action";
|
2356
2557
|
} | {
|
2357
2558
|
type: "click";
|
2358
2559
|
value: string;
|
2359
2560
|
} | {
|
2360
|
-
type: "click" | "clickBySelector" | "clickByXpath";
|
2361
|
-
value: string[];
|
2362
|
-
} | ({
|
2363
|
-
type: "link";
|
2364
|
-
value: string;
|
2365
|
-
} & {
|
2366
|
-
operation?: "self" | "router" | "blank" | undefined;
|
2367
|
-
}) | {
|
2368
2561
|
type: "open_chat";
|
2369
2562
|
meta: {
|
2370
|
-
type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "
|
2563
|
+
type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
|
2564
|
+
};
|
2565
|
+
} | {
|
2566
|
+
type: "chat_handoff";
|
2567
|
+
meta: {
|
2568
|
+
type: "" | "intercom" | "freshchat" | "zendesk";
|
2371
2569
|
};
|
2372
2570
|
} | {
|
2373
2571
|
type: "dismiss";
|
@@ -2376,14 +2574,14 @@ export declare const getCommandById: (orgUID: string, commandID: string) => Prom
|
|
2376
2574
|
} | {
|
2377
2575
|
type: "questlist";
|
2378
2576
|
value: number;
|
2379
|
-
} | {
|
2380
|
-
type: "step_back";
|
2381
2577
|
} | {
|
2382
2578
|
type: "nudge";
|
2383
2579
|
value: number;
|
2384
2580
|
} | {
|
2385
2581
|
type: "go_to_step";
|
2386
2582
|
value: number;
|
2583
|
+
} | {
|
2584
|
+
type: "step_back";
|
2387
2585
|
} | ({
|
2388
2586
|
type: "open_bar";
|
2389
2587
|
} & {
|
@@ -2391,16 +2589,16 @@ export declare const getCommandById: (orgUID: string, commandID: string) => Prom
|
|
2391
2589
|
categoryFilter?: number | undefined;
|
2392
2590
|
}) | {
|
2393
2591
|
type: "open_helphub";
|
2394
|
-
} | {
|
2592
|
+
} | ({
|
2395
2593
|
type: "open_copilot";
|
2396
|
-
}
|
2397
|
-
|
2398
|
-
};
|
2594
|
+
} & {
|
2595
|
+
query?: string | undefined;
|
2596
|
+
});
|
2399
2597
|
} & {} & {
|
2400
2598
|
commandType?: "object" | "help" | "independent" | undefined;
|
2401
2599
|
object?: string | undefined;
|
2402
2600
|
hoverTooltip?: boolean | undefined;
|
2403
|
-
operation?: "self" | "router" | "
|
2601
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2404
2602
|
metadata?: {
|
2405
2603
|
[key: string]: unknown;
|
2406
2604
|
} | undefined;
|
@@ -2493,8 +2691,8 @@ export declare const getCommandById: (orgUID: string, commandID: string) => Prom
|
|
2493
2691
|
};
|
2494
2692
|
tags: string[];
|
2495
2693
|
availability_rules: (({
|
2496
|
-
type: "url" | "element" | "amplitude" | "context" | "
|
2497
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
2694
|
+
type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
|
2695
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
2498
2696
|
} & {
|
2499
2697
|
field?: string | undefined;
|
2500
2698
|
value?: string | undefined;
|
@@ -2503,14 +2701,14 @@ export declare const getCommandById: (orgUID: string, commandID: string) => Prom
|
|
2503
2701
|
}) | ({
|
2504
2702
|
type: "nudge_interaction";
|
2505
2703
|
operator: "is" | "isNot";
|
2506
|
-
value: "completed" | "
|
2704
|
+
value: "completed" | "viewed" | "dismissed";
|
2507
2705
|
nudge_id: number;
|
2508
2706
|
} & {
|
2509
2707
|
reason?: string | undefined;
|
2510
2708
|
}) | ({
|
2511
2709
|
type: "questlist_interaction";
|
2512
2710
|
operator: "is" | "isNot";
|
2513
|
-
value: "completed" | "
|
2711
|
+
value: "completed" | "viewed" | "dismissed";
|
2514
2712
|
questlist_id: number;
|
2515
2713
|
} & {
|
2516
2714
|
reason?: string | undefined;
|
@@ -2521,13 +2719,8 @@ export declare const getCommandById: (orgUID: string, commandID: string) => Prom
|
|
2521
2719
|
} & {
|
2522
2720
|
reason?: string | undefined;
|
2523
2721
|
}))[] | (({
|
2524
|
-
type: "
|
2525
|
-
|
2526
|
-
} & {
|
2527
|
-
reason?: string | undefined;
|
2528
|
-
}) | ({
|
2529
|
-
type: "url" | "element" | "amplitude" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
|
2530
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
2722
|
+
type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
|
2723
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
2531
2724
|
} & {
|
2532
2725
|
field?: string | undefined;
|
2533
2726
|
value?: string | undefined;
|
@@ -2536,14 +2729,14 @@ export declare const getCommandById: (orgUID: string, commandID: string) => Prom
|
|
2536
2729
|
}) | ({
|
2537
2730
|
type: "nudge_interaction";
|
2538
2731
|
operator: "is" | "isNot";
|
2539
|
-
value: "completed" | "
|
2732
|
+
value: "completed" | "viewed" | "dismissed";
|
2540
2733
|
nudge_id: number;
|
2541
2734
|
} & {
|
2542
2735
|
reason?: string | undefined;
|
2543
2736
|
}) | ({
|
2544
2737
|
type: "questlist_interaction";
|
2545
2738
|
operator: "is" | "isNot";
|
2546
|
-
value: "completed" | "
|
2739
|
+
value: "completed" | "viewed" | "dismissed";
|
2547
2740
|
questlist_id: number;
|
2548
2741
|
} & {
|
2549
2742
|
reason?: string | undefined;
|
@@ -2553,10 +2746,15 @@ export declare const getCommandById: (orgUID: string, commandID: string) => Prom
|
|
2553
2746
|
values: string[];
|
2554
2747
|
} & {
|
2555
2748
|
reason?: string | undefined;
|
2749
|
+
}) | ({
|
2750
|
+
type: "named_rule";
|
2751
|
+
rule_id: string | number;
|
2752
|
+
} & {
|
2753
|
+
reason?: string | undefined;
|
2556
2754
|
}))[];
|
2557
2755
|
recommend_rules: (({
|
2558
|
-
type: "url" | "element" | "amplitude" | "context" | "
|
2559
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
2756
|
+
type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
|
2757
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
2560
2758
|
} & {
|
2561
2759
|
field?: string | undefined;
|
2562
2760
|
value?: string | undefined;
|
@@ -2565,14 +2763,14 @@ export declare const getCommandById: (orgUID: string, commandID: string) => Prom
|
|
2565
2763
|
}) | ({
|
2566
2764
|
type: "nudge_interaction";
|
2567
2765
|
operator: "is" | "isNot";
|
2568
|
-
value: "completed" | "
|
2766
|
+
value: "completed" | "viewed" | "dismissed";
|
2569
2767
|
nudge_id: number;
|
2570
2768
|
} & {
|
2571
2769
|
reason?: string | undefined;
|
2572
2770
|
}) | ({
|
2573
2771
|
type: "questlist_interaction";
|
2574
2772
|
operator: "is" | "isNot";
|
2575
|
-
value: "completed" | "
|
2773
|
+
value: "completed" | "viewed" | "dismissed";
|
2576
2774
|
questlist_id: number;
|
2577
2775
|
} & {
|
2578
2776
|
reason?: string | undefined;
|
@@ -2591,13 +2789,8 @@ export declare const getCommandById: (orgUID: string, commandID: string) => Prom
|
|
2591
2789
|
reason?: null | undefined;
|
2592
2790
|
rule_id?: string | number | undefined;
|
2593
2791
|
}))[] | (({
|
2594
|
-
type: "
|
2595
|
-
|
2596
|
-
} & {
|
2597
|
-
reason?: string | undefined;
|
2598
|
-
}) | ({
|
2599
|
-
type: "url" | "element" | "amplitude" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
|
2600
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
2792
|
+
type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
|
2793
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
2601
2794
|
} & {
|
2602
2795
|
field?: string | undefined;
|
2603
2796
|
value?: string | undefined;
|
@@ -2606,14 +2799,14 @@ export declare const getCommandById: (orgUID: string, commandID: string) => Prom
|
|
2606
2799
|
}) | ({
|
2607
2800
|
type: "nudge_interaction";
|
2608
2801
|
operator: "is" | "isNot";
|
2609
|
-
value: "completed" | "
|
2802
|
+
value: "completed" | "viewed" | "dismissed";
|
2610
2803
|
nudge_id: number;
|
2611
2804
|
} & {
|
2612
2805
|
reason?: string | undefined;
|
2613
2806
|
}) | ({
|
2614
2807
|
type: "questlist_interaction";
|
2615
2808
|
operator: "is" | "isNot";
|
2616
|
-
value: "completed" | "
|
2809
|
+
value: "completed" | "viewed" | "dismissed";
|
2617
2810
|
questlist_id: number;
|
2618
2811
|
} & {
|
2619
2812
|
reason?: string | undefined;
|
@@ -2631,6 +2824,11 @@ export declare const getCommandById: (orgUID: string, commandID: string) => Prom
|
|
2631
2824
|
value?: null | undefined;
|
2632
2825
|
reason?: null | undefined;
|
2633
2826
|
rule_id?: string | number | undefined;
|
2827
|
+
}) | ({
|
2828
|
+
type: "named_rule";
|
2829
|
+
rule_id: string | number;
|
2830
|
+
} & {
|
2831
|
+
reason?: string | undefined;
|
2634
2832
|
}))[];
|
2635
2833
|
availability_expression: import("./helpers/rules").RuleExpression;
|
2636
2834
|
recommend_expression: import("./helpers/rules").RuleExpression;
|
@@ -2666,23 +2864,23 @@ export declare const getCommandById: (orgUID: string, commandID: string) => Prom
|
|
2666
2864
|
hotkey_mac: string;
|
2667
2865
|
hotkey_win: string;
|
2668
2866
|
detail: string | ({
|
2669
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
2867
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
2670
2868
|
value: string;
|
2671
2869
|
} & {
|
2672
2870
|
position?: "inline" | "popover" | undefined;
|
2673
2871
|
}) | (string | ({
|
2674
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
2872
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
2675
2873
|
value: string;
|
2676
2874
|
} & {
|
2677
2875
|
position?: "inline" | "popover" | undefined;
|
2678
2876
|
}))[] | null;
|
2679
2877
|
content: string | ({
|
2680
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
2878
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
2681
2879
|
value: string;
|
2682
2880
|
} & {
|
2683
2881
|
position?: "inline" | "popover" | undefined;
|
2684
2882
|
}) | (string | ({
|
2685
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
2883
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
2686
2884
|
value: string;
|
2687
2885
|
} & {
|
2688
2886
|
position?: "inline" | "popover" | undefined;
|
@@ -2695,28 +2893,38 @@ export declare const getCommandById: (orgUID: string, commandID: string) => Prom
|
|
2695
2893
|
} | null;
|
2696
2894
|
next_steps: (string | number | {
|
2697
2895
|
cta: string;
|
2698
|
-
action: {
|
2896
|
+
action: ({
|
2897
|
+
type: "link";
|
2898
|
+
value: string;
|
2899
|
+
} & {
|
2900
|
+
operation?: "self" | "router" | "blank" | undefined;
|
2901
|
+
meta?: {
|
2902
|
+
command: string;
|
2903
|
+
} | undefined;
|
2904
|
+
}) | {
|
2905
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
2906
|
+
value: string[];
|
2907
|
+
} | {
|
2699
2908
|
type: "execute_command";
|
2700
2909
|
meta: {
|
2701
2910
|
command: string;
|
2702
2911
|
} & {
|
2703
2912
|
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
2704
2913
|
};
|
2914
|
+
} | {
|
2915
|
+
type: "no_action";
|
2705
2916
|
} | {
|
2706
2917
|
type: "click";
|
2707
2918
|
value: string;
|
2708
2919
|
} | {
|
2709
|
-
type: "click" | "clickBySelector" | "clickByXpath";
|
2710
|
-
value: string[];
|
2711
|
-
} | ({
|
2712
|
-
type: "link";
|
2713
|
-
value: string;
|
2714
|
-
} & {
|
2715
|
-
operation?: "self" | "router" | "blank" | undefined;
|
2716
|
-
}) | {
|
2717
2920
|
type: "open_chat";
|
2718
2921
|
meta: {
|
2719
|
-
type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "
|
2922
|
+
type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
|
2923
|
+
};
|
2924
|
+
} | {
|
2925
|
+
type: "chat_handoff";
|
2926
|
+
meta: {
|
2927
|
+
type: "" | "intercom" | "freshchat" | "zendesk";
|
2720
2928
|
};
|
2721
2929
|
} | {
|
2722
2930
|
type: "dismiss";
|
@@ -2725,14 +2933,14 @@ export declare const getCommandById: (orgUID: string, commandID: string) => Prom
|
|
2725
2933
|
} | {
|
2726
2934
|
type: "questlist";
|
2727
2935
|
value: number;
|
2728
|
-
} | {
|
2729
|
-
type: "step_back";
|
2730
2936
|
} | {
|
2731
2937
|
type: "nudge";
|
2732
2938
|
value: number;
|
2733
2939
|
} | {
|
2734
2940
|
type: "go_to_step";
|
2735
2941
|
value: number;
|
2942
|
+
} | {
|
2943
|
+
type: "step_back";
|
2736
2944
|
} | ({
|
2737
2945
|
type: "open_bar";
|
2738
2946
|
} & {
|
@@ -2740,11 +2948,11 @@ export declare const getCommandById: (orgUID: string, commandID: string) => Prom
|
|
2740
2948
|
categoryFilter?: number | undefined;
|
2741
2949
|
}) | {
|
2742
2950
|
type: "open_helphub";
|
2743
|
-
} | {
|
2951
|
+
} | ({
|
2744
2952
|
type: "open_copilot";
|
2745
|
-
}
|
2746
|
-
|
2747
|
-
};
|
2953
|
+
} & {
|
2954
|
+
query?: string | undefined;
|
2955
|
+
});
|
2748
2956
|
})[];
|
2749
2957
|
generated_tags: {
|
2750
2958
|
automated?: string[] | null | undefined;
|
@@ -2758,6 +2966,7 @@ export declare const getCommandById: (orgUID: string, commandID: string) => Prom
|
|
2758
2966
|
copilot_description: string;
|
2759
2967
|
copilot_use_verbatim: boolean;
|
2760
2968
|
editor_tags: string[];
|
2969
|
+
labels: string[] | null;
|
2761
2970
|
} & {
|
2762
2971
|
third_party_source?: string | null | undefined;
|
2763
2972
|
third_party_id?: string | null | undefined;
|
@@ -2785,37 +2994,40 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
2785
2994
|
id: number;
|
2786
2995
|
text: string;
|
2787
2996
|
template: ({
|
2788
|
-
type: "
|
2997
|
+
type: "callback";
|
2789
2998
|
value: string;
|
2790
2999
|
} & {} & {
|
2791
3000
|
commandType?: "object" | "help" | "independent" | undefined;
|
2792
3001
|
object?: string | undefined;
|
2793
3002
|
hoverTooltip?: boolean | undefined;
|
2794
|
-
operation?: "self" | "router" | "
|
3003
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2795
3004
|
metadata?: {
|
2796
3005
|
[key: string]: unknown;
|
2797
3006
|
} | undefined;
|
2798
3007
|
}) | ({
|
2799
|
-
type: "
|
3008
|
+
type: "link";
|
2800
3009
|
value: string;
|
3010
|
+
} & {
|
3011
|
+
operation?: "self" | "router" | "blank" | undefined;
|
3012
|
+
meta?: {
|
3013
|
+
command: string;
|
3014
|
+
} | undefined;
|
2801
3015
|
} & {} & {
|
2802
3016
|
commandType?: "object" | "help" | "independent" | undefined;
|
2803
3017
|
object?: string | undefined;
|
2804
3018
|
hoverTooltip?: boolean | undefined;
|
2805
|
-
operation?: "self" | "router" | "
|
3019
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2806
3020
|
metadata?: {
|
2807
3021
|
[key: string]: unknown;
|
2808
3022
|
} | undefined;
|
2809
3023
|
}) | ({
|
2810
|
-
type: "
|
3024
|
+
type: "webhook";
|
2811
3025
|
value: string;
|
2812
|
-
} & {
|
2813
|
-
operation?: "self" | "router" | "blank" | undefined;
|
2814
3026
|
} & {} & {
|
2815
3027
|
commandType?: "object" | "help" | "independent" | undefined;
|
2816
3028
|
object?: string | undefined;
|
2817
3029
|
hoverTooltip?: boolean | undefined;
|
2818
|
-
operation?: "self" | "router" | "
|
3030
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2819
3031
|
metadata?: {
|
2820
3032
|
[key: string]: unknown;
|
2821
3033
|
} | undefined;
|
@@ -2826,143 +3038,153 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
2826
3038
|
commandType?: "object" | "help" | "independent" | undefined;
|
2827
3039
|
object?: string | undefined;
|
2828
3040
|
hoverTooltip?: boolean | undefined;
|
2829
|
-
operation?: "self" | "router" | "
|
3041
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2830
3042
|
metadata?: {
|
2831
3043
|
[key: string]: unknown;
|
2832
3044
|
} | undefined;
|
2833
3045
|
}) | ({
|
2834
|
-
type: "
|
2835
|
-
value:
|
3046
|
+
type: "request";
|
3047
|
+
value: {
|
3048
|
+
method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
|
3049
|
+
url: string;
|
3050
|
+
} & {
|
3051
|
+
headers?: {
|
3052
|
+
[key: string]: unknown;
|
3053
|
+
} | undefined;
|
3054
|
+
body?: {
|
3055
|
+
[key: string]: unknown;
|
3056
|
+
} | undefined;
|
3057
|
+
onSend?: string | undefined;
|
3058
|
+
onSuccess?: string | undefined;
|
3059
|
+
onError?: string | undefined;
|
3060
|
+
};
|
2836
3061
|
} & {} & {
|
2837
3062
|
commandType?: "object" | "help" | "independent" | undefined;
|
2838
3063
|
object?: string | undefined;
|
2839
3064
|
hoverTooltip?: boolean | undefined;
|
2840
|
-
operation?: "self" | "router" | "
|
3065
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2841
3066
|
metadata?: {
|
2842
3067
|
[key: string]: unknown;
|
2843
3068
|
} | undefined;
|
2844
3069
|
}) | ({
|
2845
|
-
type: "
|
3070
|
+
type: "appcues";
|
2846
3071
|
value: string;
|
2847
3072
|
} & {} & {
|
2848
3073
|
commandType?: "object" | "help" | "independent" | undefined;
|
2849
3074
|
object?: string | undefined;
|
2850
3075
|
hoverTooltip?: boolean | undefined;
|
2851
|
-
operation?: "self" | "router" | "
|
3076
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2852
3077
|
metadata?: {
|
2853
3078
|
[key: string]: unknown;
|
2854
3079
|
} | undefined;
|
2855
3080
|
}) | ({
|
2856
|
-
type: "
|
3081
|
+
type: "pendo_guide";
|
2857
3082
|
value: string;
|
2858
3083
|
} & {} & {
|
2859
3084
|
commandType?: "object" | "help" | "independent" | undefined;
|
2860
3085
|
object?: string | undefined;
|
2861
3086
|
hoverTooltip?: boolean | undefined;
|
2862
|
-
operation?: "self" | "router" | "
|
3087
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2863
3088
|
metadata?: {
|
2864
3089
|
[key: string]: unknown;
|
2865
3090
|
} | undefined;
|
2866
3091
|
}) | ({
|
2867
|
-
type: "
|
2868
|
-
value:
|
2869
|
-
|
2870
|
-
|
2871
|
-
|
2872
|
-
|
2873
|
-
|
2874
|
-
|
2875
|
-
|
2876
|
-
|
2877
|
-
} | undefined;
|
2878
|
-
onSend?: string | undefined;
|
2879
|
-
onSuccess?: string | undefined;
|
2880
|
-
onError?: string | undefined;
|
2881
|
-
};
|
3092
|
+
type: "helpdoc";
|
3093
|
+
value: string;
|
3094
|
+
} & {
|
3095
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
3096
|
+
doc_metadata?: {
|
3097
|
+
content_type?: string | undefined;
|
3098
|
+
date?: string | undefined;
|
3099
|
+
} | undefined;
|
3100
|
+
} & {
|
3101
|
+
doc_type?: "answer" | "doc" | undefined;
|
2882
3102
|
} & {} & {
|
2883
3103
|
commandType?: "object" | "help" | "independent" | undefined;
|
2884
3104
|
object?: string | undefined;
|
2885
3105
|
hoverTooltip?: boolean | undefined;
|
2886
|
-
operation?: "self" | "router" | "
|
3106
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2887
3107
|
metadata?: {
|
2888
3108
|
[key: string]: unknown;
|
2889
3109
|
} | undefined;
|
2890
3110
|
}) | ({
|
2891
|
-
type: "
|
3111
|
+
type: "admin";
|
2892
3112
|
value: string;
|
2893
3113
|
} & {} & {
|
2894
3114
|
commandType?: "object" | "help" | "independent" | undefined;
|
2895
3115
|
object?: string | undefined;
|
2896
3116
|
hoverTooltip?: boolean | undefined;
|
2897
|
-
operation?: "self" | "router" | "
|
3117
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2898
3118
|
metadata?: {
|
2899
3119
|
[key: string]: unknown;
|
2900
3120
|
} | undefined;
|
2901
3121
|
}) | ({
|
2902
|
-
type: "
|
3122
|
+
type: "builtin";
|
2903
3123
|
value: string;
|
2904
3124
|
} & {} & {
|
2905
3125
|
commandType?: "object" | "help" | "independent" | undefined;
|
2906
3126
|
object?: string | undefined;
|
2907
3127
|
hoverTooltip?: boolean | undefined;
|
2908
|
-
operation?: "self" | "router" | "
|
3128
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2909
3129
|
metadata?: {
|
2910
3130
|
[key: string]: unknown;
|
2911
3131
|
} | undefined;
|
2912
3132
|
}) | ({
|
2913
|
-
type: "
|
3133
|
+
type: "script";
|
2914
3134
|
value: string;
|
2915
3135
|
} & {} & {
|
2916
3136
|
commandType?: "object" | "help" | "independent" | undefined;
|
2917
3137
|
object?: string | undefined;
|
2918
3138
|
hoverTooltip?: boolean | undefined;
|
2919
|
-
operation?: "self" | "router" | "
|
3139
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2920
3140
|
metadata?: {
|
2921
3141
|
[key: string]: unknown;
|
2922
3142
|
} | undefined;
|
2923
3143
|
}) | ({
|
2924
|
-
type: "
|
3144
|
+
type: "video";
|
2925
3145
|
value: string;
|
2926
|
-
} & {
|
2927
|
-
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
2928
|
-
doc_metadata?: {
|
2929
|
-
content_type?: string | undefined;
|
2930
|
-
date?: string | undefined;
|
2931
|
-
} | undefined;
|
2932
|
-
} & {
|
2933
|
-
doc_type?: "answer" | "doc" | undefined;
|
2934
3146
|
} & {} & {
|
2935
3147
|
commandType?: "object" | "help" | "independent" | undefined;
|
2936
3148
|
object?: string | undefined;
|
2937
3149
|
hoverTooltip?: boolean | undefined;
|
2938
|
-
operation?: "self" | "router" | "
|
3150
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2939
3151
|
metadata?: {
|
2940
3152
|
[key: string]: unknown;
|
2941
3153
|
} | undefined;
|
2942
3154
|
}) | ({
|
2943
3155
|
type: "trigger";
|
2944
|
-
value: {
|
3156
|
+
value: ({
|
3157
|
+
type: "link";
|
3158
|
+
value: string;
|
3159
|
+
} & {
|
3160
|
+
operation?: "self" | "router" | "blank" | undefined;
|
3161
|
+
meta?: {
|
3162
|
+
command: string;
|
3163
|
+
} | undefined;
|
3164
|
+
}) | {
|
3165
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
3166
|
+
value: string[];
|
3167
|
+
} | {
|
2945
3168
|
type: "execute_command";
|
2946
3169
|
meta: {
|
2947
3170
|
command: string;
|
2948
3171
|
} & {
|
2949
3172
|
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
2950
3173
|
};
|
3174
|
+
} | {
|
3175
|
+
type: "no_action";
|
2951
3176
|
} | {
|
2952
3177
|
type: "click";
|
2953
3178
|
value: string;
|
2954
3179
|
} | {
|
2955
|
-
type: "click" | "clickBySelector" | "clickByXpath";
|
2956
|
-
value: string[];
|
2957
|
-
} | ({
|
2958
|
-
type: "link";
|
2959
|
-
value: string;
|
2960
|
-
} & {
|
2961
|
-
operation?: "self" | "router" | "blank" | undefined;
|
2962
|
-
}) | {
|
2963
3180
|
type: "open_chat";
|
2964
3181
|
meta: {
|
2965
|
-
type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "
|
3182
|
+
type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
|
3183
|
+
};
|
3184
|
+
} | {
|
3185
|
+
type: "chat_handoff";
|
3186
|
+
meta: {
|
3187
|
+
type: "" | "intercom" | "freshchat" | "zendesk";
|
2966
3188
|
};
|
2967
3189
|
} | {
|
2968
3190
|
type: "dismiss";
|
@@ -2971,14 +3193,14 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
2971
3193
|
} | {
|
2972
3194
|
type: "questlist";
|
2973
3195
|
value: number;
|
2974
|
-
} | {
|
2975
|
-
type: "step_back";
|
2976
3196
|
} | {
|
2977
3197
|
type: "nudge";
|
2978
3198
|
value: number;
|
2979
3199
|
} | {
|
2980
3200
|
type: "go_to_step";
|
2981
3201
|
value: number;
|
3202
|
+
} | {
|
3203
|
+
type: "step_back";
|
2982
3204
|
} | ({
|
2983
3205
|
type: "open_bar";
|
2984
3206
|
} & {
|
@@ -2986,16 +3208,16 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
2986
3208
|
categoryFilter?: number | undefined;
|
2987
3209
|
}) | {
|
2988
3210
|
type: "open_helphub";
|
2989
|
-
} | {
|
3211
|
+
} | ({
|
2990
3212
|
type: "open_copilot";
|
2991
|
-
}
|
2992
|
-
|
2993
|
-
};
|
3213
|
+
} & {
|
3214
|
+
query?: string | undefined;
|
3215
|
+
});
|
2994
3216
|
} & {} & {
|
2995
3217
|
commandType?: "object" | "help" | "independent" | undefined;
|
2996
3218
|
object?: string | undefined;
|
2997
3219
|
hoverTooltip?: boolean | undefined;
|
2998
|
-
operation?: "self" | "router" | "
|
3220
|
+
operation?: "self" | "router" | "help_hub" | "blank" | undefined;
|
2999
3221
|
metadata?: {
|
3000
3222
|
[key: string]: unknown;
|
3001
3223
|
} | undefined;
|
@@ -3088,8 +3310,8 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
3088
3310
|
};
|
3089
3311
|
tags: string[];
|
3090
3312
|
availability_rules: (({
|
3091
|
-
type: "url" | "element" | "amplitude" | "context" | "
|
3092
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
3313
|
+
type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
|
3314
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
3093
3315
|
} & {
|
3094
3316
|
field?: string | undefined;
|
3095
3317
|
value?: string | undefined;
|
@@ -3098,14 +3320,14 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
3098
3320
|
}) | ({
|
3099
3321
|
type: "nudge_interaction";
|
3100
3322
|
operator: "is" | "isNot";
|
3101
|
-
value: "completed" | "
|
3323
|
+
value: "completed" | "viewed" | "dismissed";
|
3102
3324
|
nudge_id: number;
|
3103
3325
|
} & {
|
3104
3326
|
reason?: string | undefined;
|
3105
3327
|
}) | ({
|
3106
3328
|
type: "questlist_interaction";
|
3107
3329
|
operator: "is" | "isNot";
|
3108
|
-
value: "completed" | "
|
3330
|
+
value: "completed" | "viewed" | "dismissed";
|
3109
3331
|
questlist_id: number;
|
3110
3332
|
} & {
|
3111
3333
|
reason?: string | undefined;
|
@@ -3116,13 +3338,8 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
3116
3338
|
} & {
|
3117
3339
|
reason?: string | undefined;
|
3118
3340
|
}))[] | (({
|
3119
|
-
type: "
|
3120
|
-
|
3121
|
-
} & {
|
3122
|
-
reason?: string | undefined;
|
3123
|
-
}) | ({
|
3124
|
-
type: "url" | "element" | "amplitude" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
|
3125
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
3341
|
+
type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
|
3342
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
3126
3343
|
} & {
|
3127
3344
|
field?: string | undefined;
|
3128
3345
|
value?: string | undefined;
|
@@ -3131,14 +3348,14 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
3131
3348
|
}) | ({
|
3132
3349
|
type: "nudge_interaction";
|
3133
3350
|
operator: "is" | "isNot";
|
3134
|
-
value: "completed" | "
|
3351
|
+
value: "completed" | "viewed" | "dismissed";
|
3135
3352
|
nudge_id: number;
|
3136
3353
|
} & {
|
3137
3354
|
reason?: string | undefined;
|
3138
3355
|
}) | ({
|
3139
3356
|
type: "questlist_interaction";
|
3140
3357
|
operator: "is" | "isNot";
|
3141
|
-
value: "completed" | "
|
3358
|
+
value: "completed" | "viewed" | "dismissed";
|
3142
3359
|
questlist_id: number;
|
3143
3360
|
} & {
|
3144
3361
|
reason?: string | undefined;
|
@@ -3148,10 +3365,15 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
3148
3365
|
values: string[];
|
3149
3366
|
} & {
|
3150
3367
|
reason?: string | undefined;
|
3368
|
+
}) | ({
|
3369
|
+
type: "named_rule";
|
3370
|
+
rule_id: string | number;
|
3371
|
+
} & {
|
3372
|
+
reason?: string | undefined;
|
3151
3373
|
}))[];
|
3152
3374
|
recommend_rules: (({
|
3153
|
-
type: "url" | "element" | "amplitude" | "context" | "
|
3154
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
3375
|
+
type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
|
3376
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
3155
3377
|
} & {
|
3156
3378
|
field?: string | undefined;
|
3157
3379
|
value?: string | undefined;
|
@@ -3160,14 +3382,14 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
3160
3382
|
}) | ({
|
3161
3383
|
type: "nudge_interaction";
|
3162
3384
|
operator: "is" | "isNot";
|
3163
|
-
value: "completed" | "
|
3385
|
+
value: "completed" | "viewed" | "dismissed";
|
3164
3386
|
nudge_id: number;
|
3165
3387
|
} & {
|
3166
3388
|
reason?: string | undefined;
|
3167
3389
|
}) | ({
|
3168
3390
|
type: "questlist_interaction";
|
3169
3391
|
operator: "is" | "isNot";
|
3170
|
-
value: "completed" | "
|
3392
|
+
value: "completed" | "viewed" | "dismissed";
|
3171
3393
|
questlist_id: number;
|
3172
3394
|
} & {
|
3173
3395
|
reason?: string | undefined;
|
@@ -3186,13 +3408,8 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
3186
3408
|
reason?: null | undefined;
|
3187
3409
|
rule_id?: string | number | undefined;
|
3188
3410
|
}))[] | (({
|
3189
|
-
type: "
|
3190
|
-
|
3191
|
-
} & {
|
3192
|
-
reason?: string | undefined;
|
3193
|
-
}) | ({
|
3194
|
-
type: "url" | "element" | "amplitude" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
|
3195
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
3411
|
+
type: "url" | "element" | "amplitude" | "context" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends" | "heap" | "hubspot" | "device_type" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction" | "survey_response";
|
3412
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isInList" | "isNotInList" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
3196
3413
|
} & {
|
3197
3414
|
field?: string | undefined;
|
3198
3415
|
value?: string | undefined;
|
@@ -3201,14 +3418,14 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
3201
3418
|
}) | ({
|
3202
3419
|
type: "nudge_interaction";
|
3203
3420
|
operator: "is" | "isNot";
|
3204
|
-
value: "completed" | "
|
3421
|
+
value: "completed" | "viewed" | "dismissed";
|
3205
3422
|
nudge_id: number;
|
3206
3423
|
} & {
|
3207
3424
|
reason?: string | undefined;
|
3208
3425
|
}) | ({
|
3209
3426
|
type: "questlist_interaction";
|
3210
3427
|
operator: "is" | "isNot";
|
3211
|
-
value: "completed" | "
|
3428
|
+
value: "completed" | "viewed" | "dismissed";
|
3212
3429
|
questlist_id: number;
|
3213
3430
|
} & {
|
3214
3431
|
reason?: string | undefined;
|
@@ -3226,6 +3443,11 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
3226
3443
|
value?: null | undefined;
|
3227
3444
|
reason?: null | undefined;
|
3228
3445
|
rule_id?: string | number | undefined;
|
3446
|
+
}) | ({
|
3447
|
+
type: "named_rule";
|
3448
|
+
rule_id: string | number;
|
3449
|
+
} & {
|
3450
|
+
reason?: string | undefined;
|
3229
3451
|
}))[];
|
3230
3452
|
availability_expression: import("./helpers/rules").RuleExpression;
|
3231
3453
|
recommend_expression: import("./helpers/rules").RuleExpression;
|
@@ -3261,23 +3483,23 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
3261
3483
|
hotkey_mac: string;
|
3262
3484
|
hotkey_win: string;
|
3263
3485
|
detail: string | ({
|
3264
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
3486
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
3265
3487
|
value: string;
|
3266
3488
|
} & {
|
3267
3489
|
position?: "inline" | "popover" | undefined;
|
3268
3490
|
}) | (string | ({
|
3269
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
3491
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
3270
3492
|
value: string;
|
3271
3493
|
} & {
|
3272
3494
|
position?: "inline" | "popover" | undefined;
|
3273
3495
|
}))[] | null;
|
3274
3496
|
content: string | ({
|
3275
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
3497
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
3276
3498
|
value: string;
|
3277
3499
|
} & {
|
3278
3500
|
position?: "inline" | "popover" | undefined;
|
3279
3501
|
}) | (string | ({
|
3280
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
3502
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
3281
3503
|
value: string;
|
3282
3504
|
} & {
|
3283
3505
|
position?: "inline" | "popover" | undefined;
|
@@ -3290,28 +3512,38 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
3290
3512
|
} | null;
|
3291
3513
|
next_steps: (string | number | {
|
3292
3514
|
cta: string;
|
3293
|
-
action: {
|
3515
|
+
action: ({
|
3516
|
+
type: "link";
|
3517
|
+
value: string;
|
3518
|
+
} & {
|
3519
|
+
operation?: "self" | "router" | "blank" | undefined;
|
3520
|
+
meta?: {
|
3521
|
+
command: string;
|
3522
|
+
} | undefined;
|
3523
|
+
}) | {
|
3524
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
3525
|
+
value: string[];
|
3526
|
+
} | {
|
3294
3527
|
type: "execute_command";
|
3295
3528
|
meta: {
|
3296
3529
|
command: string;
|
3297
3530
|
} & {
|
3298
3531
|
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
3299
3532
|
};
|
3533
|
+
} | {
|
3534
|
+
type: "no_action";
|
3300
3535
|
} | {
|
3301
3536
|
type: "click";
|
3302
3537
|
value: string;
|
3303
3538
|
} | {
|
3304
|
-
type: "click" | "clickBySelector" | "clickByXpath";
|
3305
|
-
value: string[];
|
3306
|
-
} | ({
|
3307
|
-
type: "link";
|
3308
|
-
value: string;
|
3309
|
-
} & {
|
3310
|
-
operation?: "self" | "router" | "blank" | undefined;
|
3311
|
-
}) | {
|
3312
3539
|
type: "open_chat";
|
3313
3540
|
meta: {
|
3314
|
-
type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "
|
3541
|
+
type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
|
3542
|
+
};
|
3543
|
+
} | {
|
3544
|
+
type: "chat_handoff";
|
3545
|
+
meta: {
|
3546
|
+
type: "" | "intercom" | "freshchat" | "zendesk";
|
3315
3547
|
};
|
3316
3548
|
} | {
|
3317
3549
|
type: "dismiss";
|
@@ -3320,14 +3552,14 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
3320
3552
|
} | {
|
3321
3553
|
type: "questlist";
|
3322
3554
|
value: number;
|
3323
|
-
} | {
|
3324
|
-
type: "step_back";
|
3325
3555
|
} | {
|
3326
3556
|
type: "nudge";
|
3327
3557
|
value: number;
|
3328
3558
|
} | {
|
3329
3559
|
type: "go_to_step";
|
3330
3560
|
value: number;
|
3561
|
+
} | {
|
3562
|
+
type: "step_back";
|
3331
3563
|
} | ({
|
3332
3564
|
type: "open_bar";
|
3333
3565
|
} & {
|
@@ -3335,11 +3567,11 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
3335
3567
|
categoryFilter?: number | undefined;
|
3336
3568
|
}) | {
|
3337
3569
|
type: "open_helphub";
|
3338
|
-
} | {
|
3570
|
+
} | ({
|
3339
3571
|
type: "open_copilot";
|
3340
|
-
}
|
3341
|
-
|
3342
|
-
};
|
3572
|
+
} & {
|
3573
|
+
query?: string | undefined;
|
3574
|
+
});
|
3343
3575
|
})[];
|
3344
3576
|
generated_tags: {
|
3345
3577
|
automated?: string[] | null | undefined;
|
@@ -3353,6 +3585,7 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
3353
3585
|
copilot_description: string;
|
3354
3586
|
copilot_use_verbatim: boolean;
|
3355
3587
|
editor_tags: string[];
|
3588
|
+
labels: string[] | null;
|
3356
3589
|
} & {
|
3357
3590
|
third_party_source?: string | null | undefined;
|
3358
3591
|
third_party_id?: string | null | undefined;
|
@@ -3465,7 +3698,7 @@ export declare const decode: (data: any) => {
|
|
3465
3698
|
} & {} & {
|
3466
3699
|
disabled: boolean;
|
3467
3700
|
launcher_type: "alternate" | "none" | "prompt" | "minimal";
|
3468
|
-
launcher_position: "
|
3701
|
+
launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
3469
3702
|
show_launcher_recommendations: boolean;
|
3470
3703
|
recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
|
3471
3704
|
launcher_offset_x: number;
|
@@ -3545,23 +3778,23 @@ export declare const decode: (data: any) => {
|
|
3545
3778
|
setting_pin_to_bottom?: boolean | undefined;
|
3546
3779
|
track_recents?: boolean | undefined;
|
3547
3780
|
detail?: string | ({
|
3548
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
3781
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
3549
3782
|
value: string;
|
3550
3783
|
} & {
|
3551
3784
|
position?: "inline" | "popover" | undefined;
|
3552
3785
|
}) | (string | ({
|
3553
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
3786
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
3554
3787
|
value: string;
|
3555
3788
|
} & {
|
3556
3789
|
position?: "inline" | "popover" | undefined;
|
3557
3790
|
}))[] | null | undefined;
|
3558
3791
|
content?: string | ({
|
3559
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
3792
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
3560
3793
|
value: string;
|
3561
3794
|
} & {
|
3562
3795
|
position?: "inline" | "popover" | undefined;
|
3563
3796
|
}) | (string | ({
|
3564
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
3797
|
+
type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
|
3565
3798
|
value: string;
|
3566
3799
|
} & {
|
3567
3800
|
position?: "inline" | "popover" | undefined;
|
@@ -3609,28 +3842,38 @@ export declare const decode: (data: any) => {
|
|
3609
3842
|
helphub_chat_fallback_message: string | null;
|
3610
3843
|
helphub_chat_fallback_actions: {
|
3611
3844
|
cta: string;
|
3612
|
-
action: {
|
3845
|
+
action: ({
|
3846
|
+
type: "link";
|
3847
|
+
value: string;
|
3848
|
+
} & {
|
3849
|
+
operation?: "self" | "router" | "blank" | undefined;
|
3850
|
+
meta?: {
|
3851
|
+
command: string;
|
3852
|
+
} | undefined;
|
3853
|
+
}) | {
|
3854
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
3855
|
+
value: string[];
|
3856
|
+
} | {
|
3613
3857
|
type: "execute_command";
|
3614
3858
|
meta: {
|
3615
3859
|
command: string;
|
3616
3860
|
} & {
|
3617
3861
|
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
3618
3862
|
};
|
3863
|
+
} | {
|
3864
|
+
type: "no_action";
|
3619
3865
|
} | {
|
3620
3866
|
type: "click";
|
3621
3867
|
value: string;
|
3622
3868
|
} | {
|
3623
|
-
type: "click" | "clickBySelector" | "clickByXpath";
|
3624
|
-
value: string[];
|
3625
|
-
} | ({
|
3626
|
-
type: "link";
|
3627
|
-
value: string;
|
3628
|
-
} & {
|
3629
|
-
operation?: "self" | "router" | "blank" | undefined;
|
3630
|
-
}) | {
|
3631
3869
|
type: "open_chat";
|
3632
3870
|
meta: {
|
3633
|
-
type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "
|
3871
|
+
type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
|
3872
|
+
};
|
3873
|
+
} | {
|
3874
|
+
type: "chat_handoff";
|
3875
|
+
meta: {
|
3876
|
+
type: "" | "intercom" | "freshchat" | "zendesk";
|
3634
3877
|
};
|
3635
3878
|
} | {
|
3636
3879
|
type: "dismiss";
|
@@ -3639,14 +3882,14 @@ export declare const decode: (data: any) => {
|
|
3639
3882
|
} | {
|
3640
3883
|
type: "questlist";
|
3641
3884
|
value: number;
|
3642
|
-
} | {
|
3643
|
-
type: "step_back";
|
3644
3885
|
} | {
|
3645
3886
|
type: "nudge";
|
3646
3887
|
value: number;
|
3647
3888
|
} | {
|
3648
3889
|
type: "go_to_step";
|
3649
3890
|
value: number;
|
3891
|
+
} | {
|
3892
|
+
type: "step_back";
|
3650
3893
|
} | ({
|
3651
3894
|
type: "open_bar";
|
3652
3895
|
} & {
|
@@ -3654,39 +3897,51 @@ export declare const decode: (data: any) => {
|
|
3654
3897
|
categoryFilter?: number | undefined;
|
3655
3898
|
}) | {
|
3656
3899
|
type: "open_helphub";
|
3657
|
-
} | {
|
3900
|
+
} | ({
|
3658
3901
|
type: "open_copilot";
|
3659
|
-
}
|
3660
|
-
|
3661
|
-
};
|
3902
|
+
} & {
|
3903
|
+
query?: string | undefined;
|
3904
|
+
});
|
3662
3905
|
}[];
|
3663
3906
|
helphub_search_action: "search" | "ask";
|
3907
|
+
helphub_custom_theme: string | null;
|
3908
|
+
copilot_chat_history_enabled: boolean;
|
3664
3909
|
copilot_negative_feedback_fallback_enabled: boolean;
|
3665
3910
|
copilot_negative_feedback_fallback_message: string | null;
|
3666
3911
|
copilot_negative_feedback_fallback_actions: {
|
3667
3912
|
cta: string;
|
3668
|
-
action: {
|
3913
|
+
action: ({
|
3914
|
+
type: "link";
|
3915
|
+
value: string;
|
3916
|
+
} & {
|
3917
|
+
operation?: "self" | "router" | "blank" | undefined;
|
3918
|
+
meta?: {
|
3919
|
+
command: string;
|
3920
|
+
} | undefined;
|
3921
|
+
}) | {
|
3922
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
3923
|
+
value: string[];
|
3924
|
+
} | {
|
3669
3925
|
type: "execute_command";
|
3670
3926
|
meta: {
|
3671
3927
|
command: string;
|
3672
3928
|
} & {
|
3673
3929
|
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
3674
3930
|
};
|
3931
|
+
} | {
|
3932
|
+
type: "no_action";
|
3675
3933
|
} | {
|
3676
3934
|
type: "click";
|
3677
3935
|
value: string;
|
3678
3936
|
} | {
|
3679
|
-
type: "click" | "clickBySelector" | "clickByXpath";
|
3680
|
-
value: string[];
|
3681
|
-
} | ({
|
3682
|
-
type: "link";
|
3683
|
-
value: string;
|
3684
|
-
} & {
|
3685
|
-
operation?: "self" | "router" | "blank" | undefined;
|
3686
|
-
}) | {
|
3687
3937
|
type: "open_chat";
|
3688
3938
|
meta: {
|
3689
|
-
type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "
|
3939
|
+
type: "" | "hubspot" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "drift" | "pylon" | "zendesk_handoff";
|
3940
|
+
};
|
3941
|
+
} | {
|
3942
|
+
type: "chat_handoff";
|
3943
|
+
meta: {
|
3944
|
+
type: "" | "intercom" | "freshchat" | "zendesk";
|
3690
3945
|
};
|
3691
3946
|
} | {
|
3692
3947
|
type: "dismiss";
|
@@ -3695,14 +3950,14 @@ export declare const decode: (data: any) => {
|
|
3695
3950
|
} | {
|
3696
3951
|
type: "questlist";
|
3697
3952
|
value: number;
|
3698
|
-
} | {
|
3699
|
-
type: "step_back";
|
3700
3953
|
} | {
|
3701
3954
|
type: "nudge";
|
3702
3955
|
value: number;
|
3703
3956
|
} | {
|
3704
3957
|
type: "go_to_step";
|
3705
3958
|
value: number;
|
3959
|
+
} | {
|
3960
|
+
type: "step_back";
|
3706
3961
|
} | ({
|
3707
3962
|
type: "open_bar";
|
3708
3963
|
} & {
|
@@ -3710,15 +3965,20 @@ export declare const decode: (data: any) => {
|
|
3710
3965
|
categoryFilter?: number | undefined;
|
3711
3966
|
}) | {
|
3712
3967
|
type: "open_helphub";
|
3713
|
-
} | {
|
3968
|
+
} | ({
|
3714
3969
|
type: "open_copilot";
|
3715
|
-
}
|
3716
|
-
|
3717
|
-
};
|
3970
|
+
} & {
|
3971
|
+
query?: string | undefined;
|
3972
|
+
});
|
3718
3973
|
}[];
|
3719
3974
|
helphub_manual_suggested_queries: string[];
|
3720
3975
|
copilot_name: string;
|
3721
3976
|
copilot_avatar: string;
|
3977
|
+
copilot_avatar_v2: {
|
3978
|
+
src: string;
|
3979
|
+
file_name: string;
|
3980
|
+
size: string;
|
3981
|
+
} | null;
|
3722
3982
|
copilot_personality: {
|
3723
3983
|
template: "professional" | "friendly" | "confident" | "serious" | "empathetic";
|
3724
3984
|
} | {
|
@@ -3793,12 +4053,31 @@ export declare const decode: (data: any) => {
|
|
3793
4053
|
topic_name?: string | null | undefined;
|
3794
4054
|
conversation_property_name?: string | null | undefined;
|
3795
4055
|
} | undefined;
|
4056
|
+
intercom?: {
|
4057
|
+
enabled?: boolean | undefined;
|
4058
|
+
token?: string | undefined;
|
4059
|
+
} | undefined;
|
3796
4060
|
};
|
3797
4061
|
copilot_enabled: boolean;
|
3798
4062
|
user_property_targeting: boolean;
|
3799
4063
|
ab_test_conditions: boolean;
|
3800
4064
|
spotlight_ask_copilot_enabled: boolean;
|
3801
4065
|
spotlight_ask_copilot_label: string | null;
|
4066
|
+
spotlight_custom_theme: string | null;
|
4067
|
+
spotlight_ask_copilot_audience: {
|
4068
|
+
type: "all_users";
|
4069
|
+
} | {
|
4070
|
+
type: "rule_expression";
|
4071
|
+
expression: import("./helpers/rules").RuleExpression;
|
4072
|
+
} | {
|
4073
|
+
type: "named_rule_reference";
|
4074
|
+
rule_reference: {
|
4075
|
+
type: "named_rule";
|
4076
|
+
rule_id: string | number;
|
4077
|
+
} & {
|
4078
|
+
reason?: string | undefined;
|
4079
|
+
};
|
4080
|
+
} | null;
|
3802
4081
|
helphub_ai_enabled: boolean;
|
3803
4082
|
copilot_experiences_enabled: boolean;
|
3804
4083
|
helphub_chat_only_mode: boolean;
|
@@ -3806,11 +4085,11 @@ export declare const decode: (data: any) => {
|
|
3806
4085
|
helphub_launcher_offset_x: number;
|
3807
4086
|
helphub_launcher_offset_y: number;
|
3808
4087
|
helphub_launcher_anchor: string;
|
3809
|
-
helphub_launcher_position: "
|
3810
|
-
helphub_launcher_type: "none" | "custom" | "
|
4088
|
+
helphub_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
4089
|
+
helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
|
3811
4090
|
helphub_mobile_launcher_offset_x: number;
|
3812
4091
|
helphub_mobile_launcher_offset_y: number;
|
3813
4092
|
helphub_mobile_launcher_anchor: string;
|
3814
|
-
helphub_mobile_launcher_position: "
|
3815
|
-
helphub_mobile_launcher_type: "none" | "custom" | "
|
4093
|
+
helphub_mobile_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
4094
|
+
helphub_mobile_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
|
3816
4095
|
};
|