commandbar 1.9.0 → 1.10.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{internal/src/client → commandbar/src/shared/services/analytics}/EventHandler.d.ts +32 -10
- package/build/commandbar/src/shared/services/analytics/types.d.ts +77 -0
- package/build/commandbar-js/src/index.d.ts +2 -2
- package/build/commandbar-js/src/index.js +1 -1
- package/build/internal/src/client/AddContextOptions.d.ts +4 -0
- package/build/internal/src/client/CommandBarClientSDK.d.ts +46 -13
- package/build/internal/src/client/CommandBarSDK.d.ts +17 -10
- package/build/internal/src/client/SDKConfig.d.ts +3 -2
- package/build/internal/src/client/symbols.d.ts +5 -1
- package/build/internal/src/middleware/CommandFromClientV.d.ts +22 -10
- package/build/internal/src/middleware/IRecordSettings.d.ts +3 -0
- package/build/internal/src/middleware/OrganizationV.d.ts +200 -6
- package/build/internal/src/middleware/{ResourceSettingsV.d.ts → RecordSettingsV.d.ts} +2 -2
- package/build/internal/src/middleware/additionalResource.d.ts +96 -15
- package/build/internal/src/middleware/billing.d.ts +0 -2
- package/build/internal/src/middleware/chat.d.ts +2196 -176
- package/build/internal/src/middleware/checklist.d.ts +504 -63
- package/build/internal/src/middleware/command.d.ts +1809 -385
- package/build/internal/src/middleware/endUser.d.ts +33 -5
- package/build/internal/src/middleware/entityChanges.d.ts +17 -0
- package/build/internal/src/middleware/experienceTemplate.d.ts +59 -0
- package/build/internal/src/middleware/experiencesSearch.d.ts +3579 -0
- package/build/internal/src/middleware/flags.d.ts +20 -0
- package/build/internal/src/middleware/helpDocsIntegration.d.ts +9 -0
- package/build/internal/src/middleware/helpDocsSearch.d.ts +371 -35
- package/build/internal/src/middleware/helpers/actions.d.ts +66 -16
- package/build/internal/src/middleware/helpers/commandTemplate.d.ts +70 -8
- package/build/internal/src/middleware/helpers/copilotPersonality.d.ts +12 -0
- package/build/internal/src/middleware/helpers/goals.d.ts +4 -2
- package/build/internal/src/middleware/helpers/pushTrigger.d.ts +22 -0
- package/build/internal/src/middleware/helpers/rules.d.ts +45 -36
- package/build/internal/src/middleware/network.d.ts +15 -0
- package/build/internal/src/middleware/nudge.d.ts +1103 -124
- package/build/internal/src/middleware/organization.d.ts +1288 -61
- package/build/internal/src/middleware/organizationSettings.d.ts +320 -12
- package/build/internal/src/middleware/profile.d.ts +2 -0
- package/build/internal/src/middleware/recommendationSet.d.ts +96 -15
- package/build/internal/src/middleware/releases.d.ts +1 -1
- package/build/internal/src/middleware/theme.d.ts +431 -0
- package/build/internal/src/middleware/types.d.ts +52 -15
- package/build/internal/src/middleware/user.d.ts +1 -0
- package/build/internal/src/util/dispatchCustomEvent.d.ts +3 -3
- package/build/internal/src/util/operatingSystem.d.ts +2 -4
- package/package.json +1 -1
- package/src/index.ts +2 -2
- package/src/init.ts +12 -6
- package/src/snippet.ts +2 -2
- package/build/internal/src/client/AnalyticsEventTypes.d.ts +0 -1
- package/build/internal/src/middleware/IResourceSettings.d.ts +0 -3
- package/build/internal/src/middleware/dashboardFlags.d.ts +0 -9
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as t from 'io-ts';
|
|
2
|
-
export {
|
|
2
|
+
export { RecordSettingsV, RecordSettingsByContextKeyV } from './RecordSettingsV';
|
|
3
3
|
export { OrganizationV, unknownOrganization } from './OrganizationV';
|
|
4
4
|
export declare const OrganizationStatusV: t.TypeC<{
|
|
5
5
|
id: t.UnionC<[t.NumberC, t.StringC]>;
|
|
@@ -10,6 +10,9 @@ export declare const OrganizationStatusV: t.TypeC<{
|
|
|
10
10
|
users_total: t.NumberC;
|
|
11
11
|
}>;
|
|
12
12
|
export declare const KeyEventV: t.UnionC<[t.LiteralC<"Client-Error">, t.LiteralC<"Command execution">, t.LiteralC<"Command suggestion">, t.LiteralC<"Abandoned search">, t.LiteralC<"Search miss">]>;
|
|
13
|
+
export declare const UserPropertiesV: t.TypeC<{
|
|
14
|
+
keys: t.ArrayC<t.StringC>;
|
|
15
|
+
}>;
|
|
13
16
|
export declare const InternalSettingsV: t.TypeC<{
|
|
14
17
|
id: t.StringC;
|
|
15
18
|
integrations: t.RecordC<t.StringC, t.RecordC<t.StringC, t.AnyC>>;
|
|
@@ -22,6 +25,7 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
|
22
25
|
name: string;
|
|
23
26
|
created: string;
|
|
24
27
|
} & {} & {
|
|
28
|
+
disabled: boolean;
|
|
25
29
|
launcher_type: "alternate" | "none" | "prompt" | "minimal";
|
|
26
30
|
launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
|
27
31
|
show_launcher_recommendations: boolean;
|
|
@@ -30,6 +34,36 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
|
30
34
|
launcher_offset_y: number;
|
|
31
35
|
base_url: string;
|
|
32
36
|
theme: object;
|
|
37
|
+
themeV2: {
|
|
38
|
+
light_mode: {
|
|
39
|
+
var_defaults: {
|
|
40
|
+
[x: string]: string | number;
|
|
41
|
+
};
|
|
42
|
+
var_overrides: {
|
|
43
|
+
[x: string]: string | number;
|
|
44
|
+
};
|
|
45
|
+
component_overrides: {
|
|
46
|
+
[x: string]: any;
|
|
47
|
+
};
|
|
48
|
+
mobile_overrides: {
|
|
49
|
+
[x: string]: any;
|
|
50
|
+
};
|
|
51
|
+
};
|
|
52
|
+
dark_mode: {
|
|
53
|
+
var_defaults: {
|
|
54
|
+
[x: string]: string | number;
|
|
55
|
+
};
|
|
56
|
+
var_overrides: {
|
|
57
|
+
[x: string]: string | number;
|
|
58
|
+
};
|
|
59
|
+
component_overrides: {
|
|
60
|
+
[x: string]: any;
|
|
61
|
+
};
|
|
62
|
+
mobile_overrides: {
|
|
63
|
+
[x: string]: any;
|
|
64
|
+
};
|
|
65
|
+
};
|
|
66
|
+
} | null | undefined;
|
|
33
67
|
icon: string;
|
|
34
68
|
icon_suggest: string;
|
|
35
69
|
icon_tutorial: string;
|
|
@@ -124,6 +158,7 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
|
124
158
|
slash_filters_enabled: boolean;
|
|
125
159
|
recents_sort_key: number | null;
|
|
126
160
|
recommended_sort_key: number | null;
|
|
161
|
+
experiences_sort_key: number | null;
|
|
127
162
|
show_suggested_synonyms: boolean;
|
|
128
163
|
has_hotloaded_help_docs: boolean;
|
|
129
164
|
bar_enabled: boolean;
|
|
@@ -139,10 +174,70 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
|
139
174
|
type: "execute_command";
|
|
140
175
|
meta: {
|
|
141
176
|
command: string;
|
|
177
|
+
} & {
|
|
178
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
|
179
|
+
};
|
|
180
|
+
} | {
|
|
181
|
+
type: "click";
|
|
182
|
+
value: string;
|
|
183
|
+
} | {
|
|
184
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
185
|
+
value: string[];
|
|
186
|
+
} | ({
|
|
187
|
+
type: "link";
|
|
188
|
+
value: string;
|
|
189
|
+
} & {
|
|
190
|
+
operation?: "self" | "router" | "blank" | undefined;
|
|
191
|
+
}) | {
|
|
192
|
+
type: "open_chat";
|
|
193
|
+
meta: {
|
|
194
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
|
195
|
+
};
|
|
196
|
+
} | {
|
|
197
|
+
type: "dismiss";
|
|
198
|
+
} | {
|
|
199
|
+
type: "snooze";
|
|
200
|
+
} | {
|
|
201
|
+
type: "questlist";
|
|
202
|
+
value: number;
|
|
203
|
+
} | {
|
|
204
|
+
type: "step_back";
|
|
205
|
+
} | {
|
|
206
|
+
type: "nudge";
|
|
207
|
+
value: number;
|
|
208
|
+
} | {
|
|
209
|
+
type: "go_to_step";
|
|
210
|
+
value: number;
|
|
211
|
+
} | ({
|
|
212
|
+
type: "open_bar";
|
|
213
|
+
} & {
|
|
214
|
+
value?: string | undefined;
|
|
215
|
+
categoryFilter?: number | undefined;
|
|
216
|
+
}) | {
|
|
217
|
+
type: "open_helphub";
|
|
218
|
+
} | {
|
|
219
|
+
type: "open_copilot";
|
|
220
|
+
} | {
|
|
221
|
+
type: "no_action";
|
|
222
|
+
};
|
|
223
|
+
}[];
|
|
224
|
+
copilot_negative_feedback_fallback_enabled: boolean;
|
|
225
|
+
copilot_negative_feedback_fallback_message: string | null;
|
|
226
|
+
copilot_negative_feedback_fallback_actions: {
|
|
227
|
+
cta: string;
|
|
228
|
+
action: {
|
|
229
|
+
type: "execute_command";
|
|
230
|
+
meta: {
|
|
231
|
+
command: string;
|
|
232
|
+
} & {
|
|
233
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
|
142
234
|
};
|
|
143
235
|
} | {
|
|
144
236
|
type: "click";
|
|
145
237
|
value: string;
|
|
238
|
+
} | {
|
|
239
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
240
|
+
value: string[];
|
|
146
241
|
} | ({
|
|
147
242
|
type: "link";
|
|
148
243
|
value: string;
|
|
@@ -151,7 +246,7 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
|
151
246
|
}) | {
|
|
152
247
|
type: "open_chat";
|
|
153
248
|
meta: {
|
|
154
|
-
type:
|
|
249
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
|
155
250
|
};
|
|
156
251
|
} | {
|
|
157
252
|
type: "dismiss";
|
|
@@ -174,10 +269,24 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
|
174
269
|
value?: string | undefined;
|
|
175
270
|
categoryFilter?: number | undefined;
|
|
176
271
|
}) | {
|
|
272
|
+
type: "open_helphub";
|
|
273
|
+
} | {
|
|
274
|
+
type: "open_copilot";
|
|
275
|
+
} | {
|
|
177
276
|
type: "no_action";
|
|
178
277
|
};
|
|
179
278
|
}[];
|
|
180
279
|
helphub_manual_suggested_queries: string[];
|
|
280
|
+
copilot_name: string;
|
|
281
|
+
copilot_avatar: string;
|
|
282
|
+
copilot_personality: {
|
|
283
|
+
template: "professional" | "friendly" | "confident" | "serious" | "empathetic";
|
|
284
|
+
} | {
|
|
285
|
+
template: "custom";
|
|
286
|
+
adjectives: ("assertive" | "brave" | "empathetic" | "abrasive" | "adventurous" | "affable" | "arrogant" | "assured" | "belligerent" | "cheerful" | "compassionate" | "condescending" | "courteous" | "creative" | "cynical" | "decisive" | "detached" | "diligent" | "eloquent" | "evasive" | "formal" | "frivolous" | "garrulous" | "generous" | "impulsive" | "innovative" | "intense" | "judgmental" | "jovial" | "manipulative" | "obstinate" | "optimistic" | "perceptive" | "pessimistic" | "quarrelsome" | "respectful" | "resourceful" | "sarcastic" | "sincere" | "sociable" | "solemn" | "supportive" | "tactful" | "thoughtful" | "understanding" | "unreliable" | "vain" | "vivacious" | "warm" | "withdrawn" | "witty" | "zealous")[];
|
|
287
|
+
response_length: "long" | "short" | "conversational";
|
|
288
|
+
response_format: "mixed" | "lists" | "paragraphs";
|
|
289
|
+
};
|
|
181
290
|
nudge_rate_limit: number | null;
|
|
182
291
|
bar_hide_completed_nudges_questlists: boolean;
|
|
183
292
|
nudge_rate_period: "day" | "week" | "session";
|
|
@@ -211,6 +320,9 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
|
211
320
|
posthog?: {
|
|
212
321
|
enabled: boolean;
|
|
213
322
|
} | undefined;
|
|
323
|
+
rudderstack?: {
|
|
324
|
+
enabled: boolean;
|
|
325
|
+
} | undefined;
|
|
214
326
|
slack?: {
|
|
215
327
|
channelId: string;
|
|
216
328
|
configuration: {
|
|
@@ -225,6 +337,10 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
|
225
337
|
} | undefined;
|
|
226
338
|
};
|
|
227
339
|
copilot_enabled: boolean;
|
|
340
|
+
user_property_targeting: boolean;
|
|
341
|
+
ab_test_conditions: boolean;
|
|
342
|
+
spotlight_ask_copilot_enabled: boolean;
|
|
343
|
+
spotlight_ask_copilot_label: string | null;
|
|
228
344
|
helphub_ai_enabled: boolean;
|
|
229
345
|
copilot_experiences_enabled: boolean;
|
|
230
346
|
helphub_chat_only_mode: boolean;
|
|
@@ -233,18 +349,19 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
|
233
349
|
helphub_launcher_offset_y: number;
|
|
234
350
|
helphub_launcher_anchor: string;
|
|
235
351
|
helphub_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
|
236
|
-
helphub_launcher_type: "none" | "custom" | "
|
|
352
|
+
helphub_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
|
|
237
353
|
helphub_mobile_launcher_offset_x: number;
|
|
238
354
|
helphub_mobile_launcher_offset_y: number;
|
|
239
355
|
helphub_mobile_launcher_anchor: string;
|
|
240
356
|
helphub_mobile_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
|
241
|
-
helphub_mobile_launcher_type: "none" | "custom" | "
|
|
357
|
+
helphub_mobile_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
|
|
242
358
|
}>;
|
|
243
359
|
export declare const update: (object: {
|
|
244
360
|
id: string | number;
|
|
245
361
|
name: string;
|
|
246
362
|
created: string;
|
|
247
363
|
} & {} & {
|
|
364
|
+
disabled: boolean;
|
|
248
365
|
launcher_type: "alternate" | "none" | "prompt" | "minimal";
|
|
249
366
|
launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
|
250
367
|
show_launcher_recommendations: boolean;
|
|
@@ -253,6 +370,36 @@ export declare const update: (object: {
|
|
|
253
370
|
launcher_offset_y: number;
|
|
254
371
|
base_url: string;
|
|
255
372
|
theme: object;
|
|
373
|
+
themeV2: {
|
|
374
|
+
light_mode: {
|
|
375
|
+
var_defaults: {
|
|
376
|
+
[x: string]: string | number;
|
|
377
|
+
};
|
|
378
|
+
var_overrides: {
|
|
379
|
+
[x: string]: string | number;
|
|
380
|
+
};
|
|
381
|
+
component_overrides: {
|
|
382
|
+
[x: string]: any;
|
|
383
|
+
};
|
|
384
|
+
mobile_overrides: {
|
|
385
|
+
[x: string]: any;
|
|
386
|
+
};
|
|
387
|
+
};
|
|
388
|
+
dark_mode: {
|
|
389
|
+
var_defaults: {
|
|
390
|
+
[x: string]: string | number;
|
|
391
|
+
};
|
|
392
|
+
var_overrides: {
|
|
393
|
+
[x: string]: string | number;
|
|
394
|
+
};
|
|
395
|
+
component_overrides: {
|
|
396
|
+
[x: string]: any;
|
|
397
|
+
};
|
|
398
|
+
mobile_overrides: {
|
|
399
|
+
[x: string]: any;
|
|
400
|
+
};
|
|
401
|
+
};
|
|
402
|
+
} | null | undefined;
|
|
256
403
|
icon: string;
|
|
257
404
|
icon_suggest: string;
|
|
258
405
|
icon_tutorial: string;
|
|
@@ -347,6 +494,7 @@ export declare const update: (object: {
|
|
|
347
494
|
slash_filters_enabled: boolean;
|
|
348
495
|
recents_sort_key: number | null;
|
|
349
496
|
recommended_sort_key: number | null;
|
|
497
|
+
experiences_sort_key: number | null;
|
|
350
498
|
show_suggested_synonyms: boolean;
|
|
351
499
|
has_hotloaded_help_docs: boolean;
|
|
352
500
|
bar_enabled: boolean;
|
|
@@ -362,10 +510,70 @@ export declare const update: (object: {
|
|
|
362
510
|
type: "execute_command";
|
|
363
511
|
meta: {
|
|
364
512
|
command: string;
|
|
513
|
+
} & {
|
|
514
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
|
515
|
+
};
|
|
516
|
+
} | {
|
|
517
|
+
type: "click";
|
|
518
|
+
value: string;
|
|
519
|
+
} | {
|
|
520
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
521
|
+
value: string[];
|
|
522
|
+
} | ({
|
|
523
|
+
type: "link";
|
|
524
|
+
value: string;
|
|
525
|
+
} & {
|
|
526
|
+
operation?: "self" | "router" | "blank" | undefined;
|
|
527
|
+
}) | {
|
|
528
|
+
type: "open_chat";
|
|
529
|
+
meta: {
|
|
530
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
|
531
|
+
};
|
|
532
|
+
} | {
|
|
533
|
+
type: "dismiss";
|
|
534
|
+
} | {
|
|
535
|
+
type: "snooze";
|
|
536
|
+
} | {
|
|
537
|
+
type: "questlist";
|
|
538
|
+
value: number;
|
|
539
|
+
} | {
|
|
540
|
+
type: "step_back";
|
|
541
|
+
} | {
|
|
542
|
+
type: "nudge";
|
|
543
|
+
value: number;
|
|
544
|
+
} | {
|
|
545
|
+
type: "go_to_step";
|
|
546
|
+
value: number;
|
|
547
|
+
} | ({
|
|
548
|
+
type: "open_bar";
|
|
549
|
+
} & {
|
|
550
|
+
value?: string | undefined;
|
|
551
|
+
categoryFilter?: number | undefined;
|
|
552
|
+
}) | {
|
|
553
|
+
type: "open_helphub";
|
|
554
|
+
} | {
|
|
555
|
+
type: "open_copilot";
|
|
556
|
+
} | {
|
|
557
|
+
type: "no_action";
|
|
558
|
+
};
|
|
559
|
+
}[];
|
|
560
|
+
copilot_negative_feedback_fallback_enabled: boolean;
|
|
561
|
+
copilot_negative_feedback_fallback_message: string | null;
|
|
562
|
+
copilot_negative_feedback_fallback_actions: {
|
|
563
|
+
cta: string;
|
|
564
|
+
action: {
|
|
565
|
+
type: "execute_command";
|
|
566
|
+
meta: {
|
|
567
|
+
command: string;
|
|
568
|
+
} & {
|
|
569
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
|
365
570
|
};
|
|
366
571
|
} | {
|
|
367
572
|
type: "click";
|
|
368
573
|
value: string;
|
|
574
|
+
} | {
|
|
575
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
576
|
+
value: string[];
|
|
369
577
|
} | ({
|
|
370
578
|
type: "link";
|
|
371
579
|
value: string;
|
|
@@ -374,7 +582,7 @@ export declare const update: (object: {
|
|
|
374
582
|
}) | {
|
|
375
583
|
type: "open_chat";
|
|
376
584
|
meta: {
|
|
377
|
-
type:
|
|
585
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
|
378
586
|
};
|
|
379
587
|
} | {
|
|
380
588
|
type: "dismiss";
|
|
@@ -397,10 +605,24 @@ export declare const update: (object: {
|
|
|
397
605
|
value?: string | undefined;
|
|
398
606
|
categoryFilter?: number | undefined;
|
|
399
607
|
}) | {
|
|
608
|
+
type: "open_helphub";
|
|
609
|
+
} | {
|
|
610
|
+
type: "open_copilot";
|
|
611
|
+
} | {
|
|
400
612
|
type: "no_action";
|
|
401
613
|
};
|
|
402
614
|
}[];
|
|
403
615
|
helphub_manual_suggested_queries: string[];
|
|
616
|
+
copilot_name: string;
|
|
617
|
+
copilot_avatar: string;
|
|
618
|
+
copilot_personality: {
|
|
619
|
+
template: "professional" | "friendly" | "confident" | "serious" | "empathetic";
|
|
620
|
+
} | {
|
|
621
|
+
template: "custom";
|
|
622
|
+
adjectives: ("assertive" | "brave" | "empathetic" | "abrasive" | "adventurous" | "affable" | "arrogant" | "assured" | "belligerent" | "cheerful" | "compassionate" | "condescending" | "courteous" | "creative" | "cynical" | "decisive" | "detached" | "diligent" | "eloquent" | "evasive" | "formal" | "frivolous" | "garrulous" | "generous" | "impulsive" | "innovative" | "intense" | "judgmental" | "jovial" | "manipulative" | "obstinate" | "optimistic" | "perceptive" | "pessimistic" | "quarrelsome" | "respectful" | "resourceful" | "sarcastic" | "sincere" | "sociable" | "solemn" | "supportive" | "tactful" | "thoughtful" | "understanding" | "unreliable" | "vain" | "vivacious" | "warm" | "withdrawn" | "witty" | "zealous")[];
|
|
623
|
+
response_length: "long" | "short" | "conversational";
|
|
624
|
+
response_format: "mixed" | "lists" | "paragraphs";
|
|
625
|
+
};
|
|
404
626
|
nudge_rate_limit: number | null;
|
|
405
627
|
bar_hide_completed_nudges_questlists: boolean;
|
|
406
628
|
nudge_rate_period: "day" | "week" | "session";
|
|
@@ -434,6 +656,9 @@ export declare const update: (object: {
|
|
|
434
656
|
posthog?: {
|
|
435
657
|
enabled: boolean;
|
|
436
658
|
} | undefined;
|
|
659
|
+
rudderstack?: {
|
|
660
|
+
enabled: boolean;
|
|
661
|
+
} | undefined;
|
|
437
662
|
slack?: {
|
|
438
663
|
channelId: string;
|
|
439
664
|
configuration: {
|
|
@@ -448,6 +673,10 @@ export declare const update: (object: {
|
|
|
448
673
|
} | undefined;
|
|
449
674
|
};
|
|
450
675
|
copilot_enabled: boolean;
|
|
676
|
+
user_property_targeting: boolean;
|
|
677
|
+
ab_test_conditions: boolean;
|
|
678
|
+
spotlight_ask_copilot_enabled: boolean;
|
|
679
|
+
spotlight_ask_copilot_label: string | null;
|
|
451
680
|
helphub_ai_enabled: boolean;
|
|
452
681
|
copilot_experiences_enabled: boolean;
|
|
453
682
|
helphub_chat_only_mode: boolean;
|
|
@@ -456,17 +685,18 @@ export declare const update: (object: {
|
|
|
456
685
|
helphub_launcher_offset_y: number;
|
|
457
686
|
helphub_launcher_anchor: string;
|
|
458
687
|
helphub_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
|
459
|
-
helphub_launcher_type: "none" | "custom" | "
|
|
688
|
+
helphub_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
|
|
460
689
|
helphub_mobile_launcher_offset_x: number;
|
|
461
690
|
helphub_mobile_launcher_offset_y: number;
|
|
462
691
|
helphub_mobile_launcher_anchor: string;
|
|
463
692
|
helphub_mobile_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
|
464
|
-
helphub_mobile_launcher_type: "none" | "custom" | "
|
|
693
|
+
helphub_mobile_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
|
|
465
694
|
}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
|
466
695
|
id: string | number;
|
|
467
696
|
name: string;
|
|
468
697
|
created: string;
|
|
469
698
|
} & {} & {
|
|
699
|
+
disabled: boolean;
|
|
470
700
|
launcher_type: "alternate" | "none" | "prompt" | "minimal";
|
|
471
701
|
launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
|
472
702
|
show_launcher_recommendations: boolean;
|
|
@@ -475,6 +705,36 @@ export declare const update: (object: {
|
|
|
475
705
|
launcher_offset_y: number;
|
|
476
706
|
base_url: string;
|
|
477
707
|
theme: object;
|
|
708
|
+
themeV2: {
|
|
709
|
+
light_mode: {
|
|
710
|
+
var_defaults: {
|
|
711
|
+
[x: string]: string | number;
|
|
712
|
+
};
|
|
713
|
+
var_overrides: {
|
|
714
|
+
[x: string]: string | number;
|
|
715
|
+
};
|
|
716
|
+
component_overrides: {
|
|
717
|
+
[x: string]: any;
|
|
718
|
+
};
|
|
719
|
+
mobile_overrides: {
|
|
720
|
+
[x: string]: any;
|
|
721
|
+
};
|
|
722
|
+
};
|
|
723
|
+
dark_mode: {
|
|
724
|
+
var_defaults: {
|
|
725
|
+
[x: string]: string | number;
|
|
726
|
+
};
|
|
727
|
+
var_overrides: {
|
|
728
|
+
[x: string]: string | number;
|
|
729
|
+
};
|
|
730
|
+
component_overrides: {
|
|
731
|
+
[x: string]: any;
|
|
732
|
+
};
|
|
733
|
+
mobile_overrides: {
|
|
734
|
+
[x: string]: any;
|
|
735
|
+
};
|
|
736
|
+
};
|
|
737
|
+
} | null | undefined;
|
|
478
738
|
icon: string;
|
|
479
739
|
icon_suggest: string;
|
|
480
740
|
icon_tutorial: string;
|
|
@@ -569,6 +829,7 @@ export declare const update: (object: {
|
|
|
569
829
|
slash_filters_enabled: boolean;
|
|
570
830
|
recents_sort_key: number | null;
|
|
571
831
|
recommended_sort_key: number | null;
|
|
832
|
+
experiences_sort_key: number | null;
|
|
572
833
|
show_suggested_synonyms: boolean;
|
|
573
834
|
has_hotloaded_help_docs: boolean;
|
|
574
835
|
bar_enabled: boolean;
|
|
@@ -584,10 +845,70 @@ export declare const update: (object: {
|
|
|
584
845
|
type: "execute_command";
|
|
585
846
|
meta: {
|
|
586
847
|
command: string;
|
|
848
|
+
} & {
|
|
849
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
|
850
|
+
};
|
|
851
|
+
} | {
|
|
852
|
+
type: "click";
|
|
853
|
+
value: string;
|
|
854
|
+
} | {
|
|
855
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
856
|
+
value: string[];
|
|
857
|
+
} | ({
|
|
858
|
+
type: "link";
|
|
859
|
+
value: string;
|
|
860
|
+
} & {
|
|
861
|
+
operation?: "self" | "router" | "blank" | undefined;
|
|
862
|
+
}) | {
|
|
863
|
+
type: "open_chat";
|
|
864
|
+
meta: {
|
|
865
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
|
866
|
+
};
|
|
867
|
+
} | {
|
|
868
|
+
type: "dismiss";
|
|
869
|
+
} | {
|
|
870
|
+
type: "snooze";
|
|
871
|
+
} | {
|
|
872
|
+
type: "questlist";
|
|
873
|
+
value: number;
|
|
874
|
+
} | {
|
|
875
|
+
type: "step_back";
|
|
876
|
+
} | {
|
|
877
|
+
type: "nudge";
|
|
878
|
+
value: number;
|
|
879
|
+
} | {
|
|
880
|
+
type: "go_to_step";
|
|
881
|
+
value: number;
|
|
882
|
+
} | ({
|
|
883
|
+
type: "open_bar";
|
|
884
|
+
} & {
|
|
885
|
+
value?: string | undefined;
|
|
886
|
+
categoryFilter?: number | undefined;
|
|
887
|
+
}) | {
|
|
888
|
+
type: "open_helphub";
|
|
889
|
+
} | {
|
|
890
|
+
type: "open_copilot";
|
|
891
|
+
} | {
|
|
892
|
+
type: "no_action";
|
|
893
|
+
};
|
|
894
|
+
}[];
|
|
895
|
+
copilot_negative_feedback_fallback_enabled: boolean;
|
|
896
|
+
copilot_negative_feedback_fallback_message: string | null;
|
|
897
|
+
copilot_negative_feedback_fallback_actions: {
|
|
898
|
+
cta: string;
|
|
899
|
+
action: {
|
|
900
|
+
type: "execute_command";
|
|
901
|
+
meta: {
|
|
902
|
+
command: string;
|
|
903
|
+
} & {
|
|
904
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
|
587
905
|
};
|
|
588
906
|
} | {
|
|
589
907
|
type: "click";
|
|
590
908
|
value: string;
|
|
909
|
+
} | {
|
|
910
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
911
|
+
value: string[];
|
|
591
912
|
} | ({
|
|
592
913
|
type: "link";
|
|
593
914
|
value: string;
|
|
@@ -596,7 +917,7 @@ export declare const update: (object: {
|
|
|
596
917
|
}) | {
|
|
597
918
|
type: "open_chat";
|
|
598
919
|
meta: {
|
|
599
|
-
type:
|
|
920
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
|
600
921
|
};
|
|
601
922
|
} | {
|
|
602
923
|
type: "dismiss";
|
|
@@ -619,10 +940,24 @@ export declare const update: (object: {
|
|
|
619
940
|
value?: string | undefined;
|
|
620
941
|
categoryFilter?: number | undefined;
|
|
621
942
|
}) | {
|
|
943
|
+
type: "open_helphub";
|
|
944
|
+
} | {
|
|
945
|
+
type: "open_copilot";
|
|
946
|
+
} | {
|
|
622
947
|
type: "no_action";
|
|
623
948
|
};
|
|
624
949
|
}[];
|
|
625
950
|
helphub_manual_suggested_queries: string[];
|
|
951
|
+
copilot_name: string;
|
|
952
|
+
copilot_avatar: string;
|
|
953
|
+
copilot_personality: {
|
|
954
|
+
template: "professional" | "friendly" | "confident" | "serious" | "empathetic";
|
|
955
|
+
} | {
|
|
956
|
+
template: "custom";
|
|
957
|
+
adjectives: ("assertive" | "brave" | "empathetic" | "abrasive" | "adventurous" | "affable" | "arrogant" | "assured" | "belligerent" | "cheerful" | "compassionate" | "condescending" | "courteous" | "creative" | "cynical" | "decisive" | "detached" | "diligent" | "eloquent" | "evasive" | "formal" | "frivolous" | "garrulous" | "generous" | "impulsive" | "innovative" | "intense" | "judgmental" | "jovial" | "manipulative" | "obstinate" | "optimistic" | "perceptive" | "pessimistic" | "quarrelsome" | "respectful" | "resourceful" | "sarcastic" | "sincere" | "sociable" | "solemn" | "supportive" | "tactful" | "thoughtful" | "understanding" | "unreliable" | "vain" | "vivacious" | "warm" | "withdrawn" | "witty" | "zealous")[];
|
|
958
|
+
response_length: "long" | "short" | "conversational";
|
|
959
|
+
response_format: "mixed" | "lists" | "paragraphs";
|
|
960
|
+
};
|
|
626
961
|
nudge_rate_limit: number | null;
|
|
627
962
|
bar_hide_completed_nudges_questlists: boolean;
|
|
628
963
|
nudge_rate_period: "day" | "week" | "session";
|
|
@@ -656,6 +991,9 @@ export declare const update: (object: {
|
|
|
656
991
|
posthog?: {
|
|
657
992
|
enabled: boolean;
|
|
658
993
|
} | undefined;
|
|
994
|
+
rudderstack?: {
|
|
995
|
+
enabled: boolean;
|
|
996
|
+
} | undefined;
|
|
659
997
|
slack?: {
|
|
660
998
|
channelId: string;
|
|
661
999
|
configuration: {
|
|
@@ -670,6 +1008,10 @@ export declare const update: (object: {
|
|
|
670
1008
|
} | undefined;
|
|
671
1009
|
};
|
|
672
1010
|
copilot_enabled: boolean;
|
|
1011
|
+
user_property_targeting: boolean;
|
|
1012
|
+
ab_test_conditions: boolean;
|
|
1013
|
+
spotlight_ask_copilot_enabled: boolean;
|
|
1014
|
+
spotlight_ask_copilot_label: string | null;
|
|
673
1015
|
helphub_ai_enabled: boolean;
|
|
674
1016
|
copilot_experiences_enabled: boolean;
|
|
675
1017
|
helphub_chat_only_mode: boolean;
|
|
@@ -678,12 +1020,12 @@ export declare const update: (object: {
|
|
|
678
1020
|
helphub_launcher_offset_y: number;
|
|
679
1021
|
helphub_launcher_anchor: string;
|
|
680
1022
|
helphub_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
|
681
|
-
helphub_launcher_type: "none" | "custom" | "
|
|
1023
|
+
helphub_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
|
|
682
1024
|
helphub_mobile_launcher_offset_x: number;
|
|
683
1025
|
helphub_mobile_launcher_offset_y: number;
|
|
684
1026
|
helphub_mobile_launcher_anchor: string;
|
|
685
1027
|
helphub_mobile_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
|
686
|
-
helphub_mobile_launcher_type: "none" | "custom" | "
|
|
1028
|
+
helphub_mobile_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
|
|
687
1029
|
}>;
|
|
688
1030
|
export declare const listCommands: (orgUID: string) => Promise<({
|
|
689
1031
|
id: number;
|
|
@@ -696,6 +1038,9 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
|
696
1038
|
object?: string | undefined;
|
|
697
1039
|
hoverTooltip?: boolean | undefined;
|
|
698
1040
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1041
|
+
metadata?: {
|
|
1042
|
+
[key: string]: unknown;
|
|
1043
|
+
} | undefined;
|
|
699
1044
|
}) | ({
|
|
700
1045
|
type: "callback";
|
|
701
1046
|
value: string;
|
|
@@ -704,6 +1049,9 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
|
704
1049
|
object?: string | undefined;
|
|
705
1050
|
hoverTooltip?: boolean | undefined;
|
|
706
1051
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1052
|
+
metadata?: {
|
|
1053
|
+
[key: string]: unknown;
|
|
1054
|
+
} | undefined;
|
|
707
1055
|
}) | ({
|
|
708
1056
|
type: "link";
|
|
709
1057
|
value: string;
|
|
@@ -714,14 +1062,20 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
|
714
1062
|
object?: string | undefined;
|
|
715
1063
|
hoverTooltip?: boolean | undefined;
|
|
716
1064
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1065
|
+
metadata?: {
|
|
1066
|
+
[key: string]: unknown;
|
|
1067
|
+
} | undefined;
|
|
717
1068
|
}) | ({
|
|
718
|
-
type: "click" | "
|
|
1069
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
719
1070
|
value: string[];
|
|
720
1071
|
} & {} & {
|
|
721
1072
|
commandType?: "object" | "help" | "independent" | undefined;
|
|
722
1073
|
object?: string | undefined;
|
|
723
1074
|
hoverTooltip?: boolean | undefined;
|
|
724
1075
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1076
|
+
metadata?: {
|
|
1077
|
+
[key: string]: unknown;
|
|
1078
|
+
} | undefined;
|
|
725
1079
|
}) | ({
|
|
726
1080
|
type: "builtin";
|
|
727
1081
|
value: string;
|
|
@@ -730,6 +1084,9 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
|
730
1084
|
object?: string | undefined;
|
|
731
1085
|
hoverTooltip?: boolean | undefined;
|
|
732
1086
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1087
|
+
metadata?: {
|
|
1088
|
+
[key: string]: unknown;
|
|
1089
|
+
} | undefined;
|
|
733
1090
|
}) | ({
|
|
734
1091
|
type: "webhook";
|
|
735
1092
|
value: string;
|
|
@@ -738,6 +1095,9 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
|
738
1095
|
object?: string | undefined;
|
|
739
1096
|
hoverTooltip?: boolean | undefined;
|
|
740
1097
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1098
|
+
metadata?: {
|
|
1099
|
+
[key: string]: unknown;
|
|
1100
|
+
} | undefined;
|
|
741
1101
|
}) | ({
|
|
742
1102
|
type: "script";
|
|
743
1103
|
value: string;
|
|
@@ -746,6 +1106,9 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
|
746
1106
|
object?: string | undefined;
|
|
747
1107
|
hoverTooltip?: boolean | undefined;
|
|
748
1108
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1109
|
+
metadata?: {
|
|
1110
|
+
[key: string]: unknown;
|
|
1111
|
+
} | undefined;
|
|
749
1112
|
}) | ({
|
|
750
1113
|
type: "request";
|
|
751
1114
|
value: {
|
|
@@ -767,6 +1130,9 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
|
767
1130
|
object?: string | undefined;
|
|
768
1131
|
hoverTooltip?: boolean | undefined;
|
|
769
1132
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1133
|
+
metadata?: {
|
|
1134
|
+
[key: string]: unknown;
|
|
1135
|
+
} | undefined;
|
|
770
1136
|
}) | ({
|
|
771
1137
|
type: "appcues";
|
|
772
1138
|
value: string;
|
|
@@ -775,6 +1141,20 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
|
775
1141
|
object?: string | undefined;
|
|
776
1142
|
hoverTooltip?: boolean | undefined;
|
|
777
1143
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1144
|
+
metadata?: {
|
|
1145
|
+
[key: string]: unknown;
|
|
1146
|
+
} | undefined;
|
|
1147
|
+
}) | ({
|
|
1148
|
+
type: "pendo_guide";
|
|
1149
|
+
value: string;
|
|
1150
|
+
} & {} & {
|
|
1151
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
|
1152
|
+
object?: string | undefined;
|
|
1153
|
+
hoverTooltip?: boolean | undefined;
|
|
1154
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1155
|
+
metadata?: {
|
|
1156
|
+
[key: string]: unknown;
|
|
1157
|
+
} | undefined;
|
|
778
1158
|
}) | ({
|
|
779
1159
|
type: "video";
|
|
780
1160
|
value: string;
|
|
@@ -783,6 +1163,9 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
|
783
1163
|
object?: string | undefined;
|
|
784
1164
|
hoverTooltip?: boolean | undefined;
|
|
785
1165
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1166
|
+
metadata?: {
|
|
1167
|
+
[key: string]: unknown;
|
|
1168
|
+
} | undefined;
|
|
786
1169
|
}) | ({
|
|
787
1170
|
type: "helpdoc";
|
|
788
1171
|
value: string;
|
|
@@ -799,16 +1182,24 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
|
799
1182
|
object?: string | undefined;
|
|
800
1183
|
hoverTooltip?: boolean | undefined;
|
|
801
1184
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1185
|
+
metadata?: {
|
|
1186
|
+
[key: string]: unknown;
|
|
1187
|
+
} | undefined;
|
|
802
1188
|
}) | ({
|
|
803
1189
|
type: "trigger";
|
|
804
1190
|
value: {
|
|
805
1191
|
type: "execute_command";
|
|
806
1192
|
meta: {
|
|
807
1193
|
command: string;
|
|
1194
|
+
} & {
|
|
1195
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
|
808
1196
|
};
|
|
809
1197
|
} | {
|
|
810
1198
|
type: "click";
|
|
811
1199
|
value: string;
|
|
1200
|
+
} | {
|
|
1201
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
1202
|
+
value: string[];
|
|
812
1203
|
} | ({
|
|
813
1204
|
type: "link";
|
|
814
1205
|
value: string;
|
|
@@ -817,7 +1208,7 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
|
817
1208
|
}) | {
|
|
818
1209
|
type: "open_chat";
|
|
819
1210
|
meta: {
|
|
820
|
-
type:
|
|
1211
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
|
821
1212
|
};
|
|
822
1213
|
} | {
|
|
823
1214
|
type: "dismiss";
|
|
@@ -840,6 +1231,10 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
|
840
1231
|
value?: string | undefined;
|
|
841
1232
|
categoryFilter?: number | undefined;
|
|
842
1233
|
}) | {
|
|
1234
|
+
type: "open_helphub";
|
|
1235
|
+
} | {
|
|
1236
|
+
type: "open_copilot";
|
|
1237
|
+
} | {
|
|
843
1238
|
type: "no_action";
|
|
844
1239
|
};
|
|
845
1240
|
} & {} & {
|
|
@@ -847,6 +1242,9 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
|
847
1242
|
object?: string | undefined;
|
|
848
1243
|
hoverTooltip?: boolean | undefined;
|
|
849
1244
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1245
|
+
metadata?: {
|
|
1246
|
+
[key: string]: unknown;
|
|
1247
|
+
} | undefined;
|
|
850
1248
|
});
|
|
851
1249
|
} & {
|
|
852
1250
|
disabledReason?: string | undefined;
|
|
@@ -863,8 +1261,11 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
|
863
1261
|
sort_key: number | null;
|
|
864
1262
|
is_live: boolean;
|
|
865
1263
|
copilot_suggest: boolean;
|
|
1264
|
+
show_in_spotlight_search: boolean;
|
|
1265
|
+
show_in_helphub_search: boolean;
|
|
866
1266
|
copilot_cta_label: string;
|
|
867
1267
|
copilot_description: string;
|
|
1268
|
+
editor_tags: string[];
|
|
868
1269
|
tags: string[];
|
|
869
1270
|
arguments: {
|
|
870
1271
|
[x: string]: ({
|
|
@@ -944,6 +1345,7 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
|
944
1345
|
auto_choose?: boolean | undefined;
|
|
945
1346
|
});
|
|
946
1347
|
};
|
|
1348
|
+
shortcut: string[];
|
|
947
1349
|
celebrate: boolean | {
|
|
948
1350
|
angle?: number | undefined;
|
|
949
1351
|
spread?: number | undefined;
|
|
@@ -962,8 +1364,8 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
|
962
1364
|
image_color: string | null;
|
|
963
1365
|
show_preview: boolean;
|
|
964
1366
|
availability_rules: (({
|
|
965
|
-
type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "
|
|
966
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "
|
|
1367
|
+
type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
|
|
1368
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
|
967
1369
|
} & {
|
|
968
1370
|
field?: string | undefined;
|
|
969
1371
|
value?: string | undefined;
|
|
@@ -995,8 +1397,8 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
|
995
1397
|
} & {
|
|
996
1398
|
reason?: string | undefined;
|
|
997
1399
|
}) | ({
|
|
998
|
-
type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "
|
|
999
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "
|
|
1400
|
+
type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
|
|
1401
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
|
1000
1402
|
} & {
|
|
1001
1403
|
field?: string | undefined;
|
|
1002
1404
|
value?: string | undefined;
|
|
@@ -1024,8 +1426,8 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
|
1024
1426
|
reason?: string | undefined;
|
|
1025
1427
|
}))[];
|
|
1026
1428
|
recommend_rules: (({
|
|
1027
|
-
type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "
|
|
1028
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "
|
|
1429
|
+
type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
|
|
1430
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
|
1029
1431
|
} & {
|
|
1030
1432
|
field?: string | undefined;
|
|
1031
1433
|
value?: string | undefined;
|
|
@@ -1065,8 +1467,8 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
|
1065
1467
|
} & {
|
|
1066
1468
|
reason?: string | undefined;
|
|
1067
1469
|
}) | ({
|
|
1068
|
-
type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "
|
|
1069
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "
|
|
1470
|
+
type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
|
|
1471
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
|
1070
1472
|
} & {
|
|
1071
1473
|
field?: string | undefined;
|
|
1072
1474
|
value?: string | undefined;
|
|
@@ -1104,7 +1506,6 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
|
1104
1506
|
availability_expression: import("./helpers/rules").RuleExpression;
|
|
1105
1507
|
recommend_expression: import("./helpers/rules").RuleExpression;
|
|
1106
1508
|
always_recommend: boolean;
|
|
1107
|
-
shortcut: string[];
|
|
1108
1509
|
category: number | null;
|
|
1109
1510
|
recommend_sort_key: number | null;
|
|
1110
1511
|
shortcut_mac: string[];
|
|
@@ -1117,10 +1518,15 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
|
1117
1518
|
type: "execute_command";
|
|
1118
1519
|
meta: {
|
|
1119
1520
|
command: string;
|
|
1521
|
+
} & {
|
|
1522
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
|
1120
1523
|
};
|
|
1121
1524
|
} | {
|
|
1122
1525
|
type: "click";
|
|
1123
1526
|
value: string;
|
|
1527
|
+
} | {
|
|
1528
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
1529
|
+
value: string[];
|
|
1124
1530
|
} | ({
|
|
1125
1531
|
type: "link";
|
|
1126
1532
|
value: string;
|
|
@@ -1129,7 +1535,7 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
|
1129
1535
|
}) | {
|
|
1130
1536
|
type: "open_chat";
|
|
1131
1537
|
meta: {
|
|
1132
|
-
type:
|
|
1538
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
|
1133
1539
|
};
|
|
1134
1540
|
} | {
|
|
1135
1541
|
type: "dismiss";
|
|
@@ -1152,6 +1558,10 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
|
1152
1558
|
value?: string | undefined;
|
|
1153
1559
|
categoryFilter?: number | undefined;
|
|
1154
1560
|
}) | {
|
|
1561
|
+
type: "open_helphub";
|
|
1562
|
+
} | {
|
|
1563
|
+
type: "open_copilot";
|
|
1564
|
+
} | {
|
|
1155
1565
|
type: "no_action";
|
|
1156
1566
|
};
|
|
1157
1567
|
})[];
|
|
@@ -1185,6 +1595,9 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
|
1185
1595
|
object?: string | undefined;
|
|
1186
1596
|
hoverTooltip?: boolean | undefined;
|
|
1187
1597
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1598
|
+
metadata?: {
|
|
1599
|
+
[key: string]: unknown;
|
|
1600
|
+
} | undefined;
|
|
1188
1601
|
}) | ({
|
|
1189
1602
|
type: "callback";
|
|
1190
1603
|
value: string;
|
|
@@ -1193,6 +1606,9 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
|
1193
1606
|
object?: string | undefined;
|
|
1194
1607
|
hoverTooltip?: boolean | undefined;
|
|
1195
1608
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1609
|
+
metadata?: {
|
|
1610
|
+
[key: string]: unknown;
|
|
1611
|
+
} | undefined;
|
|
1196
1612
|
}) | ({
|
|
1197
1613
|
type: "link";
|
|
1198
1614
|
value: string;
|
|
@@ -1203,14 +1619,20 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
|
1203
1619
|
object?: string | undefined;
|
|
1204
1620
|
hoverTooltip?: boolean | undefined;
|
|
1205
1621
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1622
|
+
metadata?: {
|
|
1623
|
+
[key: string]: unknown;
|
|
1624
|
+
} | undefined;
|
|
1206
1625
|
}) | ({
|
|
1207
|
-
type: "click" | "
|
|
1626
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
1208
1627
|
value: string[];
|
|
1209
1628
|
} & {} & {
|
|
1210
1629
|
commandType?: "object" | "help" | "independent" | undefined;
|
|
1211
1630
|
object?: string | undefined;
|
|
1212
1631
|
hoverTooltip?: boolean | undefined;
|
|
1213
1632
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1633
|
+
metadata?: {
|
|
1634
|
+
[key: string]: unknown;
|
|
1635
|
+
} | undefined;
|
|
1214
1636
|
}) | ({
|
|
1215
1637
|
type: "builtin";
|
|
1216
1638
|
value: string;
|
|
@@ -1219,6 +1641,9 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
|
1219
1641
|
object?: string | undefined;
|
|
1220
1642
|
hoverTooltip?: boolean | undefined;
|
|
1221
1643
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1644
|
+
metadata?: {
|
|
1645
|
+
[key: string]: unknown;
|
|
1646
|
+
} | undefined;
|
|
1222
1647
|
}) | ({
|
|
1223
1648
|
type: "webhook";
|
|
1224
1649
|
value: string;
|
|
@@ -1227,6 +1652,9 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
|
1227
1652
|
object?: string | undefined;
|
|
1228
1653
|
hoverTooltip?: boolean | undefined;
|
|
1229
1654
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1655
|
+
metadata?: {
|
|
1656
|
+
[key: string]: unknown;
|
|
1657
|
+
} | undefined;
|
|
1230
1658
|
}) | ({
|
|
1231
1659
|
type: "script";
|
|
1232
1660
|
value: string;
|
|
@@ -1235,6 +1663,9 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
|
1235
1663
|
object?: string | undefined;
|
|
1236
1664
|
hoverTooltip?: boolean | undefined;
|
|
1237
1665
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1666
|
+
metadata?: {
|
|
1667
|
+
[key: string]: unknown;
|
|
1668
|
+
} | undefined;
|
|
1238
1669
|
}) | ({
|
|
1239
1670
|
type: "request";
|
|
1240
1671
|
value: {
|
|
@@ -1256,6 +1687,9 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
|
1256
1687
|
object?: string | undefined;
|
|
1257
1688
|
hoverTooltip?: boolean | undefined;
|
|
1258
1689
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1690
|
+
metadata?: {
|
|
1691
|
+
[key: string]: unknown;
|
|
1692
|
+
} | undefined;
|
|
1259
1693
|
}) | ({
|
|
1260
1694
|
type: "appcues";
|
|
1261
1695
|
value: string;
|
|
@@ -1264,6 +1698,20 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
|
1264
1698
|
object?: string | undefined;
|
|
1265
1699
|
hoverTooltip?: boolean | undefined;
|
|
1266
1700
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1701
|
+
metadata?: {
|
|
1702
|
+
[key: string]: unknown;
|
|
1703
|
+
} | undefined;
|
|
1704
|
+
}) | ({
|
|
1705
|
+
type: "pendo_guide";
|
|
1706
|
+
value: string;
|
|
1707
|
+
} & {} & {
|
|
1708
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
|
1709
|
+
object?: string | undefined;
|
|
1710
|
+
hoverTooltip?: boolean | undefined;
|
|
1711
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1712
|
+
metadata?: {
|
|
1713
|
+
[key: string]: unknown;
|
|
1714
|
+
} | undefined;
|
|
1267
1715
|
}) | ({
|
|
1268
1716
|
type: "video";
|
|
1269
1717
|
value: string;
|
|
@@ -1272,6 +1720,9 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
|
1272
1720
|
object?: string | undefined;
|
|
1273
1721
|
hoverTooltip?: boolean | undefined;
|
|
1274
1722
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1723
|
+
metadata?: {
|
|
1724
|
+
[key: string]: unknown;
|
|
1725
|
+
} | undefined;
|
|
1275
1726
|
}) | ({
|
|
1276
1727
|
type: "helpdoc";
|
|
1277
1728
|
value: string;
|
|
@@ -1288,16 +1739,24 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
|
1288
1739
|
object?: string | undefined;
|
|
1289
1740
|
hoverTooltip?: boolean | undefined;
|
|
1290
1741
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1742
|
+
metadata?: {
|
|
1743
|
+
[key: string]: unknown;
|
|
1744
|
+
} | undefined;
|
|
1291
1745
|
}) | ({
|
|
1292
1746
|
type: "trigger";
|
|
1293
1747
|
value: {
|
|
1294
1748
|
type: "execute_command";
|
|
1295
1749
|
meta: {
|
|
1296
1750
|
command: string;
|
|
1751
|
+
} & {
|
|
1752
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
|
1297
1753
|
};
|
|
1298
1754
|
} | {
|
|
1299
1755
|
type: "click";
|
|
1300
1756
|
value: string;
|
|
1757
|
+
} | {
|
|
1758
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
1759
|
+
value: string[];
|
|
1301
1760
|
} | ({
|
|
1302
1761
|
type: "link";
|
|
1303
1762
|
value: string;
|
|
@@ -1306,7 +1765,7 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
|
1306
1765
|
}) | {
|
|
1307
1766
|
type: "open_chat";
|
|
1308
1767
|
meta: {
|
|
1309
|
-
type:
|
|
1768
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
|
1310
1769
|
};
|
|
1311
1770
|
} | {
|
|
1312
1771
|
type: "dismiss";
|
|
@@ -1329,6 +1788,10 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
|
1329
1788
|
value?: string | undefined;
|
|
1330
1789
|
categoryFilter?: number | undefined;
|
|
1331
1790
|
}) | {
|
|
1791
|
+
type: "open_helphub";
|
|
1792
|
+
} | {
|
|
1793
|
+
type: "open_copilot";
|
|
1794
|
+
} | {
|
|
1332
1795
|
type: "no_action";
|
|
1333
1796
|
};
|
|
1334
1797
|
} & {} & {
|
|
@@ -1336,6 +1799,9 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
|
1336
1799
|
object?: string | undefined;
|
|
1337
1800
|
hoverTooltip?: boolean | undefined;
|
|
1338
1801
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
1802
|
+
metadata?: {
|
|
1803
|
+
[key: string]: unknown;
|
|
1804
|
+
} | undefined;
|
|
1339
1805
|
});
|
|
1340
1806
|
} & {
|
|
1341
1807
|
disabledReason?: string | undefined;
|
|
@@ -1425,8 +1891,8 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
|
1425
1891
|
};
|
|
1426
1892
|
tags: string[];
|
|
1427
1893
|
availability_rules: (({
|
|
1428
|
-
type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "
|
|
1429
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "
|
|
1894
|
+
type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
|
|
1895
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
|
1430
1896
|
} & {
|
|
1431
1897
|
field?: string | undefined;
|
|
1432
1898
|
value?: string | undefined;
|
|
@@ -1454,8 +1920,8 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
|
1454
1920
|
reason?: string | undefined;
|
|
1455
1921
|
}))[];
|
|
1456
1922
|
recommend_rules: (({
|
|
1457
|
-
type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "
|
|
1458
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "
|
|
1923
|
+
type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
|
|
1924
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
|
1459
1925
|
} & {
|
|
1460
1926
|
field?: string | undefined;
|
|
1461
1927
|
value?: string | undefined;
|
|
@@ -1552,10 +2018,15 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
|
1552
2018
|
type: "execute_command";
|
|
1553
2019
|
meta: {
|
|
1554
2020
|
command: string;
|
|
2021
|
+
} & {
|
|
2022
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
|
1555
2023
|
};
|
|
1556
2024
|
} | {
|
|
1557
2025
|
type: "click";
|
|
1558
2026
|
value: string;
|
|
2027
|
+
} | {
|
|
2028
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
2029
|
+
value: string[];
|
|
1559
2030
|
} | ({
|
|
1560
2031
|
type: "link";
|
|
1561
2032
|
value: string;
|
|
@@ -1564,7 +2035,7 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
|
1564
2035
|
}) | {
|
|
1565
2036
|
type: "open_chat";
|
|
1566
2037
|
meta: {
|
|
1567
|
-
type:
|
|
2038
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
|
1568
2039
|
};
|
|
1569
2040
|
} | {
|
|
1570
2041
|
type: "dismiss";
|
|
@@ -1587,6 +2058,10 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
|
1587
2058
|
value?: string | undefined;
|
|
1588
2059
|
categoryFilter?: number | undefined;
|
|
1589
2060
|
}) | {
|
|
2061
|
+
type: "open_helphub";
|
|
2062
|
+
} | {
|
|
2063
|
+
type: "open_copilot";
|
|
2064
|
+
} | {
|
|
1590
2065
|
type: "no_action";
|
|
1591
2066
|
};
|
|
1592
2067
|
})[];
|
|
@@ -1597,6 +2072,8 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
|
1597
2072
|
size: string;
|
|
1598
2073
|
} | null;
|
|
1599
2074
|
copilot_suggest: boolean;
|
|
2075
|
+
show_in_spotlight_search: boolean;
|
|
2076
|
+
show_in_helphub_search: boolean;
|
|
1600
2077
|
copilot_cta_label: string;
|
|
1601
2078
|
copilot_description: string;
|
|
1602
2079
|
} & {
|
|
@@ -1608,7 +2085,7 @@ export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
|
|
1608
2085
|
helphub_view_article_button_hidden: boolean | undefined;
|
|
1609
2086
|
} | null | undefined;
|
|
1610
2087
|
}>;
|
|
1611
|
-
export declare const
|
|
2088
|
+
export declare const getCommandById: (orgUID: string, commandID: string) => Promise<{
|
|
1612
2089
|
id: number;
|
|
1613
2090
|
text: string;
|
|
1614
2091
|
template: ({
|
|
@@ -1619,6 +2096,9 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
|
1619
2096
|
object?: string | undefined;
|
|
1620
2097
|
hoverTooltip?: boolean | undefined;
|
|
1621
2098
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2099
|
+
metadata?: {
|
|
2100
|
+
[key: string]: unknown;
|
|
2101
|
+
} | undefined;
|
|
1622
2102
|
}) | ({
|
|
1623
2103
|
type: "callback";
|
|
1624
2104
|
value: string;
|
|
@@ -1627,6 +2107,9 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
|
1627
2107
|
object?: string | undefined;
|
|
1628
2108
|
hoverTooltip?: boolean | undefined;
|
|
1629
2109
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2110
|
+
metadata?: {
|
|
2111
|
+
[key: string]: unknown;
|
|
2112
|
+
} | undefined;
|
|
1630
2113
|
}) | ({
|
|
1631
2114
|
type: "link";
|
|
1632
2115
|
value: string;
|
|
@@ -1637,14 +2120,20 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
|
1637
2120
|
object?: string | undefined;
|
|
1638
2121
|
hoverTooltip?: boolean | undefined;
|
|
1639
2122
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2123
|
+
metadata?: {
|
|
2124
|
+
[key: string]: unknown;
|
|
2125
|
+
} | undefined;
|
|
1640
2126
|
}) | ({
|
|
1641
|
-
type: "click" | "
|
|
2127
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
1642
2128
|
value: string[];
|
|
1643
2129
|
} & {} & {
|
|
1644
2130
|
commandType?: "object" | "help" | "independent" | undefined;
|
|
1645
2131
|
object?: string | undefined;
|
|
1646
2132
|
hoverTooltip?: boolean | undefined;
|
|
1647
2133
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2134
|
+
metadata?: {
|
|
2135
|
+
[key: string]: unknown;
|
|
2136
|
+
} | undefined;
|
|
1648
2137
|
}) | ({
|
|
1649
2138
|
type: "builtin";
|
|
1650
2139
|
value: string;
|
|
@@ -1653,6 +2142,589 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
|
1653
2142
|
object?: string | undefined;
|
|
1654
2143
|
hoverTooltip?: boolean | undefined;
|
|
1655
2144
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2145
|
+
metadata?: {
|
|
2146
|
+
[key: string]: unknown;
|
|
2147
|
+
} | undefined;
|
|
2148
|
+
}) | ({
|
|
2149
|
+
type: "webhook";
|
|
2150
|
+
value: string;
|
|
2151
|
+
} & {} & {
|
|
2152
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
|
2153
|
+
object?: string | undefined;
|
|
2154
|
+
hoverTooltip?: boolean | undefined;
|
|
2155
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2156
|
+
metadata?: {
|
|
2157
|
+
[key: string]: unknown;
|
|
2158
|
+
} | undefined;
|
|
2159
|
+
}) | ({
|
|
2160
|
+
type: "script";
|
|
2161
|
+
value: string;
|
|
2162
|
+
} & {} & {
|
|
2163
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
|
2164
|
+
object?: string | undefined;
|
|
2165
|
+
hoverTooltip?: boolean | undefined;
|
|
2166
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2167
|
+
metadata?: {
|
|
2168
|
+
[key: string]: unknown;
|
|
2169
|
+
} | undefined;
|
|
2170
|
+
}) | ({
|
|
2171
|
+
type: "request";
|
|
2172
|
+
value: {
|
|
2173
|
+
method: "head" | "options" | "get" | "post" | "put" | "delete" | "patch";
|
|
2174
|
+
url: string;
|
|
2175
|
+
} & {
|
|
2176
|
+
headers?: {
|
|
2177
|
+
[key: string]: unknown;
|
|
2178
|
+
} | undefined;
|
|
2179
|
+
body?: {
|
|
2180
|
+
[key: string]: unknown;
|
|
2181
|
+
} | undefined;
|
|
2182
|
+
onSend?: string | undefined;
|
|
2183
|
+
onSuccess?: string | undefined;
|
|
2184
|
+
onError?: string | undefined;
|
|
2185
|
+
};
|
|
2186
|
+
} & {} & {
|
|
2187
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
|
2188
|
+
object?: string | undefined;
|
|
2189
|
+
hoverTooltip?: boolean | undefined;
|
|
2190
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2191
|
+
metadata?: {
|
|
2192
|
+
[key: string]: unknown;
|
|
2193
|
+
} | undefined;
|
|
2194
|
+
}) | ({
|
|
2195
|
+
type: "appcues";
|
|
2196
|
+
value: string;
|
|
2197
|
+
} & {} & {
|
|
2198
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
|
2199
|
+
object?: string | undefined;
|
|
2200
|
+
hoverTooltip?: boolean | undefined;
|
|
2201
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2202
|
+
metadata?: {
|
|
2203
|
+
[key: string]: unknown;
|
|
2204
|
+
} | undefined;
|
|
2205
|
+
}) | ({
|
|
2206
|
+
type: "pendo_guide";
|
|
2207
|
+
value: string;
|
|
2208
|
+
} & {} & {
|
|
2209
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
|
2210
|
+
object?: string | undefined;
|
|
2211
|
+
hoverTooltip?: boolean | undefined;
|
|
2212
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2213
|
+
metadata?: {
|
|
2214
|
+
[key: string]: unknown;
|
|
2215
|
+
} | undefined;
|
|
2216
|
+
}) | ({
|
|
2217
|
+
type: "video";
|
|
2218
|
+
value: string;
|
|
2219
|
+
} & {} & {
|
|
2220
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
|
2221
|
+
object?: string | undefined;
|
|
2222
|
+
hoverTooltip?: boolean | undefined;
|
|
2223
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2224
|
+
metadata?: {
|
|
2225
|
+
[key: string]: unknown;
|
|
2226
|
+
} | undefined;
|
|
2227
|
+
}) | ({
|
|
2228
|
+
type: "helpdoc";
|
|
2229
|
+
value: string;
|
|
2230
|
+
} & {
|
|
2231
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2232
|
+
doc_metadata?: {
|
|
2233
|
+
content_type?: string | undefined;
|
|
2234
|
+
date?: string | undefined;
|
|
2235
|
+
} | undefined;
|
|
2236
|
+
} & {
|
|
2237
|
+
doc_type?: "answer" | "doc" | undefined;
|
|
2238
|
+
} & {} & {
|
|
2239
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
|
2240
|
+
object?: string | undefined;
|
|
2241
|
+
hoverTooltip?: boolean | undefined;
|
|
2242
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2243
|
+
metadata?: {
|
|
2244
|
+
[key: string]: unknown;
|
|
2245
|
+
} | undefined;
|
|
2246
|
+
}) | ({
|
|
2247
|
+
type: "trigger";
|
|
2248
|
+
value: {
|
|
2249
|
+
type: "execute_command";
|
|
2250
|
+
meta: {
|
|
2251
|
+
command: string;
|
|
2252
|
+
} & {
|
|
2253
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
|
2254
|
+
};
|
|
2255
|
+
} | {
|
|
2256
|
+
type: "click";
|
|
2257
|
+
value: string;
|
|
2258
|
+
} | {
|
|
2259
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
2260
|
+
value: string[];
|
|
2261
|
+
} | ({
|
|
2262
|
+
type: "link";
|
|
2263
|
+
value: string;
|
|
2264
|
+
} & {
|
|
2265
|
+
operation?: "self" | "router" | "blank" | undefined;
|
|
2266
|
+
}) | {
|
|
2267
|
+
type: "open_chat";
|
|
2268
|
+
meta: {
|
|
2269
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
|
2270
|
+
};
|
|
2271
|
+
} | {
|
|
2272
|
+
type: "dismiss";
|
|
2273
|
+
} | {
|
|
2274
|
+
type: "snooze";
|
|
2275
|
+
} | {
|
|
2276
|
+
type: "questlist";
|
|
2277
|
+
value: number;
|
|
2278
|
+
} | {
|
|
2279
|
+
type: "step_back";
|
|
2280
|
+
} | {
|
|
2281
|
+
type: "nudge";
|
|
2282
|
+
value: number;
|
|
2283
|
+
} | {
|
|
2284
|
+
type: "go_to_step";
|
|
2285
|
+
value: number;
|
|
2286
|
+
} | ({
|
|
2287
|
+
type: "open_bar";
|
|
2288
|
+
} & {
|
|
2289
|
+
value?: string | undefined;
|
|
2290
|
+
categoryFilter?: number | undefined;
|
|
2291
|
+
}) | {
|
|
2292
|
+
type: "open_helphub";
|
|
2293
|
+
} | {
|
|
2294
|
+
type: "open_copilot";
|
|
2295
|
+
} | {
|
|
2296
|
+
type: "no_action";
|
|
2297
|
+
};
|
|
2298
|
+
} & {} & {
|
|
2299
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
|
2300
|
+
object?: string | undefined;
|
|
2301
|
+
hoverTooltip?: boolean | undefined;
|
|
2302
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2303
|
+
metadata?: {
|
|
2304
|
+
[key: string]: unknown;
|
|
2305
|
+
} | undefined;
|
|
2306
|
+
});
|
|
2307
|
+
} & {
|
|
2308
|
+
disabledReason?: string | undefined;
|
|
2309
|
+
source?: string | undefined;
|
|
2310
|
+
name?: string | undefined;
|
|
2311
|
+
last_available?: string | null | undefined;
|
|
2312
|
+
modified?: string | undefined;
|
|
2313
|
+
isAsync?: boolean | undefined;
|
|
2314
|
+
} & {
|
|
2315
|
+
arguments: {
|
|
2316
|
+
[x: string]: ({
|
|
2317
|
+
type: "context";
|
|
2318
|
+
value: string;
|
|
2319
|
+
order_key: number;
|
|
2320
|
+
} & {
|
|
2321
|
+
label?: string | undefined;
|
|
2322
|
+
chosen?: string | number | undefined;
|
|
2323
|
+
selected?: any[] | undefined;
|
|
2324
|
+
input_type?: string | undefined;
|
|
2325
|
+
preselected_key?: string | undefined;
|
|
2326
|
+
label_field?: string | undefined;
|
|
2327
|
+
loaded?: any[] | undefined;
|
|
2328
|
+
allow_create?: boolean | undefined;
|
|
2329
|
+
allow_create_label?: string | undefined;
|
|
2330
|
+
show_in_record_action_list?: boolean | undefined;
|
|
2331
|
+
show_in_default_list?: boolean | undefined;
|
|
2332
|
+
auto_choose?: boolean | undefined;
|
|
2333
|
+
is_private?: boolean | undefined;
|
|
2334
|
+
}) | ({
|
|
2335
|
+
type: "set";
|
|
2336
|
+
value: string[] | number[] | {
|
|
2337
|
+
[key: string]: unknown;
|
|
2338
|
+
}[];
|
|
2339
|
+
order_key: number;
|
|
2340
|
+
} & {
|
|
2341
|
+
label?: string | undefined;
|
|
2342
|
+
chosen?: string | number | undefined;
|
|
2343
|
+
selected?: any[] | undefined;
|
|
2344
|
+
input_type?: string | undefined;
|
|
2345
|
+
preselected_key?: string | undefined;
|
|
2346
|
+
label_field?: string | undefined;
|
|
2347
|
+
loaded?: any[] | undefined;
|
|
2348
|
+
allow_create?: boolean | undefined;
|
|
2349
|
+
allow_create_label?: string | undefined;
|
|
2350
|
+
auto_choose?: boolean | undefined;
|
|
2351
|
+
is_private?: boolean | undefined;
|
|
2352
|
+
}) | ({
|
|
2353
|
+
type: "provided";
|
|
2354
|
+
value: "time" | "text";
|
|
2355
|
+
order_key: number;
|
|
2356
|
+
} & {
|
|
2357
|
+
label?: string | undefined;
|
|
2358
|
+
chosen?: string | number | undefined;
|
|
2359
|
+
selected?: any[] | undefined;
|
|
2360
|
+
input_type?: string | undefined;
|
|
2361
|
+
preselected_key?: string | undefined;
|
|
2362
|
+
label_field?: string | undefined;
|
|
2363
|
+
loaded?: any[] | undefined;
|
|
2364
|
+
dateTimeArgumentTypeId?: number | undefined;
|
|
2365
|
+
allow_create?: boolean | undefined;
|
|
2366
|
+
allow_create_label?: string | undefined;
|
|
2367
|
+
auto_choose?: boolean | undefined;
|
|
2368
|
+
is_private?: boolean | undefined;
|
|
2369
|
+
}) | ({
|
|
2370
|
+
type: "html" | "video";
|
|
2371
|
+
value: {
|
|
2372
|
+
source: string;
|
|
2373
|
+
} & {
|
|
2374
|
+
title?: string | undefined;
|
|
2375
|
+
description?: string | undefined;
|
|
2376
|
+
url?: string | undefined;
|
|
2377
|
+
};
|
|
2378
|
+
order_key: number;
|
|
2379
|
+
} & {
|
|
2380
|
+
label?: string | undefined;
|
|
2381
|
+
chosen?: string | number | undefined;
|
|
2382
|
+
selected?: any[] | undefined;
|
|
2383
|
+
input_type?: string | undefined;
|
|
2384
|
+
preselected_key?: string | undefined;
|
|
2385
|
+
label_field?: string | undefined;
|
|
2386
|
+
loaded?: any[] | undefined;
|
|
2387
|
+
allow_create?: boolean | undefined;
|
|
2388
|
+
allow_create_label?: string | undefined;
|
|
2389
|
+
is_private?: boolean | undefined;
|
|
2390
|
+
auto_choose?: boolean | undefined;
|
|
2391
|
+
});
|
|
2392
|
+
};
|
|
2393
|
+
tags: string[];
|
|
2394
|
+
availability_rules: (({
|
|
2395
|
+
type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
|
|
2396
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
|
2397
|
+
} & {
|
|
2398
|
+
field?: string | undefined;
|
|
2399
|
+
value?: string | undefined;
|
|
2400
|
+
reason?: string | undefined;
|
|
2401
|
+
rule_id?: string | number | undefined;
|
|
2402
|
+
}) | ({
|
|
2403
|
+
type: "nudge_interaction";
|
|
2404
|
+
operator: "is" | "isNot";
|
|
2405
|
+
value: "completed" | "dismissed" | "viewed";
|
|
2406
|
+
nudge_id: number;
|
|
2407
|
+
} & {
|
|
2408
|
+
reason?: string | undefined;
|
|
2409
|
+
}) | ({
|
|
2410
|
+
type: "questlist_interaction";
|
|
2411
|
+
operator: "is" | "isNot";
|
|
2412
|
+
value: "completed" | "dismissed" | "viewed";
|
|
2413
|
+
questlist_id: number;
|
|
2414
|
+
} & {
|
|
2415
|
+
reason?: string | undefined;
|
|
2416
|
+
}) | ({
|
|
2417
|
+
type: "browser" | "language" | "os";
|
|
2418
|
+
operator: "includes" | "doesNotInclude";
|
|
2419
|
+
values: string[];
|
|
2420
|
+
} & {
|
|
2421
|
+
reason?: string | undefined;
|
|
2422
|
+
}))[] | (({
|
|
2423
|
+
type: "named_rule";
|
|
2424
|
+
rule_id: string | number;
|
|
2425
|
+
} & {
|
|
2426
|
+
reason?: string | undefined;
|
|
2427
|
+
}) | ({
|
|
2428
|
+
type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
|
|
2429
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
|
2430
|
+
} & {
|
|
2431
|
+
field?: string | undefined;
|
|
2432
|
+
value?: string | undefined;
|
|
2433
|
+
reason?: string | undefined;
|
|
2434
|
+
rule_id?: string | number | undefined;
|
|
2435
|
+
}) | ({
|
|
2436
|
+
type: "nudge_interaction";
|
|
2437
|
+
operator: "is" | "isNot";
|
|
2438
|
+
value: "completed" | "dismissed" | "viewed";
|
|
2439
|
+
nudge_id: number;
|
|
2440
|
+
} & {
|
|
2441
|
+
reason?: string | undefined;
|
|
2442
|
+
}) | ({
|
|
2443
|
+
type: "questlist_interaction";
|
|
2444
|
+
operator: "is" | "isNot";
|
|
2445
|
+
value: "completed" | "dismissed" | "viewed";
|
|
2446
|
+
questlist_id: number;
|
|
2447
|
+
} & {
|
|
2448
|
+
reason?: string | undefined;
|
|
2449
|
+
}) | ({
|
|
2450
|
+
type: "browser" | "language" | "os";
|
|
2451
|
+
operator: "includes" | "doesNotInclude";
|
|
2452
|
+
values: string[];
|
|
2453
|
+
} & {
|
|
2454
|
+
reason?: string | undefined;
|
|
2455
|
+
}))[];
|
|
2456
|
+
recommend_rules: (({
|
|
2457
|
+
type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
|
|
2458
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
|
2459
|
+
} & {
|
|
2460
|
+
field?: string | undefined;
|
|
2461
|
+
value?: string | undefined;
|
|
2462
|
+
reason?: string | undefined;
|
|
2463
|
+
rule_id?: string | number | undefined;
|
|
2464
|
+
}) | ({
|
|
2465
|
+
type: "nudge_interaction";
|
|
2466
|
+
operator: "is" | "isNot";
|
|
2467
|
+
value: "completed" | "dismissed" | "viewed";
|
|
2468
|
+
nudge_id: number;
|
|
2469
|
+
} & {
|
|
2470
|
+
reason?: string | undefined;
|
|
2471
|
+
}) | ({
|
|
2472
|
+
type: "questlist_interaction";
|
|
2473
|
+
operator: "is" | "isNot";
|
|
2474
|
+
value: "completed" | "dismissed" | "viewed";
|
|
2475
|
+
questlist_id: number;
|
|
2476
|
+
} & {
|
|
2477
|
+
reason?: string | undefined;
|
|
2478
|
+
}) | ({
|
|
2479
|
+
type: "browser" | "language" | "os";
|
|
2480
|
+
operator: "includes" | "doesNotInclude";
|
|
2481
|
+
values: string[];
|
|
2482
|
+
} & {
|
|
2483
|
+
reason?: string | undefined;
|
|
2484
|
+
}) | ({
|
|
2485
|
+
type: "always";
|
|
2486
|
+
} & {
|
|
2487
|
+
operator?: null | undefined;
|
|
2488
|
+
field?: null | undefined;
|
|
2489
|
+
value?: null | undefined;
|
|
2490
|
+
reason?: null | undefined;
|
|
2491
|
+
rule_id?: string | number | undefined;
|
|
2492
|
+
}))[] | (({
|
|
2493
|
+
type: "named_rule";
|
|
2494
|
+
rule_id: string | number;
|
|
2495
|
+
} & {
|
|
2496
|
+
reason?: string | undefined;
|
|
2497
|
+
}) | ({
|
|
2498
|
+
type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
|
|
2499
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
|
2500
|
+
} & {
|
|
2501
|
+
field?: string | undefined;
|
|
2502
|
+
value?: string | undefined;
|
|
2503
|
+
reason?: string | undefined;
|
|
2504
|
+
rule_id?: string | number | undefined;
|
|
2505
|
+
}) | ({
|
|
2506
|
+
type: "nudge_interaction";
|
|
2507
|
+
operator: "is" | "isNot";
|
|
2508
|
+
value: "completed" | "dismissed" | "viewed";
|
|
2509
|
+
nudge_id: number;
|
|
2510
|
+
} & {
|
|
2511
|
+
reason?: string | undefined;
|
|
2512
|
+
}) | ({
|
|
2513
|
+
type: "questlist_interaction";
|
|
2514
|
+
operator: "is" | "isNot";
|
|
2515
|
+
value: "completed" | "dismissed" | "viewed";
|
|
2516
|
+
questlist_id: number;
|
|
2517
|
+
} & {
|
|
2518
|
+
reason?: string | undefined;
|
|
2519
|
+
}) | ({
|
|
2520
|
+
type: "browser" | "language" | "os";
|
|
2521
|
+
operator: "includes" | "doesNotInclude";
|
|
2522
|
+
values: string[];
|
|
2523
|
+
} & {
|
|
2524
|
+
reason?: string | undefined;
|
|
2525
|
+
}) | ({
|
|
2526
|
+
type: "always";
|
|
2527
|
+
} & {
|
|
2528
|
+
operator?: null | undefined;
|
|
2529
|
+
field?: null | undefined;
|
|
2530
|
+
value?: null | undefined;
|
|
2531
|
+
reason?: null | undefined;
|
|
2532
|
+
rule_id?: string | number | undefined;
|
|
2533
|
+
}))[];
|
|
2534
|
+
availability_expression: import("./helpers/rules").RuleExpression;
|
|
2535
|
+
recommend_expression: import("./helpers/rules").RuleExpression;
|
|
2536
|
+
always_recommend: boolean;
|
|
2537
|
+
confirm: string;
|
|
2538
|
+
shortcut: string[];
|
|
2539
|
+
explanation: string;
|
|
2540
|
+
heading: string;
|
|
2541
|
+
is_live: boolean;
|
|
2542
|
+
category: number | null;
|
|
2543
|
+
sort_key: number | null;
|
|
2544
|
+
icon: string | null;
|
|
2545
|
+
icon_color: string | null;
|
|
2546
|
+
image_color: string | null;
|
|
2547
|
+
image: string | null;
|
|
2548
|
+
celebrate: boolean | {
|
|
2549
|
+
angle?: number | undefined;
|
|
2550
|
+
spread?: number | undefined;
|
|
2551
|
+
width?: string | undefined;
|
|
2552
|
+
height?: string | undefined;
|
|
2553
|
+
duration?: number | undefined;
|
|
2554
|
+
dragFriction?: number | undefined;
|
|
2555
|
+
stagger?: number | undefined;
|
|
2556
|
+
startVelocity?: number | undefined;
|
|
2557
|
+
elementCount?: number | undefined;
|
|
2558
|
+
decay?: number | undefined;
|
|
2559
|
+
colors?: string[] | undefined;
|
|
2560
|
+
random?: any;
|
|
2561
|
+
} | null;
|
|
2562
|
+
recommend_sort_key: number | null;
|
|
2563
|
+
shortcut_mac: string[];
|
|
2564
|
+
shortcut_win: string[];
|
|
2565
|
+
hotkey_mac: string;
|
|
2566
|
+
hotkey_win: string;
|
|
2567
|
+
detail: string | ({
|
|
2568
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
|
2569
|
+
value: string;
|
|
2570
|
+
} & {
|
|
2571
|
+
position?: "inline" | "popover" | undefined;
|
|
2572
|
+
}) | (string | ({
|
|
2573
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
|
2574
|
+
value: string;
|
|
2575
|
+
} & {
|
|
2576
|
+
position?: "inline" | "popover" | undefined;
|
|
2577
|
+
}))[] | null;
|
|
2578
|
+
content: string | ({
|
|
2579
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
|
2580
|
+
value: string;
|
|
2581
|
+
} & {
|
|
2582
|
+
position?: "inline" | "popover" | undefined;
|
|
2583
|
+
}) | (string | ({
|
|
2584
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
|
2585
|
+
value: string;
|
|
2586
|
+
} & {
|
|
2587
|
+
position?: "inline" | "popover" | undefined;
|
|
2588
|
+
}))[] | null;
|
|
2589
|
+
show_preview: boolean;
|
|
2590
|
+
thumbnail: {
|
|
2591
|
+
src: string;
|
|
2592
|
+
file_name: string;
|
|
2593
|
+
size: string;
|
|
2594
|
+
} | null;
|
|
2595
|
+
next_steps: (string | number | {
|
|
2596
|
+
cta: string;
|
|
2597
|
+
action: {
|
|
2598
|
+
type: "execute_command";
|
|
2599
|
+
meta: {
|
|
2600
|
+
command: string;
|
|
2601
|
+
} & {
|
|
2602
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
|
2603
|
+
};
|
|
2604
|
+
} | {
|
|
2605
|
+
type: "click";
|
|
2606
|
+
value: string;
|
|
2607
|
+
} | {
|
|
2608
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
2609
|
+
value: string[];
|
|
2610
|
+
} | ({
|
|
2611
|
+
type: "link";
|
|
2612
|
+
value: string;
|
|
2613
|
+
} & {
|
|
2614
|
+
operation?: "self" | "router" | "blank" | undefined;
|
|
2615
|
+
}) | {
|
|
2616
|
+
type: "open_chat";
|
|
2617
|
+
meta: {
|
|
2618
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
|
2619
|
+
};
|
|
2620
|
+
} | {
|
|
2621
|
+
type: "dismiss";
|
|
2622
|
+
} | {
|
|
2623
|
+
type: "snooze";
|
|
2624
|
+
} | {
|
|
2625
|
+
type: "questlist";
|
|
2626
|
+
value: number;
|
|
2627
|
+
} | {
|
|
2628
|
+
type: "step_back";
|
|
2629
|
+
} | {
|
|
2630
|
+
type: "nudge";
|
|
2631
|
+
value: number;
|
|
2632
|
+
} | {
|
|
2633
|
+
type: "go_to_step";
|
|
2634
|
+
value: number;
|
|
2635
|
+
} | ({
|
|
2636
|
+
type: "open_bar";
|
|
2637
|
+
} & {
|
|
2638
|
+
value?: string | undefined;
|
|
2639
|
+
categoryFilter?: number | undefined;
|
|
2640
|
+
}) | {
|
|
2641
|
+
type: "open_helphub";
|
|
2642
|
+
} | {
|
|
2643
|
+
type: "open_copilot";
|
|
2644
|
+
} | {
|
|
2645
|
+
type: "no_action";
|
|
2646
|
+
};
|
|
2647
|
+
})[];
|
|
2648
|
+
generated_tags: {
|
|
2649
|
+
automated?: string[] | null | undefined;
|
|
2650
|
+
manual?: string[] | null | undefined;
|
|
2651
|
+
deny?: string[] | null | undefined;
|
|
2652
|
+
};
|
|
2653
|
+
copilot_suggest: boolean;
|
|
2654
|
+
show_in_spotlight_search: boolean;
|
|
2655
|
+
show_in_helphub_search: boolean;
|
|
2656
|
+
copilot_cta_label: string;
|
|
2657
|
+
copilot_description: string;
|
|
2658
|
+
editor_tags: string[];
|
|
2659
|
+
} & {
|
|
2660
|
+
third_party_source?: string | null | undefined;
|
|
2661
|
+
third_party_id?: string | null | undefined;
|
|
2662
|
+
training_only?: boolean | undefined;
|
|
2663
|
+
integration?: {
|
|
2664
|
+
id: number;
|
|
2665
|
+
helphub_view_article_button_hidden: boolean | undefined;
|
|
2666
|
+
} | null | undefined;
|
|
2667
|
+
}>;
|
|
2668
|
+
export declare const listAnswers: (orgUID: string) => Promise<({
|
|
2669
|
+
id: number;
|
|
2670
|
+
text: string;
|
|
2671
|
+
template: ({
|
|
2672
|
+
type: "admin";
|
|
2673
|
+
value: string;
|
|
2674
|
+
} & {} & {
|
|
2675
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
|
2676
|
+
object?: string | undefined;
|
|
2677
|
+
hoverTooltip?: boolean | undefined;
|
|
2678
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2679
|
+
metadata?: {
|
|
2680
|
+
[key: string]: unknown;
|
|
2681
|
+
} | undefined;
|
|
2682
|
+
}) | ({
|
|
2683
|
+
type: "callback";
|
|
2684
|
+
value: string;
|
|
2685
|
+
} & {} & {
|
|
2686
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
|
2687
|
+
object?: string | undefined;
|
|
2688
|
+
hoverTooltip?: boolean | undefined;
|
|
2689
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2690
|
+
metadata?: {
|
|
2691
|
+
[key: string]: unknown;
|
|
2692
|
+
} | undefined;
|
|
2693
|
+
}) | ({
|
|
2694
|
+
type: "link";
|
|
2695
|
+
value: string;
|
|
2696
|
+
} & {
|
|
2697
|
+
operation?: "self" | "router" | "blank" | undefined;
|
|
2698
|
+
} & {} & {
|
|
2699
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
|
2700
|
+
object?: string | undefined;
|
|
2701
|
+
hoverTooltip?: boolean | undefined;
|
|
2702
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2703
|
+
metadata?: {
|
|
2704
|
+
[key: string]: unknown;
|
|
2705
|
+
} | undefined;
|
|
2706
|
+
}) | ({
|
|
2707
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
2708
|
+
value: string[];
|
|
2709
|
+
} & {} & {
|
|
2710
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
|
2711
|
+
object?: string | undefined;
|
|
2712
|
+
hoverTooltip?: boolean | undefined;
|
|
2713
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2714
|
+
metadata?: {
|
|
2715
|
+
[key: string]: unknown;
|
|
2716
|
+
} | undefined;
|
|
2717
|
+
}) | ({
|
|
2718
|
+
type: "builtin";
|
|
2719
|
+
value: string;
|
|
2720
|
+
} & {} & {
|
|
2721
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
|
2722
|
+
object?: string | undefined;
|
|
2723
|
+
hoverTooltip?: boolean | undefined;
|
|
2724
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2725
|
+
metadata?: {
|
|
2726
|
+
[key: string]: unknown;
|
|
2727
|
+
} | undefined;
|
|
1656
2728
|
}) | ({
|
|
1657
2729
|
type: "webhook";
|
|
1658
2730
|
value: string;
|
|
@@ -1661,6 +2733,9 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
|
1661
2733
|
object?: string | undefined;
|
|
1662
2734
|
hoverTooltip?: boolean | undefined;
|
|
1663
2735
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2736
|
+
metadata?: {
|
|
2737
|
+
[key: string]: unknown;
|
|
2738
|
+
} | undefined;
|
|
1664
2739
|
}) | ({
|
|
1665
2740
|
type: "script";
|
|
1666
2741
|
value: string;
|
|
@@ -1669,6 +2744,9 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
|
1669
2744
|
object?: string | undefined;
|
|
1670
2745
|
hoverTooltip?: boolean | undefined;
|
|
1671
2746
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2747
|
+
metadata?: {
|
|
2748
|
+
[key: string]: unknown;
|
|
2749
|
+
} | undefined;
|
|
1672
2750
|
}) | ({
|
|
1673
2751
|
type: "request";
|
|
1674
2752
|
value: {
|
|
@@ -1690,6 +2768,9 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
|
1690
2768
|
object?: string | undefined;
|
|
1691
2769
|
hoverTooltip?: boolean | undefined;
|
|
1692
2770
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2771
|
+
metadata?: {
|
|
2772
|
+
[key: string]: unknown;
|
|
2773
|
+
} | undefined;
|
|
1693
2774
|
}) | ({
|
|
1694
2775
|
type: "appcues";
|
|
1695
2776
|
value: string;
|
|
@@ -1698,6 +2779,20 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
|
1698
2779
|
object?: string | undefined;
|
|
1699
2780
|
hoverTooltip?: boolean | undefined;
|
|
1700
2781
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2782
|
+
metadata?: {
|
|
2783
|
+
[key: string]: unknown;
|
|
2784
|
+
} | undefined;
|
|
2785
|
+
}) | ({
|
|
2786
|
+
type: "pendo_guide";
|
|
2787
|
+
value: string;
|
|
2788
|
+
} & {} & {
|
|
2789
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
|
2790
|
+
object?: string | undefined;
|
|
2791
|
+
hoverTooltip?: boolean | undefined;
|
|
2792
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2793
|
+
metadata?: {
|
|
2794
|
+
[key: string]: unknown;
|
|
2795
|
+
} | undefined;
|
|
1701
2796
|
}) | ({
|
|
1702
2797
|
type: "video";
|
|
1703
2798
|
value: string;
|
|
@@ -1706,6 +2801,9 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
|
1706
2801
|
object?: string | undefined;
|
|
1707
2802
|
hoverTooltip?: boolean | undefined;
|
|
1708
2803
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2804
|
+
metadata?: {
|
|
2805
|
+
[key: string]: unknown;
|
|
2806
|
+
} | undefined;
|
|
1709
2807
|
}) | ({
|
|
1710
2808
|
type: "helpdoc";
|
|
1711
2809
|
value: string;
|
|
@@ -1722,16 +2820,24 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
|
1722
2820
|
object?: string | undefined;
|
|
1723
2821
|
hoverTooltip?: boolean | undefined;
|
|
1724
2822
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2823
|
+
metadata?: {
|
|
2824
|
+
[key: string]: unknown;
|
|
2825
|
+
} | undefined;
|
|
1725
2826
|
}) | ({
|
|
1726
2827
|
type: "trigger";
|
|
1727
2828
|
value: {
|
|
1728
2829
|
type: "execute_command";
|
|
1729
2830
|
meta: {
|
|
1730
2831
|
command: string;
|
|
2832
|
+
} & {
|
|
2833
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
|
1731
2834
|
};
|
|
1732
2835
|
} | {
|
|
1733
2836
|
type: "click";
|
|
1734
2837
|
value: string;
|
|
2838
|
+
} | {
|
|
2839
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
2840
|
+
value: string[];
|
|
1735
2841
|
} | ({
|
|
1736
2842
|
type: "link";
|
|
1737
2843
|
value: string;
|
|
@@ -1740,7 +2846,7 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
|
1740
2846
|
}) | {
|
|
1741
2847
|
type: "open_chat";
|
|
1742
2848
|
meta: {
|
|
1743
|
-
type:
|
|
2849
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
|
1744
2850
|
};
|
|
1745
2851
|
} | {
|
|
1746
2852
|
type: "dismiss";
|
|
@@ -1763,6 +2869,10 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
|
1763
2869
|
value?: string | undefined;
|
|
1764
2870
|
categoryFilter?: number | undefined;
|
|
1765
2871
|
}) | {
|
|
2872
|
+
type: "open_helphub";
|
|
2873
|
+
} | {
|
|
2874
|
+
type: "open_copilot";
|
|
2875
|
+
} | {
|
|
1766
2876
|
type: "no_action";
|
|
1767
2877
|
};
|
|
1768
2878
|
} & {} & {
|
|
@@ -1770,6 +2880,9 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
|
1770
2880
|
object?: string | undefined;
|
|
1771
2881
|
hoverTooltip?: boolean | undefined;
|
|
1772
2882
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
|
2883
|
+
metadata?: {
|
|
2884
|
+
[key: string]: unknown;
|
|
2885
|
+
} | undefined;
|
|
1773
2886
|
});
|
|
1774
2887
|
} & {
|
|
1775
2888
|
disabledReason?: string | undefined;
|
|
@@ -1859,8 +2972,8 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
|
1859
2972
|
};
|
|
1860
2973
|
tags: string[];
|
|
1861
2974
|
availability_rules: (({
|
|
1862
|
-
type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "
|
|
1863
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "
|
|
2975
|
+
type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
|
|
2976
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
|
1864
2977
|
} & {
|
|
1865
2978
|
field?: string | undefined;
|
|
1866
2979
|
value?: string | undefined;
|
|
@@ -1892,8 +3005,8 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
|
1892
3005
|
} & {
|
|
1893
3006
|
reason?: string | undefined;
|
|
1894
3007
|
}) | ({
|
|
1895
|
-
type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "
|
|
1896
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "
|
|
3008
|
+
type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
|
|
3009
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
|
1897
3010
|
} & {
|
|
1898
3011
|
field?: string | undefined;
|
|
1899
3012
|
value?: string | undefined;
|
|
@@ -1921,8 +3034,8 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
|
1921
3034
|
reason?: string | undefined;
|
|
1922
3035
|
}))[];
|
|
1923
3036
|
recommend_rules: (({
|
|
1924
|
-
type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "
|
|
1925
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "
|
|
3037
|
+
type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
|
|
3038
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
|
1926
3039
|
} & {
|
|
1927
3040
|
field?: string | undefined;
|
|
1928
3041
|
value?: string | undefined;
|
|
@@ -1962,8 +3075,8 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
|
1962
3075
|
} & {
|
|
1963
3076
|
reason?: string | undefined;
|
|
1964
3077
|
}) | ({
|
|
1965
|
-
type: "url" | "element" | "context" | "device_type" | "sessions" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "
|
|
1966
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "
|
|
3078
|
+
type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
|
|
3079
|
+
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
|
|
1967
3080
|
} & {
|
|
1968
3081
|
field?: string | undefined;
|
|
1969
3082
|
value?: string | undefined;
|
|
@@ -2065,10 +3178,15 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
|
2065
3178
|
type: "execute_command";
|
|
2066
3179
|
meta: {
|
|
2067
3180
|
command: string;
|
|
3181
|
+
} & {
|
|
3182
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
|
2068
3183
|
};
|
|
2069
3184
|
} | {
|
|
2070
3185
|
type: "click";
|
|
2071
3186
|
value: string;
|
|
3187
|
+
} | {
|
|
3188
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
3189
|
+
value: string[];
|
|
2072
3190
|
} | ({
|
|
2073
3191
|
type: "link";
|
|
2074
3192
|
value: string;
|
|
@@ -2077,7 +3195,7 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
|
2077
3195
|
}) | {
|
|
2078
3196
|
type: "open_chat";
|
|
2079
3197
|
meta: {
|
|
2080
|
-
type:
|
|
3198
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
|
2081
3199
|
};
|
|
2082
3200
|
} | {
|
|
2083
3201
|
type: "dismiss";
|
|
@@ -2100,6 +3218,10 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
|
2100
3218
|
value?: string | undefined;
|
|
2101
3219
|
categoryFilter?: number | undefined;
|
|
2102
3220
|
}) | {
|
|
3221
|
+
type: "open_helphub";
|
|
3222
|
+
} | {
|
|
3223
|
+
type: "open_copilot";
|
|
3224
|
+
} | {
|
|
2103
3225
|
type: "no_action";
|
|
2104
3226
|
};
|
|
2105
3227
|
})[];
|
|
@@ -2109,8 +3231,11 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
|
2109
3231
|
deny?: string[] | null | undefined;
|
|
2110
3232
|
};
|
|
2111
3233
|
copilot_suggest: boolean;
|
|
3234
|
+
show_in_spotlight_search: boolean;
|
|
3235
|
+
show_in_helphub_search: boolean;
|
|
2112
3236
|
copilot_cta_label: string;
|
|
2113
3237
|
copilot_description: string;
|
|
3238
|
+
editor_tags: string[];
|
|
2114
3239
|
} & {
|
|
2115
3240
|
third_party_source?: string | null | undefined;
|
|
2116
3241
|
third_party_id?: string | null | undefined;
|
|
@@ -2171,6 +3296,12 @@ export declare const listRules: (orgUID: string) => Promise<({
|
|
|
2171
3296
|
} & {
|
|
2172
3297
|
is_audience: boolean;
|
|
2173
3298
|
})[]>;
|
|
3299
|
+
export declare const listUserProperties: (orgUID: string) => (params?: Record<string, string> | undefined, callbacks?: {
|
|
3300
|
+
onSuccess?: (() => void) | undefined;
|
|
3301
|
+
onError?: ((err: string) => void) | undefined;
|
|
3302
|
+
} | undefined) => Promise<{
|
|
3303
|
+
keys: string[];
|
|
3304
|
+
}>;
|
|
2174
3305
|
export declare const readHealth: (arg0: string, urlArgs?: {
|
|
2175
3306
|
[arg: string]: string;
|
|
2176
3307
|
} | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
|
@@ -2208,28 +3339,12 @@ export declare const updateInternal: (object: {
|
|
|
2208
3339
|
};
|
|
2209
3340
|
};
|
|
2210
3341
|
}>;
|
|
2211
|
-
export declare const readDashboardFlags: (params?: Record<string, string> | undefined, callbacks?: {
|
|
2212
|
-
onSuccess?: (() => void) | undefined;
|
|
2213
|
-
onError?: ((err: string) => void) | undefined;
|
|
2214
|
-
} | undefined) => Promise<{
|
|
2215
|
-
show_onboarding: boolean;
|
|
2216
|
-
show_appsumo_onboarding: boolean;
|
|
2217
|
-
}>;
|
|
2218
|
-
export declare const updateDashboardFlags: (object: {
|
|
2219
|
-
show_onboarding?: boolean | undefined;
|
|
2220
|
-
show_appsumo_onboarding?: boolean | undefined;
|
|
2221
|
-
}, params?: Record<string, string> | undefined, callbacks?: {
|
|
2222
|
-
onSuccess?: (() => void) | undefined;
|
|
2223
|
-
onError?: ((err: string) => void) | undefined;
|
|
2224
|
-
} | undefined) => Promise<{
|
|
2225
|
-
show_onboarding: boolean;
|
|
2226
|
-
show_appsumo_onboarding: boolean;
|
|
2227
|
-
}>;
|
|
2228
3342
|
export declare const decode: (data: any) => {
|
|
2229
3343
|
id: string | number;
|
|
2230
3344
|
name: string;
|
|
2231
3345
|
created: string;
|
|
2232
3346
|
} & {} & {
|
|
3347
|
+
disabled: boolean;
|
|
2233
3348
|
launcher_type: "alternate" | "none" | "prompt" | "minimal";
|
|
2234
3349
|
launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
|
2235
3350
|
show_launcher_recommendations: boolean;
|
|
@@ -2238,6 +3353,36 @@ export declare const decode: (data: any) => {
|
|
|
2238
3353
|
launcher_offset_y: number;
|
|
2239
3354
|
base_url: string;
|
|
2240
3355
|
theme: object;
|
|
3356
|
+
themeV2: {
|
|
3357
|
+
light_mode: {
|
|
3358
|
+
var_defaults: {
|
|
3359
|
+
[x: string]: string | number;
|
|
3360
|
+
};
|
|
3361
|
+
var_overrides: {
|
|
3362
|
+
[x: string]: string | number;
|
|
3363
|
+
};
|
|
3364
|
+
component_overrides: {
|
|
3365
|
+
[x: string]: any;
|
|
3366
|
+
};
|
|
3367
|
+
mobile_overrides: {
|
|
3368
|
+
[x: string]: any;
|
|
3369
|
+
};
|
|
3370
|
+
};
|
|
3371
|
+
dark_mode: {
|
|
3372
|
+
var_defaults: {
|
|
3373
|
+
[x: string]: string | number;
|
|
3374
|
+
};
|
|
3375
|
+
var_overrides: {
|
|
3376
|
+
[x: string]: string | number;
|
|
3377
|
+
};
|
|
3378
|
+
component_overrides: {
|
|
3379
|
+
[x: string]: any;
|
|
3380
|
+
};
|
|
3381
|
+
mobile_overrides: {
|
|
3382
|
+
[x: string]: any;
|
|
3383
|
+
};
|
|
3384
|
+
};
|
|
3385
|
+
} | null | undefined;
|
|
2241
3386
|
icon: string;
|
|
2242
3387
|
icon_suggest: string;
|
|
2243
3388
|
icon_tutorial: string;
|
|
@@ -2332,6 +3477,7 @@ export declare const decode: (data: any) => {
|
|
|
2332
3477
|
slash_filters_enabled: boolean;
|
|
2333
3478
|
recents_sort_key: number | null;
|
|
2334
3479
|
recommended_sort_key: number | null;
|
|
3480
|
+
experiences_sort_key: number | null;
|
|
2335
3481
|
show_suggested_synonyms: boolean;
|
|
2336
3482
|
has_hotloaded_help_docs: boolean;
|
|
2337
3483
|
bar_enabled: boolean;
|
|
@@ -2347,10 +3493,70 @@ export declare const decode: (data: any) => {
|
|
|
2347
3493
|
type: "execute_command";
|
|
2348
3494
|
meta: {
|
|
2349
3495
|
command: string;
|
|
3496
|
+
} & {
|
|
3497
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
|
3498
|
+
};
|
|
3499
|
+
} | {
|
|
3500
|
+
type: "click";
|
|
3501
|
+
value: string;
|
|
3502
|
+
} | {
|
|
3503
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
3504
|
+
value: string[];
|
|
3505
|
+
} | ({
|
|
3506
|
+
type: "link";
|
|
3507
|
+
value: string;
|
|
3508
|
+
} & {
|
|
3509
|
+
operation?: "self" | "router" | "blank" | undefined;
|
|
3510
|
+
}) | {
|
|
3511
|
+
type: "open_chat";
|
|
3512
|
+
meta: {
|
|
3513
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
|
3514
|
+
};
|
|
3515
|
+
} | {
|
|
3516
|
+
type: "dismiss";
|
|
3517
|
+
} | {
|
|
3518
|
+
type: "snooze";
|
|
3519
|
+
} | {
|
|
3520
|
+
type: "questlist";
|
|
3521
|
+
value: number;
|
|
3522
|
+
} | {
|
|
3523
|
+
type: "step_back";
|
|
3524
|
+
} | {
|
|
3525
|
+
type: "nudge";
|
|
3526
|
+
value: number;
|
|
3527
|
+
} | {
|
|
3528
|
+
type: "go_to_step";
|
|
3529
|
+
value: number;
|
|
3530
|
+
} | ({
|
|
3531
|
+
type: "open_bar";
|
|
3532
|
+
} & {
|
|
3533
|
+
value?: string | undefined;
|
|
3534
|
+
categoryFilter?: number | undefined;
|
|
3535
|
+
}) | {
|
|
3536
|
+
type: "open_helphub";
|
|
3537
|
+
} | {
|
|
3538
|
+
type: "open_copilot";
|
|
3539
|
+
} | {
|
|
3540
|
+
type: "no_action";
|
|
3541
|
+
};
|
|
3542
|
+
}[];
|
|
3543
|
+
copilot_negative_feedback_fallback_enabled: boolean;
|
|
3544
|
+
copilot_negative_feedback_fallback_message: string | null;
|
|
3545
|
+
copilot_negative_feedback_fallback_actions: {
|
|
3546
|
+
cta: string;
|
|
3547
|
+
action: {
|
|
3548
|
+
type: "execute_command";
|
|
3549
|
+
meta: {
|
|
3550
|
+
command: string;
|
|
3551
|
+
} & {
|
|
3552
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
|
2350
3553
|
};
|
|
2351
3554
|
} | {
|
|
2352
3555
|
type: "click";
|
|
2353
3556
|
value: string;
|
|
3557
|
+
} | {
|
|
3558
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
3559
|
+
value: string[];
|
|
2354
3560
|
} | ({
|
|
2355
3561
|
type: "link";
|
|
2356
3562
|
value: string;
|
|
@@ -2359,7 +3565,7 @@ export declare const decode: (data: any) => {
|
|
|
2359
3565
|
}) | {
|
|
2360
3566
|
type: "open_chat";
|
|
2361
3567
|
meta: {
|
|
2362
|
-
type:
|
|
3568
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
|
2363
3569
|
};
|
|
2364
3570
|
} | {
|
|
2365
3571
|
type: "dismiss";
|
|
@@ -2382,10 +3588,24 @@ export declare const decode: (data: any) => {
|
|
|
2382
3588
|
value?: string | undefined;
|
|
2383
3589
|
categoryFilter?: number | undefined;
|
|
2384
3590
|
}) | {
|
|
3591
|
+
type: "open_helphub";
|
|
3592
|
+
} | {
|
|
3593
|
+
type: "open_copilot";
|
|
3594
|
+
} | {
|
|
2385
3595
|
type: "no_action";
|
|
2386
3596
|
};
|
|
2387
3597
|
}[];
|
|
2388
3598
|
helphub_manual_suggested_queries: string[];
|
|
3599
|
+
copilot_name: string;
|
|
3600
|
+
copilot_avatar: string;
|
|
3601
|
+
copilot_personality: {
|
|
3602
|
+
template: "professional" | "friendly" | "confident" | "serious" | "empathetic";
|
|
3603
|
+
} | {
|
|
3604
|
+
template: "custom";
|
|
3605
|
+
adjectives: ("assertive" | "brave" | "empathetic" | "abrasive" | "adventurous" | "affable" | "arrogant" | "assured" | "belligerent" | "cheerful" | "compassionate" | "condescending" | "courteous" | "creative" | "cynical" | "decisive" | "detached" | "diligent" | "eloquent" | "evasive" | "formal" | "frivolous" | "garrulous" | "generous" | "impulsive" | "innovative" | "intense" | "judgmental" | "jovial" | "manipulative" | "obstinate" | "optimistic" | "perceptive" | "pessimistic" | "quarrelsome" | "respectful" | "resourceful" | "sarcastic" | "sincere" | "sociable" | "solemn" | "supportive" | "tactful" | "thoughtful" | "understanding" | "unreliable" | "vain" | "vivacious" | "warm" | "withdrawn" | "witty" | "zealous")[];
|
|
3606
|
+
response_length: "long" | "short" | "conversational";
|
|
3607
|
+
response_format: "mixed" | "lists" | "paragraphs";
|
|
3608
|
+
};
|
|
2389
3609
|
nudge_rate_limit: number | null;
|
|
2390
3610
|
bar_hide_completed_nudges_questlists: boolean;
|
|
2391
3611
|
nudge_rate_period: "day" | "week" | "session";
|
|
@@ -2419,6 +3639,9 @@ export declare const decode: (data: any) => {
|
|
|
2419
3639
|
posthog?: {
|
|
2420
3640
|
enabled: boolean;
|
|
2421
3641
|
} | undefined;
|
|
3642
|
+
rudderstack?: {
|
|
3643
|
+
enabled: boolean;
|
|
3644
|
+
} | undefined;
|
|
2422
3645
|
slack?: {
|
|
2423
3646
|
channelId: string;
|
|
2424
3647
|
configuration: {
|
|
@@ -2433,6 +3656,10 @@ export declare const decode: (data: any) => {
|
|
|
2433
3656
|
} | undefined;
|
|
2434
3657
|
};
|
|
2435
3658
|
copilot_enabled: boolean;
|
|
3659
|
+
user_property_targeting: boolean;
|
|
3660
|
+
ab_test_conditions: boolean;
|
|
3661
|
+
spotlight_ask_copilot_enabled: boolean;
|
|
3662
|
+
spotlight_ask_copilot_label: string | null;
|
|
2436
3663
|
helphub_ai_enabled: boolean;
|
|
2437
3664
|
copilot_experiences_enabled: boolean;
|
|
2438
3665
|
helphub_chat_only_mode: boolean;
|
|
@@ -2441,10 +3668,10 @@ export declare const decode: (data: any) => {
|
|
|
2441
3668
|
helphub_launcher_offset_y: number;
|
|
2442
3669
|
helphub_launcher_anchor: string;
|
|
2443
3670
|
helphub_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
|
2444
|
-
helphub_launcher_type: "none" | "custom" | "
|
|
3671
|
+
helphub_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
|
|
2445
3672
|
helphub_mobile_launcher_offset_x: number;
|
|
2446
3673
|
helphub_mobile_launcher_offset_y: number;
|
|
2447
3674
|
helphub_mobile_launcher_anchor: string;
|
|
2448
3675
|
helphub_mobile_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
|
2449
|
-
helphub_mobile_launcher_type: "none" | "custom" | "
|
|
3676
|
+
helphub_mobile_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
|
|
2450
3677
|
};
|