commandbar 1.8.7 → 1.10.0
Sign up to get free protection for your applications and to get access to all the features.
- package/build/{internal/src/client → commandbar/src/shared/services/analytics}/EventHandler.d.ts +51 -15
- 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 +8 -0
- package/build/internal/src/client/CommandBarClientSDK.d.ts +70 -19
- package/build/internal/src/client/CommandBarProxySDK.d.ts +3 -3
- package/build/internal/src/client/CommandBarSDK.d.ts +34 -18
- package/build/internal/src/client/SDKConfig.d.ts +3 -2
- package/build/internal/src/client/globals.d.ts +6 -0
- package/build/internal/src/client/symbols.d.ts +13 -6
- package/build/internal/src/middleware/CommandFromClientV.d.ts +88 -18
- package/build/internal/src/middleware/IRecordSettings.d.ts +3 -0
- package/build/internal/src/middleware/OrganizationV.d.ts +320 -22
- package/build/internal/src/middleware/{ResourceSettingsV.d.ts → RecordSettingsV.d.ts} +2 -2
- package/build/internal/src/middleware/additionalResource.d.ts +270 -27
- package/build/internal/src/middleware/billing.d.ts +31 -0
- package/build/internal/src/middleware/chat.d.ts +12933 -0
- package/build/internal/src/middleware/checklist.d.ts +589 -70
- package/build/internal/src/middleware/command.d.ts +5433 -677
- package/build/internal/src/middleware/detailPreview.d.ts +12 -1
- package/build/internal/src/middleware/endUser.d.ts +132 -0
- 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/generics.d.ts +12 -11
- package/build/internal/src/middleware/helpDocsIntegration.d.ts +63 -8
- package/build/internal/src/middleware/helpDocsSearch.d.ts +2540 -0
- package/build/internal/src/middleware/helpHub.d.ts +26 -0
- package/build/internal/src/middleware/helpers/actions.d.ts +174 -16
- package/build/internal/src/middleware/helpers/commandTemplate.d.ts +144 -2
- 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 +28 -0
- package/build/internal/src/middleware/helpers/rules.d.ts +318 -50
- package/build/internal/src/middleware/network.d.ts +27 -3
- package/build/internal/src/middleware/nudge.d.ts +2220 -91
- package/build/internal/src/middleware/organization.d.ts +2289 -152
- package/build/internal/src/middleware/organizationSettings.d.ts +435 -20
- package/build/internal/src/middleware/profile.d.ts +2 -0
- package/build/internal/src/middleware/recommendationSet.d.ts +489 -1007
- package/build/internal/src/middleware/releases.d.ts +1 -1
- package/build/internal/src/middleware/theme.d.ts +425 -0
- package/build/internal/src/middleware/types.d.ts +88 -34
- package/build/internal/src/middleware/user.d.ts +1 -0
- package/build/internal/src/util/dispatchCustomEvent.d.ts +5 -3
- package/build/internal/src/util/operatingSystem.d.ts +11 -0
- package/build/internal/src/util/sentry.d.ts +23 -0
- package/package.json +3 -3
- package/src/index.ts +2 -2
- package/src/init.ts +11 -6
- package/src/snippet.ts +2 -2
- package/build/internal/src/client/AnalyticsEventTypes.d.ts +0 -1
- package/build/internal/src/client/SentryReporter.d.ts +0 -63
- package/build/internal/src/middleware/IResourceSettings.d.ts +0 -3
- package/build/internal/src/middleware/chatAnalytics.d.ts +0 -2601
- package/build/internal/src/middleware/dashboardFlags.d.ts +0 -9
- package/build/internal/src/middleware/helpers/endUser.d.ts +0 -11
- package/build/internal/src/middleware/qaPair.d.ts +0 -676
- package/build/internal/src/util/integrations.d.ts +0 -1
@@ -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,9 +10,12 @@ 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
|
-
integrations: t.RecordC<t.StringC, t.RecordC<t.StringC, t.
|
18
|
+
integrations: t.RecordC<t.StringC, t.RecordC<t.StringC, t.AnyC>>;
|
16
19
|
}>;
|
17
20
|
export declare const read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
|
18
21
|
onSuccess?: (() => void) | undefined;
|
@@ -22,19 +25,45 @@ 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
|
-
launcher_position: "
|
30
|
+
launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
27
31
|
show_launcher_recommendations: boolean;
|
28
32
|
recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
|
29
33
|
launcher_offset_x: number;
|
30
34
|
launcher_offset_y: number;
|
31
|
-
helphub_launcher_offset_x: number;
|
32
|
-
helphub_launcher_offset_y: number;
|
33
|
-
helphub_launcher_anchor: string;
|
34
|
-
helphub_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
35
|
-
helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle";
|
36
35
|
base_url: string;
|
37
36
|
theme: object;
|
37
|
+
themeV2: {
|
38
|
+
light_mode: {
|
39
|
+
var_defaults: {
|
40
|
+
[x: string]: string;
|
41
|
+
};
|
42
|
+
var_overrides: {
|
43
|
+
[x: string]: string;
|
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;
|
55
|
+
};
|
56
|
+
var_overrides: {
|
57
|
+
[x: string]: string;
|
58
|
+
};
|
59
|
+
component_overrides: {
|
60
|
+
[x: string]: any;
|
61
|
+
};
|
62
|
+
mobile_overrides: {
|
63
|
+
[x: string]: any;
|
64
|
+
};
|
65
|
+
};
|
66
|
+
} | null | undefined;
|
38
67
|
icon: string;
|
39
68
|
icon_suggest: string;
|
40
69
|
icon_tutorial: string;
|
@@ -77,23 +106,23 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
77
106
|
setting_pin_to_bottom?: boolean | undefined;
|
78
107
|
track_recents?: boolean | undefined;
|
79
108
|
detail?: string | ({
|
80
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
109
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
81
110
|
value: string;
|
82
111
|
} & {
|
83
112
|
position?: "inline" | "popover" | undefined;
|
84
113
|
}) | (string | ({
|
85
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
114
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
86
115
|
value: string;
|
87
116
|
} & {
|
88
117
|
position?: "inline" | "popover" | undefined;
|
89
118
|
}))[] | null | undefined;
|
90
119
|
content?: string | ({
|
91
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
120
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
92
121
|
value: string;
|
93
122
|
} & {
|
94
123
|
position?: "inline" | "popover" | undefined;
|
95
124
|
}) | (string | ({
|
96
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
125
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
97
126
|
value: string;
|
98
127
|
} & {
|
99
128
|
position?: "inline" | "popover" | undefined;
|
@@ -129,15 +158,14 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
129
158
|
slash_filters_enabled: boolean;
|
130
159
|
recents_sort_key: number | null;
|
131
160
|
recommended_sort_key: number | null;
|
161
|
+
experiences_sort_key: number | null;
|
132
162
|
show_suggested_synonyms: boolean;
|
133
163
|
has_hotloaded_help_docs: boolean;
|
134
164
|
bar_enabled: boolean;
|
135
165
|
in_bar_doc_search: boolean;
|
136
166
|
featured_item_cards: boolean;
|
137
|
-
helphub_ai_enabled: boolean;
|
138
167
|
helphub_suggested_queries_enabled: boolean;
|
139
168
|
helphub_continuations_enabled: boolean;
|
140
|
-
helphub_chat_only_mode: boolean;
|
141
169
|
helphub_enabled: boolean;
|
142
170
|
helphub_chat_fallback_message: string | null;
|
143
171
|
helphub_chat_fallback_actions: {
|
@@ -146,12 +174,70 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
146
174
|
type: "execute_command";
|
147
175
|
meta: {
|
148
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";
|
149
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";
|
150
220
|
} | {
|
151
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;
|
234
|
+
};
|
152
235
|
} | {
|
153
236
|
type: "click";
|
154
237
|
value: string;
|
238
|
+
} | {
|
239
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
240
|
+
value: string[];
|
155
241
|
} | ({
|
156
242
|
type: "link";
|
157
243
|
value: string;
|
@@ -160,16 +246,51 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
160
246
|
}) | {
|
161
247
|
type: "open_chat";
|
162
248
|
meta: {
|
163
|
-
type:
|
249
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
164
250
|
};
|
165
251
|
} | {
|
166
252
|
type: "dismiss";
|
253
|
+
} | {
|
254
|
+
type: "snooze";
|
255
|
+
} | {
|
256
|
+
type: "questlist";
|
257
|
+
value: number;
|
258
|
+
} | {
|
259
|
+
type: "step_back";
|
260
|
+
} | {
|
261
|
+
type: "nudge";
|
262
|
+
value: number;
|
263
|
+
} | {
|
264
|
+
type: "go_to_step";
|
265
|
+
value: number;
|
266
|
+
} | ({
|
267
|
+
type: "open_bar";
|
268
|
+
} & {
|
269
|
+
value?: string | undefined;
|
270
|
+
categoryFilter?: number | undefined;
|
271
|
+
}) | {
|
272
|
+
type: "open_helphub";
|
273
|
+
} | {
|
274
|
+
type: "open_copilot";
|
275
|
+
} | {
|
276
|
+
type: "no_action";
|
167
277
|
};
|
168
278
|
}[];
|
169
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
|
+
};
|
170
290
|
nudge_rate_limit: number | null;
|
171
291
|
bar_hide_completed_nudges_questlists: boolean;
|
172
292
|
nudge_rate_period: "day" | "week" | "session";
|
293
|
+
share_link_param: string;
|
173
294
|
installed_at: string | null;
|
174
295
|
integrations: {
|
175
296
|
algolia?: {
|
@@ -187,26 +308,98 @@ export declare const read: (arg0: string, params?: Record<string, string> | unde
|
|
187
308
|
};
|
188
309
|
send_events_to_heap: boolean;
|
189
310
|
} | undefined;
|
311
|
+
amplitude?: {
|
312
|
+
enabled: boolean;
|
313
|
+
} | undefined;
|
314
|
+
logrocket?: {
|
315
|
+
enabled: boolean;
|
316
|
+
} | undefined;
|
317
|
+
mixpanel?: {
|
318
|
+
enabled: boolean;
|
319
|
+
} | undefined;
|
320
|
+
posthog?: {
|
321
|
+
enabled: boolean;
|
322
|
+
} | undefined;
|
323
|
+
rudderstack?: {
|
324
|
+
enabled: boolean;
|
325
|
+
} | undefined;
|
326
|
+
slack?: {
|
327
|
+
channelId: string;
|
328
|
+
configuration: {
|
329
|
+
analytic_events: string[];
|
330
|
+
};
|
331
|
+
} | undefined;
|
332
|
+
hubspot?: {
|
333
|
+
send_events_to_hubspot?: boolean | undefined;
|
334
|
+
lists?: {
|
335
|
+
[x: string]: string;
|
336
|
+
} | undefined;
|
337
|
+
} | undefined;
|
190
338
|
};
|
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;
|
344
|
+
helphub_ai_enabled: boolean;
|
345
|
+
copilot_experiences_enabled: boolean;
|
346
|
+
helphub_chat_only_mode: boolean;
|
347
|
+
} & {
|
348
|
+
helphub_launcher_offset_x: number;
|
349
|
+
helphub_launcher_offset_y: number;
|
350
|
+
helphub_launcher_anchor: string;
|
351
|
+
helphub_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
352
|
+
helphub_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
|
353
|
+
helphub_mobile_launcher_offset_x: number;
|
354
|
+
helphub_mobile_launcher_offset_y: number;
|
355
|
+
helphub_mobile_launcher_anchor: string;
|
356
|
+
helphub_mobile_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
357
|
+
helphub_mobile_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
|
191
358
|
}>;
|
192
359
|
export declare const update: (object: {
|
193
360
|
id: string | number;
|
194
361
|
name: string;
|
195
362
|
created: string;
|
196
363
|
} & {} & {
|
364
|
+
disabled: boolean;
|
197
365
|
launcher_type: "alternate" | "none" | "prompt" | "minimal";
|
198
|
-
launcher_position: "
|
366
|
+
launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
199
367
|
show_launcher_recommendations: boolean;
|
200
368
|
recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
|
201
369
|
launcher_offset_x: number;
|
202
370
|
launcher_offset_y: number;
|
203
|
-
helphub_launcher_offset_x: number;
|
204
|
-
helphub_launcher_offset_y: number;
|
205
|
-
helphub_launcher_anchor: string;
|
206
|
-
helphub_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
207
|
-
helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle";
|
208
371
|
base_url: string;
|
209
372
|
theme: object;
|
373
|
+
themeV2: {
|
374
|
+
light_mode: {
|
375
|
+
var_defaults: {
|
376
|
+
[x: string]: string;
|
377
|
+
};
|
378
|
+
var_overrides: {
|
379
|
+
[x: string]: string;
|
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;
|
391
|
+
};
|
392
|
+
var_overrides: {
|
393
|
+
[x: string]: string;
|
394
|
+
};
|
395
|
+
component_overrides: {
|
396
|
+
[x: string]: any;
|
397
|
+
};
|
398
|
+
mobile_overrides: {
|
399
|
+
[x: string]: any;
|
400
|
+
};
|
401
|
+
};
|
402
|
+
} | null | undefined;
|
210
403
|
icon: string;
|
211
404
|
icon_suggest: string;
|
212
405
|
icon_tutorial: string;
|
@@ -249,23 +442,23 @@ export declare const update: (object: {
|
|
249
442
|
setting_pin_to_bottom?: boolean | undefined;
|
250
443
|
track_recents?: boolean | undefined;
|
251
444
|
detail?: string | ({
|
252
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
445
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
253
446
|
value: string;
|
254
447
|
} & {
|
255
448
|
position?: "inline" | "popover" | undefined;
|
256
449
|
}) | (string | ({
|
257
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
450
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
258
451
|
value: string;
|
259
452
|
} & {
|
260
453
|
position?: "inline" | "popover" | undefined;
|
261
454
|
}))[] | null | undefined;
|
262
455
|
content?: string | ({
|
263
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
456
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
264
457
|
value: string;
|
265
458
|
} & {
|
266
459
|
position?: "inline" | "popover" | undefined;
|
267
460
|
}) | (string | ({
|
268
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
461
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
269
462
|
value: string;
|
270
463
|
} & {
|
271
464
|
position?: "inline" | "popover" | undefined;
|
@@ -301,15 +494,14 @@ export declare const update: (object: {
|
|
301
494
|
slash_filters_enabled: boolean;
|
302
495
|
recents_sort_key: number | null;
|
303
496
|
recommended_sort_key: number | null;
|
497
|
+
experiences_sort_key: number | null;
|
304
498
|
show_suggested_synonyms: boolean;
|
305
499
|
has_hotloaded_help_docs: boolean;
|
306
500
|
bar_enabled: boolean;
|
307
501
|
in_bar_doc_search: boolean;
|
308
502
|
featured_item_cards: boolean;
|
309
|
-
helphub_ai_enabled: boolean;
|
310
503
|
helphub_suggested_queries_enabled: boolean;
|
311
504
|
helphub_continuations_enabled: boolean;
|
312
|
-
helphub_chat_only_mode: boolean;
|
313
505
|
helphub_enabled: boolean;
|
314
506
|
helphub_chat_fallback_message: string | null;
|
315
507
|
helphub_chat_fallback_actions: {
|
@@ -318,12 +510,70 @@ export declare const update: (object: {
|
|
318
510
|
type: "execute_command";
|
319
511
|
meta: {
|
320
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";
|
321
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";
|
322
556
|
} | {
|
323
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;
|
570
|
+
};
|
324
571
|
} | {
|
325
572
|
type: "click";
|
326
573
|
value: string;
|
574
|
+
} | {
|
575
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
576
|
+
value: string[];
|
327
577
|
} | ({
|
328
578
|
type: "link";
|
329
579
|
value: string;
|
@@ -332,16 +582,51 @@ export declare const update: (object: {
|
|
332
582
|
}) | {
|
333
583
|
type: "open_chat";
|
334
584
|
meta: {
|
335
|
-
type:
|
585
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
336
586
|
};
|
337
587
|
} | {
|
338
588
|
type: "dismiss";
|
589
|
+
} | {
|
590
|
+
type: "snooze";
|
591
|
+
} | {
|
592
|
+
type: "questlist";
|
593
|
+
value: number;
|
594
|
+
} | {
|
595
|
+
type: "step_back";
|
596
|
+
} | {
|
597
|
+
type: "nudge";
|
598
|
+
value: number;
|
599
|
+
} | {
|
600
|
+
type: "go_to_step";
|
601
|
+
value: number;
|
602
|
+
} | ({
|
603
|
+
type: "open_bar";
|
604
|
+
} & {
|
605
|
+
value?: string | undefined;
|
606
|
+
categoryFilter?: number | undefined;
|
607
|
+
}) | {
|
608
|
+
type: "open_helphub";
|
609
|
+
} | {
|
610
|
+
type: "open_copilot";
|
611
|
+
} | {
|
612
|
+
type: "no_action";
|
339
613
|
};
|
340
614
|
}[];
|
341
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
|
+
};
|
342
626
|
nudge_rate_limit: number | null;
|
343
627
|
bar_hide_completed_nudges_questlists: boolean;
|
344
628
|
nudge_rate_period: "day" | "week" | "session";
|
629
|
+
share_link_param: string;
|
345
630
|
installed_at: string | null;
|
346
631
|
integrations: {
|
347
632
|
algolia?: {
|
@@ -359,25 +644,97 @@ export declare const update: (object: {
|
|
359
644
|
};
|
360
645
|
send_events_to_heap: boolean;
|
361
646
|
} | undefined;
|
647
|
+
amplitude?: {
|
648
|
+
enabled: boolean;
|
649
|
+
} | undefined;
|
650
|
+
logrocket?: {
|
651
|
+
enabled: boolean;
|
652
|
+
} | undefined;
|
653
|
+
mixpanel?: {
|
654
|
+
enabled: boolean;
|
655
|
+
} | undefined;
|
656
|
+
posthog?: {
|
657
|
+
enabled: boolean;
|
658
|
+
} | undefined;
|
659
|
+
rudderstack?: {
|
660
|
+
enabled: boolean;
|
661
|
+
} | undefined;
|
662
|
+
slack?: {
|
663
|
+
channelId: string;
|
664
|
+
configuration: {
|
665
|
+
analytic_events: string[];
|
666
|
+
};
|
667
|
+
} | undefined;
|
668
|
+
hubspot?: {
|
669
|
+
send_events_to_hubspot?: boolean | undefined;
|
670
|
+
lists?: {
|
671
|
+
[x: string]: string;
|
672
|
+
} | undefined;
|
673
|
+
} | undefined;
|
362
674
|
};
|
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;
|
680
|
+
helphub_ai_enabled: boolean;
|
681
|
+
copilot_experiences_enabled: boolean;
|
682
|
+
helphub_chat_only_mode: boolean;
|
683
|
+
} & {
|
684
|
+
helphub_launcher_offset_x: number;
|
685
|
+
helphub_launcher_offset_y: number;
|
686
|
+
helphub_launcher_anchor: string;
|
687
|
+
helphub_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
688
|
+
helphub_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
|
689
|
+
helphub_mobile_launcher_offset_x: number;
|
690
|
+
helphub_mobile_launcher_offset_y: number;
|
691
|
+
helphub_mobile_launcher_anchor: string;
|
692
|
+
helphub_mobile_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
693
|
+
helphub_mobile_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
|
363
694
|
}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
364
695
|
id: string | number;
|
365
696
|
name: string;
|
366
697
|
created: string;
|
367
698
|
} & {} & {
|
699
|
+
disabled: boolean;
|
368
700
|
launcher_type: "alternate" | "none" | "prompt" | "minimal";
|
369
|
-
launcher_position: "
|
701
|
+
launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
370
702
|
show_launcher_recommendations: boolean;
|
371
703
|
recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
|
372
704
|
launcher_offset_x: number;
|
373
705
|
launcher_offset_y: number;
|
374
|
-
helphub_launcher_offset_x: number;
|
375
|
-
helphub_launcher_offset_y: number;
|
376
|
-
helphub_launcher_anchor: string;
|
377
|
-
helphub_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
378
|
-
helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle";
|
379
706
|
base_url: string;
|
380
707
|
theme: object;
|
708
|
+
themeV2: {
|
709
|
+
light_mode: {
|
710
|
+
var_defaults: {
|
711
|
+
[x: string]: string;
|
712
|
+
};
|
713
|
+
var_overrides: {
|
714
|
+
[x: string]: string;
|
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;
|
726
|
+
};
|
727
|
+
var_overrides: {
|
728
|
+
[x: string]: string;
|
729
|
+
};
|
730
|
+
component_overrides: {
|
731
|
+
[x: string]: any;
|
732
|
+
};
|
733
|
+
mobile_overrides: {
|
734
|
+
[x: string]: any;
|
735
|
+
};
|
736
|
+
};
|
737
|
+
} | null | undefined;
|
381
738
|
icon: string;
|
382
739
|
icon_suggest: string;
|
383
740
|
icon_tutorial: string;
|
@@ -420,23 +777,23 @@ export declare const update: (object: {
|
|
420
777
|
setting_pin_to_bottom?: boolean | undefined;
|
421
778
|
track_recents?: boolean | undefined;
|
422
779
|
detail?: string | ({
|
423
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
780
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
424
781
|
value: string;
|
425
782
|
} & {
|
426
783
|
position?: "inline" | "popover" | undefined;
|
427
784
|
}) | (string | ({
|
428
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
785
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
429
786
|
value: string;
|
430
787
|
} & {
|
431
788
|
position?: "inline" | "popover" | undefined;
|
432
789
|
}))[] | null | undefined;
|
433
790
|
content?: string | ({
|
434
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
791
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
435
792
|
value: string;
|
436
793
|
} & {
|
437
794
|
position?: "inline" | "popover" | undefined;
|
438
795
|
}) | (string | ({
|
439
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
796
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
440
797
|
value: string;
|
441
798
|
} & {
|
442
799
|
position?: "inline" | "popover" | undefined;
|
@@ -472,15 +829,14 @@ export declare const update: (object: {
|
|
472
829
|
slash_filters_enabled: boolean;
|
473
830
|
recents_sort_key: number | null;
|
474
831
|
recommended_sort_key: number | null;
|
832
|
+
experiences_sort_key: number | null;
|
475
833
|
show_suggested_synonyms: boolean;
|
476
834
|
has_hotloaded_help_docs: boolean;
|
477
835
|
bar_enabled: boolean;
|
478
836
|
in_bar_doc_search: boolean;
|
479
837
|
featured_item_cards: boolean;
|
480
|
-
helphub_ai_enabled: boolean;
|
481
838
|
helphub_suggested_queries_enabled: boolean;
|
482
839
|
helphub_continuations_enabled: boolean;
|
483
|
-
helphub_chat_only_mode: boolean;
|
484
840
|
helphub_enabled: boolean;
|
485
841
|
helphub_chat_fallback_message: string | null;
|
486
842
|
helphub_chat_fallback_actions: {
|
@@ -489,12 +845,70 @@ export declare const update: (object: {
|
|
489
845
|
type: "execute_command";
|
490
846
|
meta: {
|
491
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";
|
492
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";
|
493
891
|
} | {
|
494
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;
|
905
|
+
};
|
495
906
|
} | {
|
496
907
|
type: "click";
|
497
908
|
value: string;
|
909
|
+
} | {
|
910
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
911
|
+
value: string[];
|
498
912
|
} | ({
|
499
913
|
type: "link";
|
500
914
|
value: string;
|
@@ -503,16 +917,51 @@ export declare const update: (object: {
|
|
503
917
|
}) | {
|
504
918
|
type: "open_chat";
|
505
919
|
meta: {
|
506
|
-
type:
|
920
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
507
921
|
};
|
508
922
|
} | {
|
509
923
|
type: "dismiss";
|
924
|
+
} | {
|
925
|
+
type: "snooze";
|
926
|
+
} | {
|
927
|
+
type: "questlist";
|
928
|
+
value: number;
|
929
|
+
} | {
|
930
|
+
type: "step_back";
|
931
|
+
} | {
|
932
|
+
type: "nudge";
|
933
|
+
value: number;
|
934
|
+
} | {
|
935
|
+
type: "go_to_step";
|
936
|
+
value: number;
|
937
|
+
} | ({
|
938
|
+
type: "open_bar";
|
939
|
+
} & {
|
940
|
+
value?: string | undefined;
|
941
|
+
categoryFilter?: number | undefined;
|
942
|
+
}) | {
|
943
|
+
type: "open_helphub";
|
944
|
+
} | {
|
945
|
+
type: "open_copilot";
|
946
|
+
} | {
|
947
|
+
type: "no_action";
|
510
948
|
};
|
511
949
|
}[];
|
512
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
|
+
};
|
513
961
|
nudge_rate_limit: number | null;
|
514
962
|
bar_hide_completed_nudges_questlists: boolean;
|
515
963
|
nudge_rate_period: "day" | "week" | "session";
|
964
|
+
share_link_param: string;
|
516
965
|
installed_at: string | null;
|
517
966
|
integrations: {
|
518
967
|
algolia?: {
|
@@ -530,11 +979,56 @@ export declare const update: (object: {
|
|
530
979
|
};
|
531
980
|
send_events_to_heap: boolean;
|
532
981
|
} | undefined;
|
982
|
+
amplitude?: {
|
983
|
+
enabled: boolean;
|
984
|
+
} | undefined;
|
985
|
+
logrocket?: {
|
986
|
+
enabled: boolean;
|
987
|
+
} | undefined;
|
988
|
+
mixpanel?: {
|
989
|
+
enabled: boolean;
|
990
|
+
} | undefined;
|
991
|
+
posthog?: {
|
992
|
+
enabled: boolean;
|
993
|
+
} | undefined;
|
994
|
+
rudderstack?: {
|
995
|
+
enabled: boolean;
|
996
|
+
} | undefined;
|
997
|
+
slack?: {
|
998
|
+
channelId: string;
|
999
|
+
configuration: {
|
1000
|
+
analytic_events: string[];
|
1001
|
+
};
|
1002
|
+
} | undefined;
|
1003
|
+
hubspot?: {
|
1004
|
+
send_events_to_hubspot?: boolean | undefined;
|
1005
|
+
lists?: {
|
1006
|
+
[x: string]: string;
|
1007
|
+
} | undefined;
|
1008
|
+
} | undefined;
|
533
1009
|
};
|
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;
|
1015
|
+
helphub_ai_enabled: boolean;
|
1016
|
+
copilot_experiences_enabled: boolean;
|
1017
|
+
helphub_chat_only_mode: boolean;
|
1018
|
+
} & {
|
1019
|
+
helphub_launcher_offset_x: number;
|
1020
|
+
helphub_launcher_offset_y: number;
|
1021
|
+
helphub_launcher_anchor: string;
|
1022
|
+
helphub_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
1023
|
+
helphub_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
|
1024
|
+
helphub_mobile_launcher_offset_x: number;
|
1025
|
+
helphub_mobile_launcher_offset_y: number;
|
1026
|
+
helphub_mobile_launcher_anchor: string;
|
1027
|
+
helphub_mobile_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
1028
|
+
helphub_mobile_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
|
534
1029
|
}>;
|
535
1030
|
export declare const listCommands: (orgUID: string) => Promise<({
|
536
1031
|
id: number;
|
537
|
-
organization: string | number;
|
538
1032
|
text: string;
|
539
1033
|
template: ({
|
540
1034
|
type: "admin";
|
@@ -544,6 +1038,9 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
544
1038
|
object?: string | undefined;
|
545
1039
|
hoverTooltip?: boolean | undefined;
|
546
1040
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1041
|
+
metadata?: {
|
1042
|
+
[key: string]: unknown;
|
1043
|
+
} | undefined;
|
547
1044
|
}) | ({
|
548
1045
|
type: "callback";
|
549
1046
|
value: string;
|
@@ -552,6 +1049,9 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
552
1049
|
object?: string | undefined;
|
553
1050
|
hoverTooltip?: boolean | undefined;
|
554
1051
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1052
|
+
metadata?: {
|
1053
|
+
[key: string]: unknown;
|
1054
|
+
} | undefined;
|
555
1055
|
}) | ({
|
556
1056
|
type: "link";
|
557
1057
|
value: string;
|
@@ -562,14 +1062,20 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
562
1062
|
object?: string | undefined;
|
563
1063
|
hoverTooltip?: boolean | undefined;
|
564
1064
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1065
|
+
metadata?: {
|
1066
|
+
[key: string]: unknown;
|
1067
|
+
} | undefined;
|
565
1068
|
}) | ({
|
566
|
-
type: "click" | "
|
1069
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
567
1070
|
value: string[];
|
568
1071
|
} & {} & {
|
569
1072
|
commandType?: "object" | "help" | "independent" | undefined;
|
570
1073
|
object?: string | undefined;
|
571
1074
|
hoverTooltip?: boolean | undefined;
|
572
1075
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1076
|
+
metadata?: {
|
1077
|
+
[key: string]: unknown;
|
1078
|
+
} | undefined;
|
573
1079
|
}) | ({
|
574
1080
|
type: "builtin";
|
575
1081
|
value: string;
|
@@ -578,6 +1084,9 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
578
1084
|
object?: string | undefined;
|
579
1085
|
hoverTooltip?: boolean | undefined;
|
580
1086
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1087
|
+
metadata?: {
|
1088
|
+
[key: string]: unknown;
|
1089
|
+
} | undefined;
|
581
1090
|
}) | ({
|
582
1091
|
type: "webhook";
|
583
1092
|
value: string;
|
@@ -586,6 +1095,9 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
586
1095
|
object?: string | undefined;
|
587
1096
|
hoverTooltip?: boolean | undefined;
|
588
1097
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1098
|
+
metadata?: {
|
1099
|
+
[key: string]: unknown;
|
1100
|
+
} | undefined;
|
589
1101
|
}) | ({
|
590
1102
|
type: "script";
|
591
1103
|
value: string;
|
@@ -594,10 +1106,13 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
594
1106
|
object?: string | undefined;
|
595
1107
|
hoverTooltip?: boolean | undefined;
|
596
1108
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1109
|
+
metadata?: {
|
1110
|
+
[key: string]: unknown;
|
1111
|
+
} | undefined;
|
597
1112
|
}) | ({
|
598
1113
|
type: "request";
|
599
1114
|
value: {
|
600
|
-
method: "head" | "options" | "get" | "
|
1115
|
+
method: "head" | "options" | "get" | "post" | "put" | "delete" | "patch";
|
601
1116
|
url: string;
|
602
1117
|
} & {
|
603
1118
|
headers?: {
|
@@ -615,6 +1130,9 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
615
1130
|
object?: string | undefined;
|
616
1131
|
hoverTooltip?: boolean | undefined;
|
617
1132
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1133
|
+
metadata?: {
|
1134
|
+
[key: string]: unknown;
|
1135
|
+
} | undefined;
|
618
1136
|
}) | ({
|
619
1137
|
type: "appcues";
|
620
1138
|
value: string;
|
@@ -623,6 +1141,20 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
623
1141
|
object?: string | undefined;
|
624
1142
|
hoverTooltip?: boolean | undefined;
|
625
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;
|
626
1158
|
}) | ({
|
627
1159
|
type: "video";
|
628
1160
|
value: string;
|
@@ -631,6 +1163,9 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
631
1163
|
object?: string | undefined;
|
632
1164
|
hoverTooltip?: boolean | undefined;
|
633
1165
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1166
|
+
metadata?: {
|
1167
|
+
[key: string]: unknown;
|
1168
|
+
} | undefined;
|
634
1169
|
}) | ({
|
635
1170
|
type: "helpdoc";
|
636
1171
|
value: string;
|
@@ -647,14 +1182,69 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
647
1182
|
object?: string | undefined;
|
648
1183
|
hoverTooltip?: boolean | undefined;
|
649
1184
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1185
|
+
metadata?: {
|
1186
|
+
[key: string]: unknown;
|
1187
|
+
} | undefined;
|
650
1188
|
}) | ({
|
651
1189
|
type: "trigger";
|
652
|
-
value:
|
1190
|
+
value: {
|
1191
|
+
type: "execute_command";
|
1192
|
+
meta: {
|
1193
|
+
command: string;
|
1194
|
+
} & {
|
1195
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
1196
|
+
};
|
1197
|
+
} | {
|
1198
|
+
type: "click";
|
1199
|
+
value: string;
|
1200
|
+
} | {
|
1201
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
1202
|
+
value: string[];
|
1203
|
+
} | ({
|
1204
|
+
type: "link";
|
1205
|
+
value: string;
|
1206
|
+
} & {
|
1207
|
+
operation?: "self" | "router" | "blank" | undefined;
|
1208
|
+
}) | {
|
1209
|
+
type: "open_chat";
|
1210
|
+
meta: {
|
1211
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
1212
|
+
};
|
1213
|
+
} | {
|
1214
|
+
type: "dismiss";
|
1215
|
+
} | {
|
1216
|
+
type: "snooze";
|
1217
|
+
} | {
|
1218
|
+
type: "questlist";
|
1219
|
+
value: number;
|
1220
|
+
} | {
|
1221
|
+
type: "step_back";
|
1222
|
+
} | {
|
1223
|
+
type: "nudge";
|
1224
|
+
value: number;
|
1225
|
+
} | {
|
1226
|
+
type: "go_to_step";
|
1227
|
+
value: number;
|
1228
|
+
} | ({
|
1229
|
+
type: "open_bar";
|
1230
|
+
} & {
|
1231
|
+
value?: string | undefined;
|
1232
|
+
categoryFilter?: number | undefined;
|
1233
|
+
}) | {
|
1234
|
+
type: "open_helphub";
|
1235
|
+
} | {
|
1236
|
+
type: "open_copilot";
|
1237
|
+
} | {
|
1238
|
+
type: "no_action";
|
1239
|
+
};
|
653
1240
|
} & {} & {
|
654
1241
|
commandType?: "object" | "help" | "independent" | undefined;
|
655
1242
|
object?: string | undefined;
|
656
1243
|
hoverTooltip?: boolean | undefined;
|
657
1244
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1245
|
+
metadata?: {
|
1246
|
+
[key: string]: unknown;
|
1247
|
+
} | undefined;
|
658
1248
|
});
|
659
1249
|
} & {
|
660
1250
|
disabledReason?: string | undefined;
|
@@ -668,25 +1258,15 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
668
1258
|
confirm: string;
|
669
1259
|
icon: string | null;
|
670
1260
|
heading: string;
|
671
|
-
icon_color: string | null;
|
672
|
-
image_color: string | null;
|
673
1261
|
sort_key: number | null;
|
674
|
-
show_preview: boolean;
|
675
1262
|
is_live: boolean;
|
676
|
-
|
677
|
-
|
678
|
-
|
679
|
-
|
680
|
-
|
681
|
-
|
682
|
-
|
683
|
-
stagger?: number | undefined;
|
684
|
-
startVelocity?: number | undefined;
|
685
|
-
elementCount?: number | undefined;
|
686
|
-
decay?: number | undefined;
|
687
|
-
colors?: string[] | undefined;
|
688
|
-
random?: any;
|
689
|
-
} | null;
|
1263
|
+
copilot_suggest: boolean;
|
1264
|
+
show_in_spotlight_search: boolean;
|
1265
|
+
show_in_helphub_search: boolean;
|
1266
|
+
copilot_cta_label: string;
|
1267
|
+
copilot_description: string;
|
1268
|
+
editor_tags: string[];
|
1269
|
+
tags: string[];
|
690
1270
|
arguments: {
|
691
1271
|
[x: string]: ({
|
692
1272
|
type: "context";
|
@@ -765,37 +1345,114 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
765
1345
|
auto_choose?: boolean | undefined;
|
766
1346
|
});
|
767
1347
|
};
|
768
|
-
|
769
|
-
|
770
|
-
|
771
|
-
|
1348
|
+
shortcut: string[];
|
1349
|
+
celebrate: boolean | {
|
1350
|
+
angle?: number | undefined;
|
1351
|
+
spread?: number | undefined;
|
1352
|
+
width?: string | undefined;
|
1353
|
+
height?: string | undefined;
|
1354
|
+
duration?: number | undefined;
|
1355
|
+
dragFriction?: number | undefined;
|
1356
|
+
stagger?: number | undefined;
|
1357
|
+
startVelocity?: number | undefined;
|
1358
|
+
elementCount?: number | undefined;
|
1359
|
+
decay?: number | undefined;
|
1360
|
+
colors?: string[] | undefined;
|
1361
|
+
random?: any;
|
1362
|
+
} | null;
|
1363
|
+
icon_color: string | null;
|
1364
|
+
image_color: string | null;
|
1365
|
+
show_preview: boolean;
|
1366
|
+
availability_rules: (({
|
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";
|
772
1369
|
} & {
|
773
1370
|
field?: string | undefined;
|
774
1371
|
value?: string | undefined;
|
775
1372
|
reason?: string | undefined;
|
776
1373
|
rule_id?: string | number | undefined;
|
777
|
-
})
|
1374
|
+
}) | ({
|
1375
|
+
type: "nudge_interaction";
|
1376
|
+
operator: "is" | "isNot";
|
1377
|
+
value: "completed" | "dismissed" | "viewed";
|
1378
|
+
nudge_id: number;
|
1379
|
+
} & {
|
1380
|
+
reason?: string | undefined;
|
1381
|
+
}) | ({
|
1382
|
+
type: "questlist_interaction";
|
1383
|
+
operator: "is" | "isNot";
|
1384
|
+
value: "completed" | "dismissed" | "viewed";
|
1385
|
+
questlist_id: number;
|
1386
|
+
} & {
|
1387
|
+
reason?: string | undefined;
|
1388
|
+
}) | ({
|
1389
|
+
type: "browser" | "language" | "os";
|
1390
|
+
operator: "includes" | "doesNotInclude";
|
1391
|
+
values: string[];
|
1392
|
+
} & {
|
1393
|
+
reason?: string | undefined;
|
1394
|
+
}))[] | (({
|
778
1395
|
type: "named_rule";
|
779
1396
|
rule_id: string | number;
|
780
1397
|
} & {
|
781
1398
|
reason?: string | undefined;
|
782
1399
|
}) | ({
|
783
|
-
type: "url" | "element" | "context" | "
|
784
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "
|
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";
|
785
1402
|
} & {
|
786
1403
|
field?: string | undefined;
|
787
1404
|
value?: string | undefined;
|
788
1405
|
reason?: string | undefined;
|
789
1406
|
rule_id?: string | number | undefined;
|
1407
|
+
}) | ({
|
1408
|
+
type: "nudge_interaction";
|
1409
|
+
operator: "is" | "isNot";
|
1410
|
+
value: "completed" | "dismissed" | "viewed";
|
1411
|
+
nudge_id: number;
|
1412
|
+
} & {
|
1413
|
+
reason?: string | undefined;
|
1414
|
+
}) | ({
|
1415
|
+
type: "questlist_interaction";
|
1416
|
+
operator: "is" | "isNot";
|
1417
|
+
value: "completed" | "dismissed" | "viewed";
|
1418
|
+
questlist_id: number;
|
1419
|
+
} & {
|
1420
|
+
reason?: string | undefined;
|
1421
|
+
}) | ({
|
1422
|
+
type: "browser" | "language" | "os";
|
1423
|
+
operator: "includes" | "doesNotInclude";
|
1424
|
+
values: string[];
|
1425
|
+
} & {
|
1426
|
+
reason?: string | undefined;
|
790
1427
|
}))[];
|
791
1428
|
recommend_rules: (({
|
792
|
-
type: "url" | "element" | "context" | "
|
793
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "
|
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";
|
794
1431
|
} & {
|
795
1432
|
field?: string | undefined;
|
796
1433
|
value?: string | undefined;
|
797
1434
|
reason?: string | undefined;
|
798
1435
|
rule_id?: string | number | undefined;
|
1436
|
+
}) | ({
|
1437
|
+
type: "nudge_interaction";
|
1438
|
+
operator: "is" | "isNot";
|
1439
|
+
value: "completed" | "dismissed" | "viewed";
|
1440
|
+
nudge_id: number;
|
1441
|
+
} & {
|
1442
|
+
reason?: string | undefined;
|
1443
|
+
}) | ({
|
1444
|
+
type: "questlist_interaction";
|
1445
|
+
operator: "is" | "isNot";
|
1446
|
+
value: "completed" | "dismissed" | "viewed";
|
1447
|
+
questlist_id: number;
|
1448
|
+
} & {
|
1449
|
+
reason?: string | undefined;
|
1450
|
+
}) | ({
|
1451
|
+
type: "browser" | "language" | "os";
|
1452
|
+
operator: "includes" | "doesNotInclude";
|
1453
|
+
values: string[];
|
1454
|
+
} & {
|
1455
|
+
reason?: string | undefined;
|
799
1456
|
}) | ({
|
800
1457
|
type: "always";
|
801
1458
|
} & {
|
@@ -810,13 +1467,33 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
810
1467
|
} & {
|
811
1468
|
reason?: string | undefined;
|
812
1469
|
}) | ({
|
813
|
-
type: "url" | "element" | "context" | "
|
814
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "
|
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";
|
815
1472
|
} & {
|
816
1473
|
field?: string | undefined;
|
817
1474
|
value?: string | undefined;
|
818
1475
|
reason?: string | undefined;
|
819
1476
|
rule_id?: string | number | undefined;
|
1477
|
+
}) | ({
|
1478
|
+
type: "nudge_interaction";
|
1479
|
+
operator: "is" | "isNot";
|
1480
|
+
value: "completed" | "dismissed" | "viewed";
|
1481
|
+
nudge_id: number;
|
1482
|
+
} & {
|
1483
|
+
reason?: string | undefined;
|
1484
|
+
}) | ({
|
1485
|
+
type: "questlist_interaction";
|
1486
|
+
operator: "is" | "isNot";
|
1487
|
+
value: "completed" | "dismissed" | "viewed";
|
1488
|
+
questlist_id: number;
|
1489
|
+
} & {
|
1490
|
+
reason?: string | undefined;
|
1491
|
+
}) | ({
|
1492
|
+
type: "browser" | "language" | "os";
|
1493
|
+
operator: "includes" | "doesNotInclude";
|
1494
|
+
values: string[];
|
1495
|
+
} & {
|
1496
|
+
reason?: string | undefined;
|
820
1497
|
}) | ({
|
821
1498
|
type: "always";
|
822
1499
|
} & {
|
@@ -829,7 +1506,6 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
829
1506
|
availability_expression: import("./helpers/rules").RuleExpression;
|
830
1507
|
recommend_expression: import("./helpers/rules").RuleExpression;
|
831
1508
|
always_recommend: boolean;
|
832
|
-
shortcut: string[];
|
833
1509
|
category: number | null;
|
834
1510
|
recommend_sort_key: number | null;
|
835
1511
|
shortcut_mac: string[];
|
@@ -842,12 +1518,1095 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
842
1518
|
type: "execute_command";
|
843
1519
|
meta: {
|
844
1520
|
command: string;
|
1521
|
+
} & {
|
1522
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
1523
|
+
};
|
1524
|
+
} | {
|
1525
|
+
type: "click";
|
1526
|
+
value: string;
|
1527
|
+
} | {
|
1528
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
1529
|
+
value: string[];
|
1530
|
+
} | ({
|
1531
|
+
type: "link";
|
1532
|
+
value: string;
|
1533
|
+
} & {
|
1534
|
+
operation?: "self" | "router" | "blank" | undefined;
|
1535
|
+
}) | {
|
1536
|
+
type: "open_chat";
|
1537
|
+
meta: {
|
1538
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
1539
|
+
};
|
1540
|
+
} | {
|
1541
|
+
type: "dismiss";
|
1542
|
+
} | {
|
1543
|
+
type: "snooze";
|
1544
|
+
} | {
|
1545
|
+
type: "questlist";
|
1546
|
+
value: number;
|
1547
|
+
} | {
|
1548
|
+
type: "step_back";
|
1549
|
+
} | {
|
1550
|
+
type: "nudge";
|
1551
|
+
value: number;
|
1552
|
+
} | {
|
1553
|
+
type: "go_to_step";
|
1554
|
+
value: number;
|
1555
|
+
} | ({
|
1556
|
+
type: "open_bar";
|
1557
|
+
} & {
|
1558
|
+
value?: string | undefined;
|
1559
|
+
categoryFilter?: number | undefined;
|
1560
|
+
}) | {
|
1561
|
+
type: "open_helphub";
|
1562
|
+
} | {
|
1563
|
+
type: "open_copilot";
|
1564
|
+
} | {
|
1565
|
+
type: "no_action";
|
1566
|
+
};
|
1567
|
+
})[];
|
1568
|
+
thumbnail: {
|
1569
|
+
src: string;
|
1570
|
+
file_name: string;
|
1571
|
+
size: string;
|
1572
|
+
} | null;
|
1573
|
+
generated_tags: {
|
1574
|
+
automated?: string[] | null | undefined;
|
1575
|
+
manual?: string[] | null | undefined;
|
1576
|
+
deny?: string[] | null | undefined;
|
1577
|
+
};
|
1578
|
+
} & {
|
1579
|
+
third_party_source?: string | null | undefined;
|
1580
|
+
third_party_id?: string | null | undefined;
|
1581
|
+
training_only?: boolean | undefined;
|
1582
|
+
integration?: {
|
1583
|
+
id: number;
|
1584
|
+
helphub_view_article_button_hidden: boolean | undefined;
|
1585
|
+
} | null | undefined;
|
1586
|
+
})[]>;
|
1587
|
+
export declare const getCommandByUrl: (orgUID: string, url: string) => Promise<{
|
1588
|
+
id: number;
|
1589
|
+
text: string;
|
1590
|
+
template: ({
|
1591
|
+
type: "admin";
|
1592
|
+
value: string;
|
1593
|
+
} & {} & {
|
1594
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
1595
|
+
object?: string | undefined;
|
1596
|
+
hoverTooltip?: boolean | undefined;
|
1597
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1598
|
+
metadata?: {
|
1599
|
+
[key: string]: unknown;
|
1600
|
+
} | undefined;
|
1601
|
+
}) | ({
|
1602
|
+
type: "callback";
|
1603
|
+
value: string;
|
1604
|
+
} & {} & {
|
1605
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
1606
|
+
object?: string | undefined;
|
1607
|
+
hoverTooltip?: boolean | undefined;
|
1608
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1609
|
+
metadata?: {
|
1610
|
+
[key: string]: unknown;
|
1611
|
+
} | undefined;
|
1612
|
+
}) | ({
|
1613
|
+
type: "link";
|
1614
|
+
value: string;
|
1615
|
+
} & {
|
1616
|
+
operation?: "self" | "router" | "blank" | undefined;
|
1617
|
+
} & {} & {
|
1618
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
1619
|
+
object?: string | undefined;
|
1620
|
+
hoverTooltip?: boolean | undefined;
|
1621
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1622
|
+
metadata?: {
|
1623
|
+
[key: string]: unknown;
|
1624
|
+
} | undefined;
|
1625
|
+
}) | ({
|
1626
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
1627
|
+
value: string[];
|
1628
|
+
} & {} & {
|
1629
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
1630
|
+
object?: string | undefined;
|
1631
|
+
hoverTooltip?: boolean | undefined;
|
1632
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1633
|
+
metadata?: {
|
1634
|
+
[key: string]: unknown;
|
1635
|
+
} | undefined;
|
1636
|
+
}) | ({
|
1637
|
+
type: "builtin";
|
1638
|
+
value: string;
|
1639
|
+
} & {} & {
|
1640
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
1641
|
+
object?: string | undefined;
|
1642
|
+
hoverTooltip?: boolean | undefined;
|
1643
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1644
|
+
metadata?: {
|
1645
|
+
[key: string]: unknown;
|
1646
|
+
} | undefined;
|
1647
|
+
}) | ({
|
1648
|
+
type: "webhook";
|
1649
|
+
value: string;
|
1650
|
+
} & {} & {
|
1651
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
1652
|
+
object?: string | undefined;
|
1653
|
+
hoverTooltip?: boolean | undefined;
|
1654
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1655
|
+
metadata?: {
|
1656
|
+
[key: string]: unknown;
|
1657
|
+
} | undefined;
|
1658
|
+
}) | ({
|
1659
|
+
type: "script";
|
1660
|
+
value: string;
|
1661
|
+
} & {} & {
|
1662
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
1663
|
+
object?: string | undefined;
|
1664
|
+
hoverTooltip?: boolean | undefined;
|
1665
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1666
|
+
metadata?: {
|
1667
|
+
[key: string]: unknown;
|
1668
|
+
} | undefined;
|
1669
|
+
}) | ({
|
1670
|
+
type: "request";
|
1671
|
+
value: {
|
1672
|
+
method: "head" | "options" | "get" | "post" | "put" | "delete" | "patch";
|
1673
|
+
url: string;
|
1674
|
+
} & {
|
1675
|
+
headers?: {
|
1676
|
+
[key: string]: unknown;
|
1677
|
+
} | undefined;
|
1678
|
+
body?: {
|
1679
|
+
[key: string]: unknown;
|
1680
|
+
} | undefined;
|
1681
|
+
onSend?: string | undefined;
|
1682
|
+
onSuccess?: string | undefined;
|
1683
|
+
onError?: string | undefined;
|
1684
|
+
};
|
1685
|
+
} & {} & {
|
1686
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
1687
|
+
object?: string | undefined;
|
1688
|
+
hoverTooltip?: boolean | undefined;
|
1689
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1690
|
+
metadata?: {
|
1691
|
+
[key: string]: unknown;
|
1692
|
+
} | undefined;
|
1693
|
+
}) | ({
|
1694
|
+
type: "appcues";
|
1695
|
+
value: string;
|
1696
|
+
} & {} & {
|
1697
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
1698
|
+
object?: string | undefined;
|
1699
|
+
hoverTooltip?: boolean | undefined;
|
1700
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1701
|
+
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;
|
1715
|
+
}) | ({
|
1716
|
+
type: "video";
|
1717
|
+
value: string;
|
1718
|
+
} & {} & {
|
1719
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
1720
|
+
object?: string | undefined;
|
1721
|
+
hoverTooltip?: boolean | undefined;
|
1722
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1723
|
+
metadata?: {
|
1724
|
+
[key: string]: unknown;
|
1725
|
+
} | undefined;
|
1726
|
+
}) | ({
|
1727
|
+
type: "helpdoc";
|
1728
|
+
value: string;
|
1729
|
+
} & {
|
1730
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1731
|
+
doc_metadata?: {
|
1732
|
+
content_type?: string | undefined;
|
1733
|
+
date?: string | undefined;
|
1734
|
+
} | undefined;
|
1735
|
+
} & {
|
1736
|
+
doc_type?: "answer" | "doc" | undefined;
|
1737
|
+
} & {} & {
|
1738
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
1739
|
+
object?: string | undefined;
|
1740
|
+
hoverTooltip?: boolean | undefined;
|
1741
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1742
|
+
metadata?: {
|
1743
|
+
[key: string]: unknown;
|
1744
|
+
} | undefined;
|
1745
|
+
}) | ({
|
1746
|
+
type: "trigger";
|
1747
|
+
value: {
|
1748
|
+
type: "execute_command";
|
1749
|
+
meta: {
|
1750
|
+
command: string;
|
1751
|
+
} & {
|
1752
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
1753
|
+
};
|
1754
|
+
} | {
|
1755
|
+
type: "click";
|
1756
|
+
value: string;
|
1757
|
+
} | {
|
1758
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
1759
|
+
value: string[];
|
1760
|
+
} | ({
|
1761
|
+
type: "link";
|
1762
|
+
value: string;
|
1763
|
+
} & {
|
1764
|
+
operation?: "self" | "router" | "blank" | undefined;
|
1765
|
+
}) | {
|
1766
|
+
type: "open_chat";
|
1767
|
+
meta: {
|
1768
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
1769
|
+
};
|
1770
|
+
} | {
|
1771
|
+
type: "dismiss";
|
1772
|
+
} | {
|
1773
|
+
type: "snooze";
|
1774
|
+
} | {
|
1775
|
+
type: "questlist";
|
1776
|
+
value: number;
|
1777
|
+
} | {
|
1778
|
+
type: "step_back";
|
1779
|
+
} | {
|
1780
|
+
type: "nudge";
|
1781
|
+
value: number;
|
1782
|
+
} | {
|
1783
|
+
type: "go_to_step";
|
1784
|
+
value: number;
|
1785
|
+
} | ({
|
1786
|
+
type: "open_bar";
|
1787
|
+
} & {
|
1788
|
+
value?: string | undefined;
|
1789
|
+
categoryFilter?: number | undefined;
|
1790
|
+
}) | {
|
1791
|
+
type: "open_helphub";
|
1792
|
+
} | {
|
1793
|
+
type: "open_copilot";
|
1794
|
+
} | {
|
1795
|
+
type: "no_action";
|
1796
|
+
};
|
1797
|
+
} & {} & {
|
1798
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
1799
|
+
object?: string | undefined;
|
1800
|
+
hoverTooltip?: boolean | undefined;
|
1801
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
1802
|
+
metadata?: {
|
1803
|
+
[key: string]: unknown;
|
1804
|
+
} | undefined;
|
1805
|
+
});
|
1806
|
+
} & {
|
1807
|
+
disabledReason?: string | undefined;
|
1808
|
+
source?: string | undefined;
|
1809
|
+
name?: string | undefined;
|
1810
|
+
last_available?: string | null | undefined;
|
1811
|
+
modified?: string | undefined;
|
1812
|
+
isAsync?: boolean | undefined;
|
1813
|
+
} & {
|
1814
|
+
arguments: {
|
1815
|
+
[x: string]: ({
|
1816
|
+
type: "context";
|
1817
|
+
value: string;
|
1818
|
+
order_key: number;
|
1819
|
+
} & {
|
1820
|
+
label?: string | undefined;
|
1821
|
+
chosen?: string | number | undefined;
|
1822
|
+
selected?: any[] | undefined;
|
1823
|
+
input_type?: string | undefined;
|
1824
|
+
preselected_key?: string | undefined;
|
1825
|
+
label_field?: string | undefined;
|
1826
|
+
loaded?: any[] | undefined;
|
1827
|
+
allow_create?: boolean | undefined;
|
1828
|
+
allow_create_label?: string | undefined;
|
1829
|
+
show_in_record_action_list?: boolean | undefined;
|
1830
|
+
show_in_default_list?: boolean | undefined;
|
1831
|
+
auto_choose?: boolean | undefined;
|
1832
|
+
is_private?: boolean | undefined;
|
1833
|
+
}) | ({
|
1834
|
+
type: "set";
|
1835
|
+
value: string[] | number[] | {
|
1836
|
+
[key: string]: unknown;
|
1837
|
+
}[];
|
1838
|
+
order_key: number;
|
1839
|
+
} & {
|
1840
|
+
label?: string | undefined;
|
1841
|
+
chosen?: string | number | undefined;
|
1842
|
+
selected?: any[] | undefined;
|
1843
|
+
input_type?: string | undefined;
|
1844
|
+
preselected_key?: string | undefined;
|
1845
|
+
label_field?: string | undefined;
|
1846
|
+
loaded?: any[] | undefined;
|
1847
|
+
allow_create?: boolean | undefined;
|
1848
|
+
allow_create_label?: string | undefined;
|
1849
|
+
auto_choose?: boolean | undefined;
|
1850
|
+
is_private?: boolean | undefined;
|
1851
|
+
}) | ({
|
1852
|
+
type: "provided";
|
1853
|
+
value: "time" | "text";
|
1854
|
+
order_key: number;
|
1855
|
+
} & {
|
1856
|
+
label?: string | undefined;
|
1857
|
+
chosen?: string | number | undefined;
|
1858
|
+
selected?: any[] | undefined;
|
1859
|
+
input_type?: string | undefined;
|
1860
|
+
preselected_key?: string | undefined;
|
1861
|
+
label_field?: string | undefined;
|
1862
|
+
loaded?: any[] | undefined;
|
1863
|
+
dateTimeArgumentTypeId?: number | undefined;
|
1864
|
+
allow_create?: boolean | undefined;
|
1865
|
+
allow_create_label?: string | undefined;
|
1866
|
+
auto_choose?: boolean | undefined;
|
1867
|
+
is_private?: boolean | undefined;
|
1868
|
+
}) | ({
|
1869
|
+
type: "html" | "video";
|
1870
|
+
value: {
|
1871
|
+
source: string;
|
1872
|
+
} & {
|
1873
|
+
title?: string | undefined;
|
1874
|
+
description?: string | undefined;
|
1875
|
+
url?: string | undefined;
|
1876
|
+
};
|
1877
|
+
order_key: number;
|
1878
|
+
} & {
|
1879
|
+
label?: string | undefined;
|
1880
|
+
chosen?: string | number | undefined;
|
1881
|
+
selected?: any[] | undefined;
|
1882
|
+
input_type?: string | undefined;
|
1883
|
+
preselected_key?: string | undefined;
|
1884
|
+
label_field?: string | undefined;
|
1885
|
+
loaded?: any[] | undefined;
|
1886
|
+
allow_create?: boolean | undefined;
|
1887
|
+
allow_create_label?: string | undefined;
|
1888
|
+
is_private?: boolean | undefined;
|
1889
|
+
auto_choose?: boolean | undefined;
|
1890
|
+
});
|
1891
|
+
};
|
1892
|
+
tags: string[];
|
1893
|
+
availability_rules: (({
|
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";
|
1896
|
+
} & {
|
1897
|
+
field?: string | undefined;
|
1898
|
+
value?: string | undefined;
|
1899
|
+
reason?: string | undefined;
|
1900
|
+
rule_id?: string | number | undefined;
|
1901
|
+
}) | ({
|
1902
|
+
type: "nudge_interaction";
|
1903
|
+
operator: "is" | "isNot";
|
1904
|
+
value: "completed" | "dismissed" | "viewed";
|
1905
|
+
nudge_id: number;
|
1906
|
+
} & {
|
1907
|
+
reason?: string | undefined;
|
1908
|
+
}) | ({
|
1909
|
+
type: "questlist_interaction";
|
1910
|
+
operator: "is" | "isNot";
|
1911
|
+
value: "completed" | "dismissed" | "viewed";
|
1912
|
+
questlist_id: number;
|
1913
|
+
} & {
|
1914
|
+
reason?: string | undefined;
|
1915
|
+
}) | ({
|
1916
|
+
type: "browser" | "language" | "os";
|
1917
|
+
operator: "includes" | "doesNotInclude";
|
1918
|
+
values: string[];
|
1919
|
+
} & {
|
1920
|
+
reason?: string | undefined;
|
1921
|
+
}))[];
|
1922
|
+
recommend_rules: (({
|
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";
|
1925
|
+
} & {
|
1926
|
+
field?: string | undefined;
|
1927
|
+
value?: string | undefined;
|
1928
|
+
reason?: string | undefined;
|
1929
|
+
rule_id?: string | number | undefined;
|
1930
|
+
}) | ({
|
1931
|
+
type: "nudge_interaction";
|
1932
|
+
operator: "is" | "isNot";
|
1933
|
+
value: "completed" | "dismissed" | "viewed";
|
1934
|
+
nudge_id: number;
|
1935
|
+
} & {
|
1936
|
+
reason?: string | undefined;
|
1937
|
+
}) | ({
|
1938
|
+
type: "questlist_interaction";
|
1939
|
+
operator: "is" | "isNot";
|
1940
|
+
value: "completed" | "dismissed" | "viewed";
|
1941
|
+
questlist_id: number;
|
1942
|
+
} & {
|
1943
|
+
reason?: string | undefined;
|
1944
|
+
}) | ({
|
1945
|
+
type: "browser" | "language" | "os";
|
1946
|
+
operator: "includes" | "doesNotInclude";
|
1947
|
+
values: string[];
|
1948
|
+
} & {
|
1949
|
+
reason?: string | undefined;
|
1950
|
+
}) | ({
|
1951
|
+
type: "always";
|
1952
|
+
} & {
|
1953
|
+
operator?: null | undefined;
|
1954
|
+
field?: null | undefined;
|
1955
|
+
value?: null | undefined;
|
1956
|
+
reason?: null | undefined;
|
1957
|
+
rule_id?: string | number | undefined;
|
1958
|
+
}))[];
|
1959
|
+
availability_expression: import("./helpers/rules").RuleExpression | null;
|
1960
|
+
recommend_expression: import("./helpers/rules").RuleExpression | null;
|
1961
|
+
always_recommend: boolean;
|
1962
|
+
confirm: string;
|
1963
|
+
shortcut: string[];
|
1964
|
+
explanation: string;
|
1965
|
+
heading: string;
|
1966
|
+
is_live: boolean;
|
1967
|
+
category: number | null;
|
1968
|
+
sort_key: number | null;
|
1969
|
+
icon: string | null;
|
1970
|
+
icon_color: string | null;
|
1971
|
+
image_color: string | null;
|
1972
|
+
image: string | null;
|
1973
|
+
celebrate: boolean | {
|
1974
|
+
angle?: number | undefined;
|
1975
|
+
spread?: number | undefined;
|
1976
|
+
width?: string | undefined;
|
1977
|
+
height?: string | undefined;
|
1978
|
+
duration?: number | undefined;
|
1979
|
+
dragFriction?: number | undefined;
|
1980
|
+
stagger?: number | undefined;
|
1981
|
+
startVelocity?: number | undefined;
|
1982
|
+
elementCount?: number | undefined;
|
1983
|
+
decay?: number | undefined;
|
1984
|
+
colors?: string[] | undefined;
|
1985
|
+
random?: any;
|
1986
|
+
} | null;
|
1987
|
+
recommend_sort_key: number | null;
|
1988
|
+
shortcut_mac: string[];
|
1989
|
+
shortcut_win: string[];
|
1990
|
+
hotkey_mac: string;
|
1991
|
+
hotkey_win: string;
|
1992
|
+
detail: string | ({
|
1993
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
1994
|
+
value: string;
|
1995
|
+
} & {
|
1996
|
+
position?: "inline" | "popover" | undefined;
|
1997
|
+
}) | (string | ({
|
1998
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
1999
|
+
value: string;
|
2000
|
+
} & {
|
2001
|
+
position?: "inline" | "popover" | undefined;
|
2002
|
+
}))[] | null;
|
2003
|
+
content: string | ({
|
2004
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
2005
|
+
value: string;
|
2006
|
+
} & {
|
2007
|
+
position?: "inline" | "popover" | undefined;
|
2008
|
+
}) | (string | ({
|
2009
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
2010
|
+
value: string;
|
2011
|
+
} & {
|
2012
|
+
position?: "inline" | "popover" | undefined;
|
2013
|
+
}))[] | null;
|
2014
|
+
show_preview: boolean;
|
2015
|
+
next_steps: (string | number | {
|
2016
|
+
cta: string;
|
2017
|
+
action: {
|
2018
|
+
type: "execute_command";
|
2019
|
+
meta: {
|
2020
|
+
command: string;
|
2021
|
+
} & {
|
2022
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
2023
|
+
};
|
2024
|
+
} | {
|
2025
|
+
type: "click";
|
2026
|
+
value: string;
|
2027
|
+
} | {
|
2028
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
2029
|
+
value: string[];
|
2030
|
+
} | ({
|
2031
|
+
type: "link";
|
2032
|
+
value: string;
|
2033
|
+
} & {
|
2034
|
+
operation?: "self" | "router" | "blank" | undefined;
|
2035
|
+
}) | {
|
2036
|
+
type: "open_chat";
|
2037
|
+
meta: {
|
2038
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
2039
|
+
};
|
2040
|
+
} | {
|
2041
|
+
type: "dismiss";
|
2042
|
+
} | {
|
2043
|
+
type: "snooze";
|
2044
|
+
} | {
|
2045
|
+
type: "questlist";
|
2046
|
+
value: number;
|
2047
|
+
} | {
|
2048
|
+
type: "step_back";
|
2049
|
+
} | {
|
2050
|
+
type: "nudge";
|
2051
|
+
value: number;
|
2052
|
+
} | {
|
2053
|
+
type: "go_to_step";
|
2054
|
+
value: number;
|
2055
|
+
} | ({
|
2056
|
+
type: "open_bar";
|
2057
|
+
} & {
|
2058
|
+
value?: string | undefined;
|
2059
|
+
categoryFilter?: number | undefined;
|
2060
|
+
}) | {
|
2061
|
+
type: "open_helphub";
|
2062
|
+
} | {
|
2063
|
+
type: "open_copilot";
|
2064
|
+
} | {
|
2065
|
+
type: "no_action";
|
2066
|
+
};
|
2067
|
+
})[];
|
2068
|
+
extra: string | null;
|
2069
|
+
thumbnail: {
|
2070
|
+
src: string;
|
2071
|
+
file_name: string;
|
2072
|
+
size: string;
|
2073
|
+
} | null;
|
2074
|
+
copilot_suggest: boolean;
|
2075
|
+
show_in_spotlight_search: boolean;
|
2076
|
+
show_in_helphub_search: boolean;
|
2077
|
+
copilot_cta_label: string;
|
2078
|
+
copilot_description: string;
|
2079
|
+
} & {
|
2080
|
+
third_party_source?: string | null | undefined;
|
2081
|
+
third_party_id?: string | null | undefined;
|
2082
|
+
training_only?: boolean | undefined;
|
2083
|
+
integration?: {
|
2084
|
+
id: number;
|
2085
|
+
helphub_view_article_button_hidden: boolean | undefined;
|
2086
|
+
} | null | undefined;
|
2087
|
+
}>;
|
2088
|
+
export declare const getCommandById: (orgUID: string, commandID: string) => Promise<{
|
2089
|
+
id: number;
|
2090
|
+
text: string;
|
2091
|
+
template: ({
|
2092
|
+
type: "admin";
|
2093
|
+
value: string;
|
2094
|
+
} & {} & {
|
2095
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
2096
|
+
object?: string | undefined;
|
2097
|
+
hoverTooltip?: boolean | undefined;
|
2098
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
2099
|
+
metadata?: {
|
2100
|
+
[key: string]: unknown;
|
2101
|
+
} | undefined;
|
2102
|
+
}) | ({
|
2103
|
+
type: "callback";
|
2104
|
+
value: string;
|
2105
|
+
} & {} & {
|
2106
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
2107
|
+
object?: string | undefined;
|
2108
|
+
hoverTooltip?: boolean | undefined;
|
2109
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
2110
|
+
metadata?: {
|
2111
|
+
[key: string]: unknown;
|
2112
|
+
} | undefined;
|
2113
|
+
}) | ({
|
2114
|
+
type: "link";
|
2115
|
+
value: string;
|
2116
|
+
} & {
|
2117
|
+
operation?: "self" | "router" | "blank" | undefined;
|
2118
|
+
} & {} & {
|
2119
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
2120
|
+
object?: string | undefined;
|
2121
|
+
hoverTooltip?: boolean | undefined;
|
2122
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
2123
|
+
metadata?: {
|
2124
|
+
[key: string]: unknown;
|
2125
|
+
} | undefined;
|
2126
|
+
}) | ({
|
2127
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
2128
|
+
value: string[];
|
2129
|
+
} & {} & {
|
2130
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
2131
|
+
object?: string | undefined;
|
2132
|
+
hoverTooltip?: boolean | undefined;
|
2133
|
+
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
2134
|
+
metadata?: {
|
2135
|
+
[key: string]: unknown;
|
2136
|
+
} | undefined;
|
2137
|
+
}) | ({
|
2138
|
+
type: "builtin";
|
2139
|
+
value: string;
|
2140
|
+
} & {} & {
|
2141
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
2142
|
+
object?: string | undefined;
|
2143
|
+
hoverTooltip?: boolean | undefined;
|
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;
|
845
2603
|
};
|
846
|
-
} | {
|
847
|
-
type: "no_action";
|
848
2604
|
} | {
|
849
2605
|
type: "click";
|
850
2606
|
value: string;
|
2607
|
+
} | {
|
2608
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
2609
|
+
value: string[];
|
851
2610
|
} | ({
|
852
2611
|
type: "link";
|
853
2612
|
value: string;
|
@@ -856,30 +2615,58 @@ export declare const listCommands: (orgUID: string) => Promise<({
|
|
856
2615
|
}) | {
|
857
2616
|
type: "open_chat";
|
858
2617
|
meta: {
|
859
|
-
type:
|
2618
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
860
2619
|
};
|
861
2620
|
} | {
|
862
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";
|
863
2646
|
};
|
864
2647
|
})[];
|
865
|
-
thumbnail: {
|
866
|
-
src: string;
|
867
|
-
file_name: string;
|
868
|
-
size: string;
|
869
|
-
} | null;
|
870
2648
|
generated_tags: {
|
871
2649
|
automated?: string[] | null | undefined;
|
872
2650
|
manual?: string[] | null | undefined;
|
873
2651
|
deny?: string[] | null | undefined;
|
874
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[];
|
875
2659
|
} & {
|
876
2660
|
third_party_source?: string | null | undefined;
|
877
2661
|
third_party_id?: string | null | undefined;
|
878
2662
|
training_only?: boolean | undefined;
|
879
|
-
|
2663
|
+
integration?: {
|
2664
|
+
id: number;
|
2665
|
+
helphub_view_article_button_hidden: boolean | undefined;
|
2666
|
+
} | null | undefined;
|
2667
|
+
}>;
|
880
2668
|
export declare const listAnswers: (orgUID: string) => Promise<({
|
881
2669
|
id: number;
|
882
|
-
organization: string | number;
|
883
2670
|
text: string;
|
884
2671
|
template: ({
|
885
2672
|
type: "admin";
|
@@ -889,6 +2676,9 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
889
2676
|
object?: string | undefined;
|
890
2677
|
hoverTooltip?: boolean | undefined;
|
891
2678
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
2679
|
+
metadata?: {
|
2680
|
+
[key: string]: unknown;
|
2681
|
+
} | undefined;
|
892
2682
|
}) | ({
|
893
2683
|
type: "callback";
|
894
2684
|
value: string;
|
@@ -897,6 +2687,9 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
897
2687
|
object?: string | undefined;
|
898
2688
|
hoverTooltip?: boolean | undefined;
|
899
2689
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
2690
|
+
metadata?: {
|
2691
|
+
[key: string]: unknown;
|
2692
|
+
} | undefined;
|
900
2693
|
}) | ({
|
901
2694
|
type: "link";
|
902
2695
|
value: string;
|
@@ -907,14 +2700,20 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
907
2700
|
object?: string | undefined;
|
908
2701
|
hoverTooltip?: boolean | undefined;
|
909
2702
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
2703
|
+
metadata?: {
|
2704
|
+
[key: string]: unknown;
|
2705
|
+
} | undefined;
|
910
2706
|
}) | ({
|
911
|
-
type: "click" | "
|
2707
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
912
2708
|
value: string[];
|
913
2709
|
} & {} & {
|
914
2710
|
commandType?: "object" | "help" | "independent" | undefined;
|
915
2711
|
object?: string | undefined;
|
916
2712
|
hoverTooltip?: boolean | undefined;
|
917
2713
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
2714
|
+
metadata?: {
|
2715
|
+
[key: string]: unknown;
|
2716
|
+
} | undefined;
|
918
2717
|
}) | ({
|
919
2718
|
type: "builtin";
|
920
2719
|
value: string;
|
@@ -923,6 +2722,9 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
923
2722
|
object?: string | undefined;
|
924
2723
|
hoverTooltip?: boolean | undefined;
|
925
2724
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
2725
|
+
metadata?: {
|
2726
|
+
[key: string]: unknown;
|
2727
|
+
} | undefined;
|
926
2728
|
}) | ({
|
927
2729
|
type: "webhook";
|
928
2730
|
value: string;
|
@@ -931,6 +2733,9 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
931
2733
|
object?: string | undefined;
|
932
2734
|
hoverTooltip?: boolean | undefined;
|
933
2735
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
2736
|
+
metadata?: {
|
2737
|
+
[key: string]: unknown;
|
2738
|
+
} | undefined;
|
934
2739
|
}) | ({
|
935
2740
|
type: "script";
|
936
2741
|
value: string;
|
@@ -939,10 +2744,13 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
939
2744
|
object?: string | undefined;
|
940
2745
|
hoverTooltip?: boolean | undefined;
|
941
2746
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
2747
|
+
metadata?: {
|
2748
|
+
[key: string]: unknown;
|
2749
|
+
} | undefined;
|
942
2750
|
}) | ({
|
943
2751
|
type: "request";
|
944
2752
|
value: {
|
945
|
-
method: "head" | "options" | "get" | "
|
2753
|
+
method: "head" | "options" | "get" | "post" | "put" | "delete" | "patch";
|
946
2754
|
url: string;
|
947
2755
|
} & {
|
948
2756
|
headers?: {
|
@@ -960,6 +2768,9 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
960
2768
|
object?: string | undefined;
|
961
2769
|
hoverTooltip?: boolean | undefined;
|
962
2770
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
2771
|
+
metadata?: {
|
2772
|
+
[key: string]: unknown;
|
2773
|
+
} | undefined;
|
963
2774
|
}) | ({
|
964
2775
|
type: "appcues";
|
965
2776
|
value: string;
|
@@ -968,6 +2779,20 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
968
2779
|
object?: string | undefined;
|
969
2780
|
hoverTooltip?: boolean | undefined;
|
970
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;
|
971
2796
|
}) | ({
|
972
2797
|
type: "video";
|
973
2798
|
value: string;
|
@@ -976,6 +2801,9 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
976
2801
|
object?: string | undefined;
|
977
2802
|
hoverTooltip?: boolean | undefined;
|
978
2803
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
2804
|
+
metadata?: {
|
2805
|
+
[key: string]: unknown;
|
2806
|
+
} | undefined;
|
979
2807
|
}) | ({
|
980
2808
|
type: "helpdoc";
|
981
2809
|
value: string;
|
@@ -992,14 +2820,69 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
992
2820
|
object?: string | undefined;
|
993
2821
|
hoverTooltip?: boolean | undefined;
|
994
2822
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
2823
|
+
metadata?: {
|
2824
|
+
[key: string]: unknown;
|
2825
|
+
} | undefined;
|
995
2826
|
}) | ({
|
996
2827
|
type: "trigger";
|
997
|
-
value:
|
2828
|
+
value: {
|
2829
|
+
type: "execute_command";
|
2830
|
+
meta: {
|
2831
|
+
command: string;
|
2832
|
+
} & {
|
2833
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
2834
|
+
};
|
2835
|
+
} | {
|
2836
|
+
type: "click";
|
2837
|
+
value: string;
|
2838
|
+
} | {
|
2839
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
2840
|
+
value: string[];
|
2841
|
+
} | ({
|
2842
|
+
type: "link";
|
2843
|
+
value: string;
|
2844
|
+
} & {
|
2845
|
+
operation?: "self" | "router" | "blank" | undefined;
|
2846
|
+
}) | {
|
2847
|
+
type: "open_chat";
|
2848
|
+
meta: {
|
2849
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
2850
|
+
};
|
2851
|
+
} | {
|
2852
|
+
type: "dismiss";
|
2853
|
+
} | {
|
2854
|
+
type: "snooze";
|
2855
|
+
} | {
|
2856
|
+
type: "questlist";
|
2857
|
+
value: number;
|
2858
|
+
} | {
|
2859
|
+
type: "step_back";
|
2860
|
+
} | {
|
2861
|
+
type: "nudge";
|
2862
|
+
value: number;
|
2863
|
+
} | {
|
2864
|
+
type: "go_to_step";
|
2865
|
+
value: number;
|
2866
|
+
} | ({
|
2867
|
+
type: "open_bar";
|
2868
|
+
} & {
|
2869
|
+
value?: string | undefined;
|
2870
|
+
categoryFilter?: number | undefined;
|
2871
|
+
}) | {
|
2872
|
+
type: "open_helphub";
|
2873
|
+
} | {
|
2874
|
+
type: "open_copilot";
|
2875
|
+
} | {
|
2876
|
+
type: "no_action";
|
2877
|
+
};
|
998
2878
|
} & {} & {
|
999
2879
|
commandType?: "object" | "help" | "independent" | undefined;
|
1000
2880
|
object?: string | undefined;
|
1001
2881
|
hoverTooltip?: boolean | undefined;
|
1002
2882
|
operation?: "self" | "router" | "blank" | "help_hub" | undefined;
|
2883
|
+
metadata?: {
|
2884
|
+
[key: string]: unknown;
|
2885
|
+
} | undefined;
|
1003
2886
|
});
|
1004
2887
|
} & {
|
1005
2888
|
disabledReason?: string | undefined;
|
@@ -1088,36 +2971,96 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
1088
2971
|
});
|
1089
2972
|
};
|
1090
2973
|
tags: string[];
|
1091
|
-
availability_rules: ({
|
1092
|
-
type: "url" | "element" | "context" | "
|
1093
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "
|
2974
|
+
availability_rules: (({
|
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";
|
1094
2977
|
} & {
|
1095
2978
|
field?: string | undefined;
|
1096
2979
|
value?: string | undefined;
|
1097
2980
|
reason?: string | undefined;
|
1098
2981
|
rule_id?: string | number | undefined;
|
1099
|
-
})
|
2982
|
+
}) | ({
|
2983
|
+
type: "nudge_interaction";
|
2984
|
+
operator: "is" | "isNot";
|
2985
|
+
value: "completed" | "dismissed" | "viewed";
|
2986
|
+
nudge_id: number;
|
2987
|
+
} & {
|
2988
|
+
reason?: string | undefined;
|
2989
|
+
}) | ({
|
2990
|
+
type: "questlist_interaction";
|
2991
|
+
operator: "is" | "isNot";
|
2992
|
+
value: "completed" | "dismissed" | "viewed";
|
2993
|
+
questlist_id: number;
|
2994
|
+
} & {
|
2995
|
+
reason?: string | undefined;
|
2996
|
+
}) | ({
|
2997
|
+
type: "browser" | "language" | "os";
|
2998
|
+
operator: "includes" | "doesNotInclude";
|
2999
|
+
values: string[];
|
3000
|
+
} & {
|
3001
|
+
reason?: string | undefined;
|
3002
|
+
}))[] | (({
|
1100
3003
|
type: "named_rule";
|
1101
3004
|
rule_id: string | number;
|
1102
3005
|
} & {
|
1103
3006
|
reason?: string | undefined;
|
1104
3007
|
}) | ({
|
1105
|
-
type: "url" | "element" | "context" | "
|
1106
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "
|
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";
|
1107
3010
|
} & {
|
1108
3011
|
field?: string | undefined;
|
1109
3012
|
value?: string | undefined;
|
1110
3013
|
reason?: string | undefined;
|
1111
3014
|
rule_id?: string | number | undefined;
|
3015
|
+
}) | ({
|
3016
|
+
type: "nudge_interaction";
|
3017
|
+
operator: "is" | "isNot";
|
3018
|
+
value: "completed" | "dismissed" | "viewed";
|
3019
|
+
nudge_id: number;
|
3020
|
+
} & {
|
3021
|
+
reason?: string | undefined;
|
3022
|
+
}) | ({
|
3023
|
+
type: "questlist_interaction";
|
3024
|
+
operator: "is" | "isNot";
|
3025
|
+
value: "completed" | "dismissed" | "viewed";
|
3026
|
+
questlist_id: number;
|
3027
|
+
} & {
|
3028
|
+
reason?: string | undefined;
|
3029
|
+
}) | ({
|
3030
|
+
type: "browser" | "language" | "os";
|
3031
|
+
operator: "includes" | "doesNotInclude";
|
3032
|
+
values: string[];
|
3033
|
+
} & {
|
3034
|
+
reason?: string | undefined;
|
1112
3035
|
}))[];
|
1113
3036
|
recommend_rules: (({
|
1114
|
-
type: "url" | "element" | "context" | "
|
1115
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "
|
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";
|
1116
3039
|
} & {
|
1117
3040
|
field?: string | undefined;
|
1118
3041
|
value?: string | undefined;
|
1119
3042
|
reason?: string | undefined;
|
1120
3043
|
rule_id?: string | number | undefined;
|
3044
|
+
}) | ({
|
3045
|
+
type: "nudge_interaction";
|
3046
|
+
operator: "is" | "isNot";
|
3047
|
+
value: "completed" | "dismissed" | "viewed";
|
3048
|
+
nudge_id: number;
|
3049
|
+
} & {
|
3050
|
+
reason?: string | undefined;
|
3051
|
+
}) | ({
|
3052
|
+
type: "questlist_interaction";
|
3053
|
+
operator: "is" | "isNot";
|
3054
|
+
value: "completed" | "dismissed" | "viewed";
|
3055
|
+
questlist_id: number;
|
3056
|
+
} & {
|
3057
|
+
reason?: string | undefined;
|
3058
|
+
}) | ({
|
3059
|
+
type: "browser" | "language" | "os";
|
3060
|
+
operator: "includes" | "doesNotInclude";
|
3061
|
+
values: string[];
|
3062
|
+
} & {
|
3063
|
+
reason?: string | undefined;
|
1121
3064
|
}) | ({
|
1122
3065
|
type: "always";
|
1123
3066
|
} & {
|
@@ -1132,13 +3075,33 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
1132
3075
|
} & {
|
1133
3076
|
reason?: string | undefined;
|
1134
3077
|
}) | ({
|
1135
|
-
type: "url" | "element" | "context" | "
|
1136
|
-
operator: "includes" | "endsWith" | "startsWith" | "is" | "
|
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";
|
1137
3080
|
} & {
|
1138
3081
|
field?: string | undefined;
|
1139
3082
|
value?: string | undefined;
|
1140
3083
|
reason?: string | undefined;
|
1141
3084
|
rule_id?: string | number | undefined;
|
3085
|
+
}) | ({
|
3086
|
+
type: "nudge_interaction";
|
3087
|
+
operator: "is" | "isNot";
|
3088
|
+
value: "completed" | "dismissed" | "viewed";
|
3089
|
+
nudge_id: number;
|
3090
|
+
} & {
|
3091
|
+
reason?: string | undefined;
|
3092
|
+
}) | ({
|
3093
|
+
type: "questlist_interaction";
|
3094
|
+
operator: "is" | "isNot";
|
3095
|
+
value: "completed" | "dismissed" | "viewed";
|
3096
|
+
questlist_id: number;
|
3097
|
+
} & {
|
3098
|
+
reason?: string | undefined;
|
3099
|
+
}) | ({
|
3100
|
+
type: "browser" | "language" | "os";
|
3101
|
+
operator: "includes" | "doesNotInclude";
|
3102
|
+
values: string[];
|
3103
|
+
} & {
|
3104
|
+
reason?: string | undefined;
|
1142
3105
|
}) | ({
|
1143
3106
|
type: "always";
|
1144
3107
|
} & {
|
@@ -1182,23 +3145,23 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
1182
3145
|
hotkey_mac: string;
|
1183
3146
|
hotkey_win: string;
|
1184
3147
|
detail: string | ({
|
1185
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
3148
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
1186
3149
|
value: string;
|
1187
3150
|
} & {
|
1188
3151
|
position?: "inline" | "popover" | undefined;
|
1189
3152
|
}) | (string | ({
|
1190
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
3153
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
1191
3154
|
value: string;
|
1192
3155
|
} & {
|
1193
3156
|
position?: "inline" | "popover" | undefined;
|
1194
3157
|
}))[] | null;
|
1195
3158
|
content: string | ({
|
1196
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
3159
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
1197
3160
|
value: string;
|
1198
3161
|
} & {
|
1199
3162
|
position?: "inline" | "popover" | undefined;
|
1200
3163
|
}) | (string | ({
|
1201
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
3164
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
1202
3165
|
value: string;
|
1203
3166
|
} & {
|
1204
3167
|
position?: "inline" | "popover" | undefined;
|
@@ -1215,12 +3178,15 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
1215
3178
|
type: "execute_command";
|
1216
3179
|
meta: {
|
1217
3180
|
command: string;
|
3181
|
+
} & {
|
3182
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
1218
3183
|
};
|
1219
|
-
} | {
|
1220
|
-
type: "no_action";
|
1221
3184
|
} | {
|
1222
3185
|
type: "click";
|
1223
3186
|
value: string;
|
3187
|
+
} | {
|
3188
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
3189
|
+
value: string[];
|
1224
3190
|
} | ({
|
1225
3191
|
type: "link";
|
1226
3192
|
value: string;
|
@@ -1229,10 +3195,34 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
1229
3195
|
}) | {
|
1230
3196
|
type: "open_chat";
|
1231
3197
|
meta: {
|
1232
|
-
type:
|
3198
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
1233
3199
|
};
|
1234
3200
|
} | {
|
1235
3201
|
type: "dismiss";
|
3202
|
+
} | {
|
3203
|
+
type: "snooze";
|
3204
|
+
} | {
|
3205
|
+
type: "questlist";
|
3206
|
+
value: number;
|
3207
|
+
} | {
|
3208
|
+
type: "step_back";
|
3209
|
+
} | {
|
3210
|
+
type: "nudge";
|
3211
|
+
value: number;
|
3212
|
+
} | {
|
3213
|
+
type: "go_to_step";
|
3214
|
+
value: number;
|
3215
|
+
} | ({
|
3216
|
+
type: "open_bar";
|
3217
|
+
} & {
|
3218
|
+
value?: string | undefined;
|
3219
|
+
categoryFilter?: number | undefined;
|
3220
|
+
}) | {
|
3221
|
+
type: "open_helphub";
|
3222
|
+
} | {
|
3223
|
+
type: "open_copilot";
|
3224
|
+
} | {
|
3225
|
+
type: "no_action";
|
1236
3226
|
};
|
1237
3227
|
})[];
|
1238
3228
|
generated_tags: {
|
@@ -1240,10 +3230,20 @@ export declare const listAnswers: (orgUID: string) => Promise<({
|
|
1240
3230
|
manual?: string[] | null | undefined;
|
1241
3231
|
deny?: string[] | null | undefined;
|
1242
3232
|
};
|
3233
|
+
copilot_suggest: boolean;
|
3234
|
+
show_in_spotlight_search: boolean;
|
3235
|
+
show_in_helphub_search: boolean;
|
3236
|
+
copilot_cta_label: string;
|
3237
|
+
copilot_description: string;
|
3238
|
+
editor_tags: string[];
|
1243
3239
|
} & {
|
1244
3240
|
third_party_source?: string | null | undefined;
|
1245
3241
|
third_party_id?: string | null | undefined;
|
1246
3242
|
training_only?: boolean | undefined;
|
3243
|
+
integration?: {
|
3244
|
+
id: number;
|
3245
|
+
helphub_view_article_button_hidden: boolean | undefined;
|
3246
|
+
} | null | undefined;
|
1247
3247
|
})[]>;
|
1248
3248
|
export declare const listCommandCategories: (orgUID: string) => Promise<({
|
1249
3249
|
id: number;
|
@@ -1296,15 +3296,11 @@ export declare const listRules: (orgUID: string) => Promise<({
|
|
1296
3296
|
} & {
|
1297
3297
|
is_audience: boolean;
|
1298
3298
|
})[]>;
|
1299
|
-
export declare const
|
1300
|
-
|
1301
|
-
|
1302
|
-
|
1303
|
-
|
1304
|
-
has_opened: boolean;
|
1305
|
-
hotkeys_debug: boolean;
|
1306
|
-
hmac: string | undefined;
|
1307
|
-
identifier: string;
|
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[];
|
1308
3304
|
}>;
|
1309
3305
|
export declare const readHealth: (arg0: string, urlArgs?: {
|
1310
3306
|
[arg: string]: string;
|
@@ -1322,9 +3318,7 @@ export declare const readInternal: (arg0: string, urlArgs?: {
|
|
1322
3318
|
id: string;
|
1323
3319
|
integrations: {
|
1324
3320
|
[x: string]: {
|
1325
|
-
[x: string]:
|
1326
|
-
[x: string]: string;
|
1327
|
-
};
|
3321
|
+
[x: string]: any;
|
1328
3322
|
};
|
1329
3323
|
};
|
1330
3324
|
}>;
|
@@ -1332,9 +3326,7 @@ export declare const updateInternal: (object: {
|
|
1332
3326
|
id: string;
|
1333
3327
|
integrations: {
|
1334
3328
|
[x: string]: {
|
1335
|
-
[x: string]:
|
1336
|
-
[x: string]: string;
|
1337
|
-
};
|
3329
|
+
[x: string]: any;
|
1338
3330
|
};
|
1339
3331
|
};
|
1340
3332
|
}, urlArgs?: {
|
@@ -1343,47 +3335,54 @@ export declare const updateInternal: (object: {
|
|
1343
3335
|
id: string;
|
1344
3336
|
integrations: {
|
1345
3337
|
[x: string]: {
|
1346
|
-
[x: string]:
|
1347
|
-
[x: string]: string;
|
1348
|
-
};
|
3338
|
+
[x: string]: any;
|
1349
3339
|
};
|
1350
3340
|
};
|
1351
3341
|
}>;
|
1352
|
-
export declare const readDashboardFlags: (params?: Record<string, string> | undefined, callbacks?: {
|
1353
|
-
onSuccess?: (() => void) | undefined;
|
1354
|
-
onError?: ((err: string) => void) | undefined;
|
1355
|
-
} | undefined) => Promise<{
|
1356
|
-
show_onboarding: boolean;
|
1357
|
-
show_appsumo_onboarding: boolean;
|
1358
|
-
}>;
|
1359
|
-
export declare const updateDashboardFlags: (object: {
|
1360
|
-
show_onboarding?: boolean | undefined;
|
1361
|
-
show_appsumo_onboarding?: boolean | undefined;
|
1362
|
-
}, params?: Record<string, string> | undefined, callbacks?: {
|
1363
|
-
onSuccess?: (() => void) | undefined;
|
1364
|
-
onError?: ((err: string) => void) | undefined;
|
1365
|
-
} | undefined) => Promise<{
|
1366
|
-
show_onboarding: boolean;
|
1367
|
-
show_appsumo_onboarding: boolean;
|
1368
|
-
}>;
|
1369
3342
|
export declare const decode: (data: any) => {
|
1370
3343
|
id: string | number;
|
1371
3344
|
name: string;
|
1372
3345
|
created: string;
|
1373
3346
|
} & {} & {
|
3347
|
+
disabled: boolean;
|
1374
3348
|
launcher_type: "alternate" | "none" | "prompt" | "minimal";
|
1375
|
-
launcher_position: "
|
3349
|
+
launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
1376
3350
|
show_launcher_recommendations: boolean;
|
1377
3351
|
recommendations_type: "None" | "Custom" | "Algorithm" | undefined;
|
1378
3352
|
launcher_offset_x: number;
|
1379
3353
|
launcher_offset_y: number;
|
1380
|
-
helphub_launcher_offset_x: number;
|
1381
|
-
helphub_launcher_offset_y: number;
|
1382
|
-
helphub_launcher_anchor: string;
|
1383
|
-
helphub_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
|
1384
|
-
helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle";
|
1385
3354
|
base_url: string;
|
1386
3355
|
theme: object;
|
3356
|
+
themeV2: {
|
3357
|
+
light_mode: {
|
3358
|
+
var_defaults: {
|
3359
|
+
[x: string]: string;
|
3360
|
+
};
|
3361
|
+
var_overrides: {
|
3362
|
+
[x: string]: string;
|
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;
|
3374
|
+
};
|
3375
|
+
var_overrides: {
|
3376
|
+
[x: string]: string;
|
3377
|
+
};
|
3378
|
+
component_overrides: {
|
3379
|
+
[x: string]: any;
|
3380
|
+
};
|
3381
|
+
mobile_overrides: {
|
3382
|
+
[x: string]: any;
|
3383
|
+
};
|
3384
|
+
};
|
3385
|
+
} | null | undefined;
|
1387
3386
|
icon: string;
|
1388
3387
|
icon_suggest: string;
|
1389
3388
|
icon_tutorial: string;
|
@@ -1426,23 +3425,23 @@ export declare const decode: (data: any) => {
|
|
1426
3425
|
setting_pin_to_bottom?: boolean | undefined;
|
1427
3426
|
track_recents?: boolean | undefined;
|
1428
3427
|
detail?: string | ({
|
1429
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
3428
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
1430
3429
|
value: string;
|
1431
3430
|
} & {
|
1432
3431
|
position?: "inline" | "popover" | undefined;
|
1433
3432
|
}) | (string | ({
|
1434
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
3433
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
1435
3434
|
value: string;
|
1436
3435
|
} & {
|
1437
3436
|
position?: "inline" | "popover" | undefined;
|
1438
3437
|
}))[] | null | undefined;
|
1439
3438
|
content?: string | ({
|
1440
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
3439
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
1441
3440
|
value: string;
|
1442
3441
|
} & {
|
1443
3442
|
position?: "inline" | "popover" | undefined;
|
1444
3443
|
}) | (string | ({
|
1445
|
-
type: "html" | "video" | "plaintext" | "markdown" | "
|
3444
|
+
type: "html" | "video" | "plaintext" | "markdown" | "component" | "react";
|
1446
3445
|
value: string;
|
1447
3446
|
} & {
|
1448
3447
|
position?: "inline" | "popover" | undefined;
|
@@ -1478,15 +3477,14 @@ export declare const decode: (data: any) => {
|
|
1478
3477
|
slash_filters_enabled: boolean;
|
1479
3478
|
recents_sort_key: number | null;
|
1480
3479
|
recommended_sort_key: number | null;
|
3480
|
+
experiences_sort_key: number | null;
|
1481
3481
|
show_suggested_synonyms: boolean;
|
1482
3482
|
has_hotloaded_help_docs: boolean;
|
1483
3483
|
bar_enabled: boolean;
|
1484
3484
|
in_bar_doc_search: boolean;
|
1485
3485
|
featured_item_cards: boolean;
|
1486
|
-
helphub_ai_enabled: boolean;
|
1487
3486
|
helphub_suggested_queries_enabled: boolean;
|
1488
3487
|
helphub_continuations_enabled: boolean;
|
1489
|
-
helphub_chat_only_mode: boolean;
|
1490
3488
|
helphub_enabled: boolean;
|
1491
3489
|
helphub_chat_fallback_message: string | null;
|
1492
3490
|
helphub_chat_fallback_actions: {
|
@@ -1495,12 +3493,70 @@ export declare const decode: (data: any) => {
|
|
1495
3493
|
type: "execute_command";
|
1496
3494
|
meta: {
|
1497
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";
|
1498
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";
|
1499
3539
|
} | {
|
1500
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;
|
3553
|
+
};
|
1501
3554
|
} | {
|
1502
3555
|
type: "click";
|
1503
3556
|
value: string;
|
3557
|
+
} | {
|
3558
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
3559
|
+
value: string[];
|
1504
3560
|
} | ({
|
1505
3561
|
type: "link";
|
1506
3562
|
value: string;
|
@@ -1509,16 +3565,51 @@ export declare const decode: (data: any) => {
|
|
1509
3565
|
}) | {
|
1510
3566
|
type: "open_chat";
|
1511
3567
|
meta: {
|
1512
|
-
type:
|
3568
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
1513
3569
|
};
|
1514
3570
|
} | {
|
1515
3571
|
type: "dismiss";
|
3572
|
+
} | {
|
3573
|
+
type: "snooze";
|
3574
|
+
} | {
|
3575
|
+
type: "questlist";
|
3576
|
+
value: number;
|
3577
|
+
} | {
|
3578
|
+
type: "step_back";
|
3579
|
+
} | {
|
3580
|
+
type: "nudge";
|
3581
|
+
value: number;
|
3582
|
+
} | {
|
3583
|
+
type: "go_to_step";
|
3584
|
+
value: number;
|
3585
|
+
} | ({
|
3586
|
+
type: "open_bar";
|
3587
|
+
} & {
|
3588
|
+
value?: string | undefined;
|
3589
|
+
categoryFilter?: number | undefined;
|
3590
|
+
}) | {
|
3591
|
+
type: "open_helphub";
|
3592
|
+
} | {
|
3593
|
+
type: "open_copilot";
|
3594
|
+
} | {
|
3595
|
+
type: "no_action";
|
1516
3596
|
};
|
1517
3597
|
}[];
|
1518
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
|
+
};
|
1519
3609
|
nudge_rate_limit: number | null;
|
1520
3610
|
bar_hide_completed_nudges_questlists: boolean;
|
1521
3611
|
nudge_rate_period: "day" | "week" | "session";
|
3612
|
+
share_link_param: string;
|
1522
3613
|
installed_at: string | null;
|
1523
3614
|
integrations: {
|
1524
3615
|
algolia?: {
|
@@ -1536,5 +3627,51 @@ export declare const decode: (data: any) => {
|
|
1536
3627
|
};
|
1537
3628
|
send_events_to_heap: boolean;
|
1538
3629
|
} | undefined;
|
3630
|
+
amplitude?: {
|
3631
|
+
enabled: boolean;
|
3632
|
+
} | undefined;
|
3633
|
+
logrocket?: {
|
3634
|
+
enabled: boolean;
|
3635
|
+
} | undefined;
|
3636
|
+
mixpanel?: {
|
3637
|
+
enabled: boolean;
|
3638
|
+
} | undefined;
|
3639
|
+
posthog?: {
|
3640
|
+
enabled: boolean;
|
3641
|
+
} | undefined;
|
3642
|
+
rudderstack?: {
|
3643
|
+
enabled: boolean;
|
3644
|
+
} | undefined;
|
3645
|
+
slack?: {
|
3646
|
+
channelId: string;
|
3647
|
+
configuration: {
|
3648
|
+
analytic_events: string[];
|
3649
|
+
};
|
3650
|
+
} | undefined;
|
3651
|
+
hubspot?: {
|
3652
|
+
send_events_to_hubspot?: boolean | undefined;
|
3653
|
+
lists?: {
|
3654
|
+
[x: string]: string;
|
3655
|
+
} | undefined;
|
3656
|
+
} | undefined;
|
1539
3657
|
};
|
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;
|
3663
|
+
helphub_ai_enabled: boolean;
|
3664
|
+
copilot_experiences_enabled: boolean;
|
3665
|
+
helphub_chat_only_mode: boolean;
|
3666
|
+
} & {
|
3667
|
+
helphub_launcher_offset_x: number;
|
3668
|
+
helphub_launcher_offset_y: number;
|
3669
|
+
helphub_launcher_anchor: string;
|
3670
|
+
helphub_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
3671
|
+
helphub_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
|
3672
|
+
helphub_mobile_launcher_offset_x: number;
|
3673
|
+
helphub_mobile_launcher_offset_y: number;
|
3674
|
+
helphub_mobile_launcher_anchor: string;
|
3675
|
+
helphub_mobile_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
3676
|
+
helphub_mobile_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
|
1540
3677
|
};
|