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
@@ -30,38 +30,112 @@ export declare const OrganizationSettingsV: t.TypeC<{
|
|
30
30
|
slash_filters_enabled: t.BooleanC;
|
31
31
|
recents_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
|
32
32
|
recommended_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
|
33
|
+
experiences_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
|
33
34
|
num_live_commands: t.NumberC;
|
34
35
|
help_center_sync: t.UnionC<[t.LiteralC<"upload-once">, t.LiteralC<"manual">, t.LiteralC<"automatic">]>;
|
35
36
|
show_suggested_synonyms: t.BooleanC;
|
36
37
|
bar_enabled: t.BooleanC;
|
37
38
|
in_bar_doc_search: t.BooleanC;
|
38
39
|
featured_item_cards: t.BooleanC;
|
39
|
-
helphub_ai_enabled: t.BooleanC;
|
40
40
|
chat_system_prompt_modifier: t.StringC;
|
41
41
|
helphub_chat_welcome_message: t.StringC;
|
42
42
|
helphub_suggested_queries_enabled: t.BooleanC;
|
43
43
|
helphub_continuations_enabled: t.BooleanC;
|
44
44
|
helphub_manual_suggested_queries: t.ArrayC<t.StringC>;
|
45
|
-
|
45
|
+
copilot_name: t.StringC;
|
46
|
+
copilot_avatar: t.StringC;
|
47
|
+
copilot_personality: t.UnionC<[t.TypeC<{
|
48
|
+
template: t.UnionC<[t.LiteralC<"professional">, t.LiteralC<"friendly">, t.LiteralC<"confident">, t.LiteralC<"serious">, t.LiteralC<"empathetic">]>;
|
49
|
+
}>, t.TypeC<{
|
50
|
+
template: t.LiteralC<"custom">;
|
51
|
+
adjectives: t.ArrayC<t.UnionC<[t.LiteralC<"abrasive">, t.LiteralC<"adventurous">, t.LiteralC<"affable">, t.LiteralC<"arrogant">, t.LiteralC<"assertive">, t.LiteralC<"assured">, t.LiteralC<"belligerent">, t.LiteralC<"brave">, t.LiteralC<"cheerful">, t.LiteralC<"compassionate">, t.LiteralC<"condescending">, t.LiteralC<"courteous">, t.LiteralC<"creative">, t.LiteralC<"cynical">, t.LiteralC<"decisive">, t.LiteralC<"detached">, t.LiteralC<"diligent">, t.LiteralC<"eloquent">, t.LiteralC<"empathetic">, t.LiteralC<"evasive">, t.LiteralC<"formal">, t.LiteralC<"frivolous">, t.LiteralC<"garrulous">, t.LiteralC<"generous">, t.LiteralC<"impulsive">, t.LiteralC<"innovative">, t.LiteralC<"intense">, t.LiteralC<"judgmental">, t.LiteralC<"jovial">, t.LiteralC<"manipulative">, t.LiteralC<"obstinate">, t.LiteralC<"optimistic">, t.LiteralC<"perceptive">, t.LiteralC<"pessimistic">, t.LiteralC<"quarrelsome">, t.LiteralC<"respectful">, t.LiteralC<"resourceful">, t.LiteralC<"sarcastic">, t.LiteralC<"sincere">, t.LiteralC<"sociable">, t.LiteralC<"solemn">, t.LiteralC<"supportive">, t.LiteralC<"tactful">, t.LiteralC<"thoughtful">, t.LiteralC<"understanding">, t.LiteralC<"unreliable">, t.LiteralC<"vain">, t.LiteralC<"vivacious">, t.LiteralC<"warm">, t.LiteralC<"withdrawn">, t.LiteralC<"witty">, t.LiteralC<"zealous">]>>;
|
52
|
+
response_length: t.UnionC<[t.LiteralC<"short">, t.LiteralC<"conversational">, t.LiteralC<"long">]>;
|
53
|
+
response_format: t.UnionC<[t.LiteralC<"lists">, t.LiteralC<"paragraphs">, t.LiteralC<"mixed">]>;
|
54
|
+
}>]>;
|
46
55
|
helphub_enabled: t.BooleanC;
|
47
|
-
helphub_launcher_type: t.UnionC<[t.LiteralC<"bookOpen">, t.LiteralC<"graduationHat">, t.LiteralC<"bookClosed">, t.LiteralC<"bookmark">, t.LiteralC<"chatCircle">, t.LiteralC<"custom">, t.LiteralC<"none">]>;
|
56
|
+
helphub_launcher_type: t.UnionC<[t.LiteralC<"bookOpen">, t.LiteralC<"graduationHat">, t.LiteralC<"bookClosed">, t.LiteralC<"bookmark">, t.LiteralC<"chatCircle">, t.LiteralC<"askAI">, t.LiteralC<"custom">, t.LiteralC<"none">]>;
|
48
57
|
helphub_launcher_position: t.UnionC<[t.LiteralC<"topRight">, t.LiteralC<"topLeft">, t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
|
49
58
|
helphub_launcher_offset_x: t.NumberC;
|
50
59
|
helphub_launcher_offset_y: t.NumberC;
|
51
60
|
helphub_launcher_anchor: t.StringC;
|
61
|
+
helphub_mobile_launcher_type: t.UnionC<[t.LiteralC<"bookOpen">, t.LiteralC<"graduationHat">, t.LiteralC<"bookClosed">, t.LiteralC<"bookmark">, t.LiteralC<"chatCircle">, t.LiteralC<"askAI">, t.LiteralC<"custom">, t.LiteralC<"none">]>;
|
62
|
+
helphub_mobile_launcher_position: t.UnionC<[t.LiteralC<"topRight">, t.LiteralC<"topLeft">, t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
|
63
|
+
helphub_mobile_launcher_offset_x: t.NumberC;
|
64
|
+
helphub_mobile_launcher_offset_y: t.NumberC;
|
65
|
+
helphub_mobile_launcher_anchor: t.StringC;
|
52
66
|
helphub_chat_fallback_message: t.StringC;
|
53
67
|
helphub_chat_fallback_actions: t.ArrayC<t.TypeC<{
|
54
68
|
cta: t.StringC;
|
55
69
|
action: t.UnionC<[t.TypeC<{
|
56
70
|
type: t.LiteralC<"execute_command">;
|
57
|
-
meta: t.TypeC<{
|
71
|
+
meta: t.IntersectionC<[t.TypeC<{
|
58
72
|
command: t.StringC;
|
73
|
+
}>, t.PartialC<{
|
74
|
+
type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
|
75
|
+
}>]>;
|
76
|
+
}>, t.TypeC<{
|
77
|
+
type: t.LiteralC<"no_action">;
|
78
|
+
}>, t.TypeC<{
|
79
|
+
type: t.LiteralC<"click">;
|
80
|
+
value: t.StringC;
|
81
|
+
}>, t.TypeC<{
|
82
|
+
type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
|
83
|
+
value: t.ArrayC<t.StringC>;
|
84
|
+
}>, t.IntersectionC<[t.TypeC<{
|
85
|
+
type: t.LiteralC<"link">;
|
86
|
+
value: t.StringC;
|
87
|
+
}>, t.PartialC<{
|
88
|
+
operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
|
89
|
+
}>]>, t.TypeC<{
|
90
|
+
type: t.LiteralC<"open_chat">;
|
91
|
+
meta: t.TypeC<{
|
92
|
+
type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
|
59
93
|
}>;
|
94
|
+
}>, t.TypeC<{
|
95
|
+
type: t.LiteralC<"dismiss">;
|
96
|
+
}>, t.TypeC<{
|
97
|
+
type: t.LiteralC<"snooze">;
|
98
|
+
}>, t.TypeC<{
|
99
|
+
type: t.LiteralC<"questlist">;
|
100
|
+
value: t.NumberC;
|
101
|
+
}>, t.TypeC<{
|
102
|
+
type: t.LiteralC<"nudge">;
|
103
|
+
value: t.NumberC;
|
104
|
+
}>, t.TypeC<{
|
105
|
+
type: t.LiteralC<"go_to_step">;
|
106
|
+
value: t.NumberC;
|
107
|
+
}>, t.TypeC<{
|
108
|
+
type: t.LiteralC<"step_back">;
|
109
|
+
}>, t.IntersectionC<[t.TypeC<{
|
110
|
+
type: t.LiteralC<"open_bar">;
|
111
|
+
}>, t.PartialC<{
|
112
|
+
value: t.StringC;
|
113
|
+
categoryFilter: t.NumberC;
|
114
|
+
}>]>, t.TypeC<{
|
115
|
+
type: t.LiteralC<"open_helphub">;
|
116
|
+
}>, t.TypeC<{
|
117
|
+
type: t.LiteralC<"open_copilot">;
|
118
|
+
}>]>;
|
119
|
+
}>>;
|
120
|
+
copilot_negative_feedback_fallback_enabled: t.BooleanC;
|
121
|
+
copilot_negative_feedback_fallback_message: t.UnionC<[t.StringC, t.NullC]>;
|
122
|
+
copilot_negative_feedback_fallback_actions: t.ArrayC<t.TypeC<{
|
123
|
+
cta: t.StringC;
|
124
|
+
action: t.UnionC<[t.TypeC<{
|
125
|
+
type: t.LiteralC<"execute_command">;
|
126
|
+
meta: t.IntersectionC<[t.TypeC<{
|
127
|
+
command: t.StringC;
|
128
|
+
}>, t.PartialC<{
|
129
|
+
type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
|
130
|
+
}>]>;
|
60
131
|
}>, t.TypeC<{
|
61
132
|
type: t.LiteralC<"no_action">;
|
62
133
|
}>, t.TypeC<{
|
63
134
|
type: t.LiteralC<"click">;
|
64
135
|
value: t.StringC;
|
136
|
+
}>, t.TypeC<{
|
137
|
+
type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
|
138
|
+
value: t.ArrayC<t.StringC>;
|
65
139
|
}>, t.IntersectionC<[t.TypeC<{
|
66
140
|
type: t.LiteralC<"link">;
|
67
141
|
value: t.StringC;
|
@@ -70,15 +144,47 @@ export declare const OrganizationSettingsV: t.TypeC<{
|
|
70
144
|
}>]>, t.TypeC<{
|
71
145
|
type: t.LiteralC<"open_chat">;
|
72
146
|
meta: t.TypeC<{
|
73
|
-
type: t.
|
147
|
+
type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
|
74
148
|
}>;
|
75
149
|
}>, t.TypeC<{
|
76
150
|
type: t.LiteralC<"dismiss">;
|
151
|
+
}>, t.TypeC<{
|
152
|
+
type: t.LiteralC<"snooze">;
|
153
|
+
}>, t.TypeC<{
|
154
|
+
type: t.LiteralC<"questlist">;
|
155
|
+
value: t.NumberC;
|
156
|
+
}>, t.TypeC<{
|
157
|
+
type: t.LiteralC<"nudge">;
|
158
|
+
value: t.NumberC;
|
159
|
+
}>, t.TypeC<{
|
160
|
+
type: t.LiteralC<"go_to_step">;
|
161
|
+
value: t.NumberC;
|
162
|
+
}>, t.TypeC<{
|
163
|
+
type: t.LiteralC<"step_back">;
|
164
|
+
}>, t.IntersectionC<[t.TypeC<{
|
165
|
+
type: t.LiteralC<"open_bar">;
|
166
|
+
}>, t.PartialC<{
|
167
|
+
value: t.StringC;
|
168
|
+
categoryFilter: t.NumberC;
|
169
|
+
}>]>, t.TypeC<{
|
170
|
+
type: t.LiteralC<"open_helphub">;
|
171
|
+
}>, t.TypeC<{
|
172
|
+
type: t.LiteralC<"open_copilot">;
|
77
173
|
}>]>;
|
78
174
|
}>>;
|
79
175
|
nudge_rate_limit: t.UnionC<[t.NullC, t.NumberC]>;
|
80
176
|
bar_hide_completed_nudges_questlists: t.BooleanC;
|
81
177
|
nudge_rate_period: t.UnionC<[t.LiteralC<"day">, t.LiteralC<"week">, t.LiteralC<"session">]>;
|
178
|
+
share_link_param: t.StringC;
|
179
|
+
spotlight_ask_copilot_enabled: t.BooleanC;
|
180
|
+
spotlight_ask_copilot_label: t.UnionC<[t.StringC, t.NullC]>;
|
181
|
+
copilot_enabled: t.BooleanC;
|
182
|
+
/** @deprecated Replaced by the `copilot_enabled` field */
|
183
|
+
helphub_ai_enabled: t.BooleanC;
|
184
|
+
/** @deprecated Removed entirely */
|
185
|
+
copilot_experiences_enabled: t.BooleanC;
|
186
|
+
/** @deprecated Replaced by the combination of `copilot_enabled` and `helphub_enabled` */
|
187
|
+
helphub_chat_only_mode: t.BooleanC;
|
82
188
|
}>;
|
83
189
|
export declare const read: (params?: Record<string, string> | undefined, callbacks?: {
|
84
190
|
onSuccess?: (() => void) | undefined;
|
@@ -114,25 +220,39 @@ export declare const read: (params?: Record<string, string> | undefined, callbac
|
|
114
220
|
slash_filters_enabled: boolean;
|
115
221
|
recents_sort_key: number | null;
|
116
222
|
recommended_sort_key: number | null;
|
223
|
+
experiences_sort_key: number | null;
|
117
224
|
num_live_commands: number;
|
118
225
|
help_center_sync: "manual" | "upload-once" | "automatic";
|
119
226
|
show_suggested_synonyms: boolean;
|
120
227
|
bar_enabled: boolean;
|
121
228
|
in_bar_doc_search: boolean;
|
122
229
|
featured_item_cards: boolean;
|
123
|
-
helphub_ai_enabled: boolean;
|
124
230
|
chat_system_prompt_modifier: string;
|
125
231
|
helphub_chat_welcome_message: string;
|
126
232
|
helphub_suggested_queries_enabled: boolean;
|
127
233
|
helphub_continuations_enabled: boolean;
|
128
234
|
helphub_manual_suggested_queries: string[];
|
129
|
-
|
235
|
+
copilot_name: string;
|
236
|
+
copilot_avatar: string;
|
237
|
+
copilot_personality: {
|
238
|
+
template: "professional" | "friendly" | "confident" | "serious" | "empathetic";
|
239
|
+
} | {
|
240
|
+
template: "custom";
|
241
|
+
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")[];
|
242
|
+
response_length: "long" | "short" | "conversational";
|
243
|
+
response_format: "mixed" | "lists" | "paragraphs";
|
244
|
+
};
|
130
245
|
helphub_enabled: boolean;
|
131
|
-
helphub_launcher_type: "none" | "custom" | "
|
132
|
-
helphub_launcher_position: "
|
246
|
+
helphub_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
|
247
|
+
helphub_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
133
248
|
helphub_launcher_offset_x: number;
|
134
249
|
helphub_launcher_offset_y: number;
|
135
250
|
helphub_launcher_anchor: string;
|
251
|
+
helphub_mobile_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
|
252
|
+
helphub_mobile_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
253
|
+
helphub_mobile_launcher_offset_x: number;
|
254
|
+
helphub_mobile_launcher_offset_y: number;
|
255
|
+
helphub_mobile_launcher_anchor: string;
|
136
256
|
helphub_chat_fallback_message: string;
|
137
257
|
helphub_chat_fallback_actions: {
|
138
258
|
cta: string;
|
@@ -140,12 +260,70 @@ export declare const read: (params?: Record<string, string> | undefined, callbac
|
|
140
260
|
type: "execute_command";
|
141
261
|
meta: {
|
142
262
|
command: string;
|
263
|
+
} & {
|
264
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
265
|
+
};
|
266
|
+
} | {
|
267
|
+
type: "click";
|
268
|
+
value: string;
|
269
|
+
} | {
|
270
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
271
|
+
value: string[];
|
272
|
+
} | ({
|
273
|
+
type: "link";
|
274
|
+
value: string;
|
275
|
+
} & {
|
276
|
+
operation?: "self" | "router" | "blank" | undefined;
|
277
|
+
}) | {
|
278
|
+
type: "open_chat";
|
279
|
+
meta: {
|
280
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
143
281
|
};
|
282
|
+
} | {
|
283
|
+
type: "dismiss";
|
284
|
+
} | {
|
285
|
+
type: "snooze";
|
286
|
+
} | {
|
287
|
+
type: "questlist";
|
288
|
+
value: number;
|
289
|
+
} | {
|
290
|
+
type: "step_back";
|
291
|
+
} | {
|
292
|
+
type: "nudge";
|
293
|
+
value: number;
|
294
|
+
} | {
|
295
|
+
type: "go_to_step";
|
296
|
+
value: number;
|
297
|
+
} | ({
|
298
|
+
type: "open_bar";
|
299
|
+
} & {
|
300
|
+
value?: string | undefined;
|
301
|
+
categoryFilter?: number | undefined;
|
302
|
+
}) | {
|
303
|
+
type: "open_helphub";
|
304
|
+
} | {
|
305
|
+
type: "open_copilot";
|
144
306
|
} | {
|
145
307
|
type: "no_action";
|
308
|
+
};
|
309
|
+
}[];
|
310
|
+
copilot_negative_feedback_fallback_enabled: boolean;
|
311
|
+
copilot_negative_feedback_fallback_message: string | null;
|
312
|
+
copilot_negative_feedback_fallback_actions: {
|
313
|
+
cta: string;
|
314
|
+
action: {
|
315
|
+
type: "execute_command";
|
316
|
+
meta: {
|
317
|
+
command: string;
|
318
|
+
} & {
|
319
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
320
|
+
};
|
146
321
|
} | {
|
147
322
|
type: "click";
|
148
323
|
value: string;
|
324
|
+
} | {
|
325
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
326
|
+
value: string[];
|
149
327
|
} | ({
|
150
328
|
type: "link";
|
151
329
|
value: string;
|
@@ -154,15 +332,46 @@ export declare const read: (params?: Record<string, string> | undefined, callbac
|
|
154
332
|
}) | {
|
155
333
|
type: "open_chat";
|
156
334
|
meta: {
|
157
|
-
type:
|
335
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
158
336
|
};
|
159
337
|
} | {
|
160
338
|
type: "dismiss";
|
339
|
+
} | {
|
340
|
+
type: "snooze";
|
341
|
+
} | {
|
342
|
+
type: "questlist";
|
343
|
+
value: number;
|
344
|
+
} | {
|
345
|
+
type: "step_back";
|
346
|
+
} | {
|
347
|
+
type: "nudge";
|
348
|
+
value: number;
|
349
|
+
} | {
|
350
|
+
type: "go_to_step";
|
351
|
+
value: number;
|
352
|
+
} | ({
|
353
|
+
type: "open_bar";
|
354
|
+
} & {
|
355
|
+
value?: string | undefined;
|
356
|
+
categoryFilter?: number | undefined;
|
357
|
+
}) | {
|
358
|
+
type: "open_helphub";
|
359
|
+
} | {
|
360
|
+
type: "open_copilot";
|
361
|
+
} | {
|
362
|
+
type: "no_action";
|
161
363
|
};
|
162
364
|
}[];
|
163
365
|
nudge_rate_limit: number | null;
|
164
366
|
bar_hide_completed_nudges_questlists: boolean;
|
165
367
|
nudge_rate_period: "day" | "week" | "session";
|
368
|
+
share_link_param: string;
|
369
|
+
spotlight_ask_copilot_enabled: boolean;
|
370
|
+
spotlight_ask_copilot_label: string | null;
|
371
|
+
copilot_enabled: boolean;
|
372
|
+
helphub_ai_enabled: boolean;
|
373
|
+
copilot_experiences_enabled: boolean;
|
374
|
+
helphub_chat_only_mode: boolean;
|
166
375
|
}>;
|
167
376
|
export declare const update: (object: {
|
168
377
|
end_user_limit?: number | undefined;
|
@@ -195,25 +404,39 @@ export declare const update: (object: {
|
|
195
404
|
slash_filters_enabled?: boolean | undefined;
|
196
405
|
recents_sort_key?: number | null | undefined;
|
197
406
|
recommended_sort_key?: number | null | undefined;
|
407
|
+
experiences_sort_key?: number | null | undefined;
|
198
408
|
num_live_commands?: number | undefined;
|
199
409
|
help_center_sync?: "manual" | "upload-once" | "automatic" | undefined;
|
200
410
|
show_suggested_synonyms?: boolean | undefined;
|
201
411
|
bar_enabled?: boolean | undefined;
|
202
412
|
in_bar_doc_search?: boolean | undefined;
|
203
413
|
featured_item_cards?: boolean | undefined;
|
204
|
-
helphub_ai_enabled?: boolean | undefined;
|
205
414
|
chat_system_prompt_modifier?: string | undefined;
|
206
415
|
helphub_chat_welcome_message?: string | undefined;
|
207
416
|
helphub_suggested_queries_enabled?: boolean | undefined;
|
208
417
|
helphub_continuations_enabled?: boolean | undefined;
|
209
418
|
helphub_manual_suggested_queries?: string[] | undefined;
|
210
|
-
|
419
|
+
copilot_name?: string | undefined;
|
420
|
+
copilot_avatar?: string | undefined;
|
421
|
+
copilot_personality?: {
|
422
|
+
template: "professional" | "friendly" | "confident" | "serious" | "empathetic";
|
423
|
+
} | {
|
424
|
+
template: "custom";
|
425
|
+
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")[];
|
426
|
+
response_length: "long" | "short" | "conversational";
|
427
|
+
response_format: "mixed" | "lists" | "paragraphs";
|
428
|
+
} | undefined;
|
211
429
|
helphub_enabled?: boolean | undefined;
|
212
|
-
helphub_launcher_type?: "none" | "custom" | "
|
213
|
-
helphub_launcher_position?: "
|
430
|
+
helphub_launcher_type?: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI" | undefined;
|
431
|
+
helphub_launcher_position?: "bottomRight" | "bottomLeft" | "topRight" | "topLeft" | undefined;
|
214
432
|
helphub_launcher_offset_x?: number | undefined;
|
215
433
|
helphub_launcher_offset_y?: number | undefined;
|
216
434
|
helphub_launcher_anchor?: string | undefined;
|
435
|
+
helphub_mobile_launcher_type?: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI" | undefined;
|
436
|
+
helphub_mobile_launcher_position?: "bottomRight" | "bottomLeft" | "topRight" | "topLeft" | undefined;
|
437
|
+
helphub_mobile_launcher_offset_x?: number | undefined;
|
438
|
+
helphub_mobile_launcher_offset_y?: number | undefined;
|
439
|
+
helphub_mobile_launcher_anchor?: string | undefined;
|
217
440
|
helphub_chat_fallback_message?: string | undefined;
|
218
441
|
helphub_chat_fallback_actions?: {
|
219
442
|
cta: string;
|
@@ -221,12 +444,70 @@ export declare const update: (object: {
|
|
221
444
|
type: "execute_command";
|
222
445
|
meta: {
|
223
446
|
command: string;
|
447
|
+
} & {
|
448
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
449
|
+
};
|
450
|
+
} | {
|
451
|
+
type: "click";
|
452
|
+
value: string;
|
453
|
+
} | {
|
454
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
455
|
+
value: string[];
|
456
|
+
} | ({
|
457
|
+
type: "link";
|
458
|
+
value: string;
|
459
|
+
} & {
|
460
|
+
operation?: "self" | "router" | "blank" | undefined;
|
461
|
+
}) | {
|
462
|
+
type: "open_chat";
|
463
|
+
meta: {
|
464
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
224
465
|
};
|
466
|
+
} | {
|
467
|
+
type: "dismiss";
|
468
|
+
} | {
|
469
|
+
type: "snooze";
|
470
|
+
} | {
|
471
|
+
type: "questlist";
|
472
|
+
value: number;
|
473
|
+
} | {
|
474
|
+
type: "step_back";
|
475
|
+
} | {
|
476
|
+
type: "nudge";
|
477
|
+
value: number;
|
478
|
+
} | {
|
479
|
+
type: "go_to_step";
|
480
|
+
value: number;
|
481
|
+
} | ({
|
482
|
+
type: "open_bar";
|
483
|
+
} & {
|
484
|
+
value?: string | undefined;
|
485
|
+
categoryFilter?: number | undefined;
|
486
|
+
}) | {
|
487
|
+
type: "open_helphub";
|
488
|
+
} | {
|
489
|
+
type: "open_copilot";
|
225
490
|
} | {
|
226
491
|
type: "no_action";
|
492
|
+
};
|
493
|
+
}[] | undefined;
|
494
|
+
copilot_negative_feedback_fallback_enabled?: boolean | undefined;
|
495
|
+
copilot_negative_feedback_fallback_message?: string | null | undefined;
|
496
|
+
copilot_negative_feedback_fallback_actions?: {
|
497
|
+
cta: string;
|
498
|
+
action: {
|
499
|
+
type: "execute_command";
|
500
|
+
meta: {
|
501
|
+
command: string;
|
502
|
+
} & {
|
503
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
504
|
+
};
|
227
505
|
} | {
|
228
506
|
type: "click";
|
229
507
|
value: string;
|
508
|
+
} | {
|
509
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
510
|
+
value: string[];
|
230
511
|
} | ({
|
231
512
|
type: "link";
|
232
513
|
value: string;
|
@@ -235,15 +516,46 @@ export declare const update: (object: {
|
|
235
516
|
}) | {
|
236
517
|
type: "open_chat";
|
237
518
|
meta: {
|
238
|
-
type:
|
519
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
239
520
|
};
|
240
521
|
} | {
|
241
522
|
type: "dismiss";
|
523
|
+
} | {
|
524
|
+
type: "snooze";
|
525
|
+
} | {
|
526
|
+
type: "questlist";
|
527
|
+
value: number;
|
528
|
+
} | {
|
529
|
+
type: "step_back";
|
530
|
+
} | {
|
531
|
+
type: "nudge";
|
532
|
+
value: number;
|
533
|
+
} | {
|
534
|
+
type: "go_to_step";
|
535
|
+
value: number;
|
536
|
+
} | ({
|
537
|
+
type: "open_bar";
|
538
|
+
} & {
|
539
|
+
value?: string | undefined;
|
540
|
+
categoryFilter?: number | undefined;
|
541
|
+
}) | {
|
542
|
+
type: "open_helphub";
|
543
|
+
} | {
|
544
|
+
type: "open_copilot";
|
545
|
+
} | {
|
546
|
+
type: "no_action";
|
242
547
|
};
|
243
548
|
}[] | undefined;
|
244
549
|
nudge_rate_limit?: number | null | undefined;
|
245
550
|
bar_hide_completed_nudges_questlists?: boolean | undefined;
|
246
551
|
nudge_rate_period?: "day" | "week" | "session" | undefined;
|
552
|
+
share_link_param?: string | undefined;
|
553
|
+
spotlight_ask_copilot_enabled?: boolean | undefined;
|
554
|
+
spotlight_ask_copilot_label?: string | null | undefined;
|
555
|
+
copilot_enabled?: boolean | undefined;
|
556
|
+
helphub_ai_enabled?: boolean | undefined;
|
557
|
+
copilot_experiences_enabled?: boolean | undefined;
|
558
|
+
helphub_chat_only_mode?: boolean | undefined;
|
247
559
|
}, params?: Record<string, string> | undefined, callbacks?: {
|
248
560
|
onSuccess?: (() => void) | undefined;
|
249
561
|
onError?: ((err: string) => void) | undefined;
|
@@ -278,25 +590,39 @@ export declare const update: (object: {
|
|
278
590
|
slash_filters_enabled: boolean;
|
279
591
|
recents_sort_key: number | null;
|
280
592
|
recommended_sort_key: number | null;
|
593
|
+
experiences_sort_key: number | null;
|
281
594
|
num_live_commands: number;
|
282
595
|
help_center_sync: "manual" | "upload-once" | "automatic";
|
283
596
|
show_suggested_synonyms: boolean;
|
284
597
|
bar_enabled: boolean;
|
285
598
|
in_bar_doc_search: boolean;
|
286
599
|
featured_item_cards: boolean;
|
287
|
-
helphub_ai_enabled: boolean;
|
288
600
|
chat_system_prompt_modifier: string;
|
289
601
|
helphub_chat_welcome_message: string;
|
290
602
|
helphub_suggested_queries_enabled: boolean;
|
291
603
|
helphub_continuations_enabled: boolean;
|
292
604
|
helphub_manual_suggested_queries: string[];
|
293
|
-
|
605
|
+
copilot_name: string;
|
606
|
+
copilot_avatar: string;
|
607
|
+
copilot_personality: {
|
608
|
+
template: "professional" | "friendly" | "confident" | "serious" | "empathetic";
|
609
|
+
} | {
|
610
|
+
template: "custom";
|
611
|
+
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")[];
|
612
|
+
response_length: "long" | "short" | "conversational";
|
613
|
+
response_format: "mixed" | "lists" | "paragraphs";
|
614
|
+
};
|
294
615
|
helphub_enabled: boolean;
|
295
|
-
helphub_launcher_type: "none" | "custom" | "
|
296
|
-
helphub_launcher_position: "
|
616
|
+
helphub_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
|
617
|
+
helphub_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
297
618
|
helphub_launcher_offset_x: number;
|
298
619
|
helphub_launcher_offset_y: number;
|
299
620
|
helphub_launcher_anchor: string;
|
621
|
+
helphub_mobile_launcher_type: "none" | "custom" | "bookClosed" | "bookOpen" | "graduationHat" | "bookmark" | "chatCircle" | "askAI";
|
622
|
+
helphub_mobile_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
|
623
|
+
helphub_mobile_launcher_offset_x: number;
|
624
|
+
helphub_mobile_launcher_offset_y: number;
|
625
|
+
helphub_mobile_launcher_anchor: string;
|
300
626
|
helphub_chat_fallback_message: string;
|
301
627
|
helphub_chat_fallback_actions: {
|
302
628
|
cta: string;
|
@@ -304,12 +630,70 @@ export declare const update: (object: {
|
|
304
630
|
type: "execute_command";
|
305
631
|
meta: {
|
306
632
|
command: string;
|
633
|
+
} & {
|
634
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
635
|
+
};
|
636
|
+
} | {
|
637
|
+
type: "click";
|
638
|
+
value: string;
|
639
|
+
} | {
|
640
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
641
|
+
value: string[];
|
642
|
+
} | ({
|
643
|
+
type: "link";
|
644
|
+
value: string;
|
645
|
+
} & {
|
646
|
+
operation?: "self" | "router" | "blank" | undefined;
|
647
|
+
}) | {
|
648
|
+
type: "open_chat";
|
649
|
+
meta: {
|
650
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
307
651
|
};
|
652
|
+
} | {
|
653
|
+
type: "dismiss";
|
654
|
+
} | {
|
655
|
+
type: "snooze";
|
656
|
+
} | {
|
657
|
+
type: "questlist";
|
658
|
+
value: number;
|
659
|
+
} | {
|
660
|
+
type: "step_back";
|
661
|
+
} | {
|
662
|
+
type: "nudge";
|
663
|
+
value: number;
|
664
|
+
} | {
|
665
|
+
type: "go_to_step";
|
666
|
+
value: number;
|
667
|
+
} | ({
|
668
|
+
type: "open_bar";
|
669
|
+
} & {
|
670
|
+
value?: string | undefined;
|
671
|
+
categoryFilter?: number | undefined;
|
672
|
+
}) | {
|
673
|
+
type: "open_helphub";
|
674
|
+
} | {
|
675
|
+
type: "open_copilot";
|
308
676
|
} | {
|
309
677
|
type: "no_action";
|
678
|
+
};
|
679
|
+
}[];
|
680
|
+
copilot_negative_feedback_fallback_enabled: boolean;
|
681
|
+
copilot_negative_feedback_fallback_message: string | null;
|
682
|
+
copilot_negative_feedback_fallback_actions: {
|
683
|
+
cta: string;
|
684
|
+
action: {
|
685
|
+
type: "execute_command";
|
686
|
+
meta: {
|
687
|
+
command: string;
|
688
|
+
} & {
|
689
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
690
|
+
};
|
310
691
|
} | {
|
311
692
|
type: "click";
|
312
693
|
value: string;
|
694
|
+
} | {
|
695
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
696
|
+
value: string[];
|
313
697
|
} | ({
|
314
698
|
type: "link";
|
315
699
|
value: string;
|
@@ -318,13 +702,44 @@ export declare const update: (object: {
|
|
318
702
|
}) | {
|
319
703
|
type: "open_chat";
|
320
704
|
meta: {
|
321
|
-
type:
|
705
|
+
type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
|
322
706
|
};
|
323
707
|
} | {
|
324
708
|
type: "dismiss";
|
709
|
+
} | {
|
710
|
+
type: "snooze";
|
711
|
+
} | {
|
712
|
+
type: "questlist";
|
713
|
+
value: number;
|
714
|
+
} | {
|
715
|
+
type: "step_back";
|
716
|
+
} | {
|
717
|
+
type: "nudge";
|
718
|
+
value: number;
|
719
|
+
} | {
|
720
|
+
type: "go_to_step";
|
721
|
+
value: number;
|
722
|
+
} | ({
|
723
|
+
type: "open_bar";
|
724
|
+
} & {
|
725
|
+
value?: string | undefined;
|
726
|
+
categoryFilter?: number | undefined;
|
727
|
+
}) | {
|
728
|
+
type: "open_helphub";
|
729
|
+
} | {
|
730
|
+
type: "open_copilot";
|
731
|
+
} | {
|
732
|
+
type: "no_action";
|
325
733
|
};
|
326
734
|
}[];
|
327
735
|
nudge_rate_limit: number | null;
|
328
736
|
bar_hide_completed_nudges_questlists: boolean;
|
329
737
|
nudge_rate_period: "day" | "week" | "session";
|
738
|
+
share_link_param: string;
|
739
|
+
spotlight_ask_copilot_enabled: boolean;
|
740
|
+
spotlight_ask_copilot_label: string | null;
|
741
|
+
copilot_enabled: boolean;
|
742
|
+
helphub_ai_enabled: boolean;
|
743
|
+
copilot_experiences_enabled: boolean;
|
744
|
+
helphub_chat_only_mode: boolean;
|
330
745
|
}>;
|
@@ -2,10 +2,12 @@ import * as t from 'io-ts';
|
|
2
2
|
export declare const ProfileV: t.TypeC<{
|
3
3
|
user: t.StringC;
|
4
4
|
organization: t.StringC;
|
5
|
+
is_active: t.BooleanC;
|
5
6
|
}>;
|
6
7
|
export declare class Profile {
|
7
8
|
static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
8
9
|
user: string;
|
9
10
|
organization: string;
|
11
|
+
is_active: boolean;
|
10
12
|
}[]>;
|
11
13
|
}
|