commandbar 1.8.7 → 1.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{internal/src/client → commandbar/src/shared/services/analytics}/EventHandler.d.ts +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,19 +1,29 @@
|
|
|
1
1
|
import * as t from 'io-ts';
|
|
2
2
|
import { IOrganizationType } from './types';
|
|
3
|
-
declare const OrganizationAdditionalV: t.TypeC<{
|
|
3
|
+
declare const OrganizationAdditionalV: t.IntersectionC<[t.TypeC<{
|
|
4
|
+
disabled: t.BooleanC;
|
|
4
5
|
launcher_type: t.UnionC<[t.LiteralC<"minimal">, t.LiteralC<"alternate">, t.LiteralC<"prompt">, t.LiteralC<"none">]>;
|
|
5
6
|
launcher_position: t.UnionC<[t.LiteralC<"topRight">, t.LiteralC<"topLeft">, t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
|
|
6
7
|
show_launcher_recommendations: t.BooleanC;
|
|
7
8
|
recommendations_type: t.UnionC<[t.LiteralC<"None">, t.LiteralC<"Custom">, t.LiteralC<"Algorithm">, t.UndefinedC]>;
|
|
8
9
|
launcher_offset_x: t.NumberC;
|
|
9
10
|
launcher_offset_y: t.NumberC;
|
|
10
|
-
helphub_launcher_offset_x: t.NumberC;
|
|
11
|
-
helphub_launcher_offset_y: t.NumberC;
|
|
12
|
-
helphub_launcher_anchor: t.StringC;
|
|
13
|
-
helphub_launcher_position: t.UnionC<[t.LiteralC<"topRight">, t.LiteralC<"topLeft">, t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
|
|
14
|
-
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">]>;
|
|
15
11
|
base_url: t.StringC;
|
|
16
12
|
theme: t.ObjectC;
|
|
13
|
+
themeV2: t.UnionC<[t.TypeC<{
|
|
14
|
+
light_mode: t.TypeC<{
|
|
15
|
+
var_defaults: t.RecordC<t.StringC, t.StringC>;
|
|
16
|
+
var_overrides: t.RecordC<t.StringC, t.StringC>;
|
|
17
|
+
component_overrides: t.RecordC<t.StringC, t.AnyC>;
|
|
18
|
+
mobile_overrides: t.RecordC<t.StringC, t.AnyC>;
|
|
19
|
+
}>;
|
|
20
|
+
dark_mode: t.TypeC<{
|
|
21
|
+
var_defaults: t.RecordC<t.StringC, t.StringC>;
|
|
22
|
+
var_overrides: t.RecordC<t.StringC, t.StringC>;
|
|
23
|
+
component_overrides: t.RecordC<t.StringC, t.AnyC>;
|
|
24
|
+
mobile_overrides: t.RecordC<t.StringC, t.AnyC>;
|
|
25
|
+
}>;
|
|
26
|
+
}>, t.NullC, t.UndefinedC]>;
|
|
17
27
|
icon: t.StringC;
|
|
18
28
|
icon_suggest: t.StringC;
|
|
19
29
|
icon_tutorial: t.StringC;
|
|
@@ -106,29 +116,88 @@ declare const OrganizationAdditionalV: t.TypeC<{
|
|
|
106
116
|
slash_filters_enabled: t.BooleanC;
|
|
107
117
|
recents_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
|
|
108
118
|
recommended_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
|
|
119
|
+
experiences_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
|
|
109
120
|
show_suggested_synonyms: t.BooleanC;
|
|
110
121
|
has_hotloaded_help_docs: t.BooleanC;
|
|
111
122
|
bar_enabled: t.BooleanC;
|
|
112
123
|
in_bar_doc_search: t.BooleanC;
|
|
113
124
|
featured_item_cards: t.BooleanC;
|
|
114
|
-
helphub_ai_enabled: t.BooleanC;
|
|
115
125
|
helphub_suggested_queries_enabled: t.BooleanC;
|
|
116
126
|
helphub_continuations_enabled: t.BooleanC;
|
|
117
|
-
helphub_chat_only_mode: t.BooleanC;
|
|
118
127
|
helphub_enabled: t.BooleanC;
|
|
119
128
|
helphub_chat_fallback_message: t.UnionC<[t.StringC, t.NullC]>;
|
|
120
129
|
helphub_chat_fallback_actions: t.ArrayC<t.TypeC<{
|
|
121
130
|
cta: t.StringC;
|
|
122
131
|
action: t.UnionC<[t.TypeC<{
|
|
123
132
|
type: t.LiteralC<"execute_command">;
|
|
124
|
-
meta: t.TypeC<{
|
|
133
|
+
meta: t.IntersectionC<[t.TypeC<{
|
|
125
134
|
command: t.StringC;
|
|
135
|
+
}>, t.PartialC<{
|
|
136
|
+
type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
|
|
137
|
+
}>]>;
|
|
138
|
+
}>, t.TypeC<{
|
|
139
|
+
type: t.LiteralC<"no_action">;
|
|
140
|
+
}>, t.TypeC<{
|
|
141
|
+
type: t.LiteralC<"click">;
|
|
142
|
+
value: t.StringC;
|
|
143
|
+
}>, t.TypeC<{
|
|
144
|
+
type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
|
|
145
|
+
value: t.ArrayC<t.StringC>;
|
|
146
|
+
}>, t.IntersectionC<[t.TypeC<{
|
|
147
|
+
type: t.LiteralC<"link">;
|
|
148
|
+
value: t.StringC;
|
|
149
|
+
}>, t.PartialC<{
|
|
150
|
+
operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
|
|
151
|
+
}>]>, t.TypeC<{
|
|
152
|
+
type: t.LiteralC<"open_chat">;
|
|
153
|
+
meta: t.TypeC<{
|
|
154
|
+
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<"">]>;
|
|
126
155
|
}>;
|
|
156
|
+
}>, t.TypeC<{
|
|
157
|
+
type: t.LiteralC<"dismiss">;
|
|
158
|
+
}>, t.TypeC<{
|
|
159
|
+
type: t.LiteralC<"snooze">;
|
|
160
|
+
}>, t.TypeC<{
|
|
161
|
+
type: t.LiteralC<"questlist">;
|
|
162
|
+
value: t.NumberC;
|
|
163
|
+
}>, t.TypeC<{
|
|
164
|
+
type: t.LiteralC<"nudge">;
|
|
165
|
+
value: t.NumberC;
|
|
166
|
+
}>, t.TypeC<{
|
|
167
|
+
type: t.LiteralC<"go_to_step">;
|
|
168
|
+
value: t.NumberC;
|
|
169
|
+
}>, t.TypeC<{
|
|
170
|
+
type: t.LiteralC<"step_back">;
|
|
171
|
+
}>, t.IntersectionC<[t.TypeC<{
|
|
172
|
+
type: t.LiteralC<"open_bar">;
|
|
173
|
+
}>, t.PartialC<{
|
|
174
|
+
value: t.StringC;
|
|
175
|
+
categoryFilter: t.NumberC;
|
|
176
|
+
}>]>, t.TypeC<{
|
|
177
|
+
type: t.LiteralC<"open_helphub">;
|
|
178
|
+
}>, t.TypeC<{
|
|
179
|
+
type: t.LiteralC<"open_copilot">;
|
|
180
|
+
}>]>;
|
|
181
|
+
}>>;
|
|
182
|
+
copilot_negative_feedback_fallback_enabled: t.BooleanC;
|
|
183
|
+
copilot_negative_feedback_fallback_message: t.UnionC<[t.StringC, t.NullC]>;
|
|
184
|
+
copilot_negative_feedback_fallback_actions: t.ArrayC<t.TypeC<{
|
|
185
|
+
cta: t.StringC;
|
|
186
|
+
action: t.UnionC<[t.TypeC<{
|
|
187
|
+
type: t.LiteralC<"execute_command">;
|
|
188
|
+
meta: t.IntersectionC<[t.TypeC<{
|
|
189
|
+
command: t.StringC;
|
|
190
|
+
}>, t.PartialC<{
|
|
191
|
+
type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
|
|
192
|
+
}>]>;
|
|
127
193
|
}>, t.TypeC<{
|
|
128
194
|
type: t.LiteralC<"no_action">;
|
|
129
195
|
}>, t.TypeC<{
|
|
130
196
|
type: t.LiteralC<"click">;
|
|
131
197
|
value: t.StringC;
|
|
198
|
+
}>, t.TypeC<{
|
|
199
|
+
type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
|
|
200
|
+
value: t.ArrayC<t.StringC>;
|
|
132
201
|
}>, t.IntersectionC<[t.TypeC<{
|
|
133
202
|
type: t.LiteralC<"link">;
|
|
134
203
|
value: t.StringC;
|
|
@@ -137,16 +206,49 @@ declare const OrganizationAdditionalV: t.TypeC<{
|
|
|
137
206
|
}>]>, t.TypeC<{
|
|
138
207
|
type: t.LiteralC<"open_chat">;
|
|
139
208
|
meta: t.TypeC<{
|
|
140
|
-
type: t.
|
|
209
|
+
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<"">]>;
|
|
141
210
|
}>;
|
|
142
211
|
}>, t.TypeC<{
|
|
143
212
|
type: t.LiteralC<"dismiss">;
|
|
213
|
+
}>, t.TypeC<{
|
|
214
|
+
type: t.LiteralC<"snooze">;
|
|
215
|
+
}>, t.TypeC<{
|
|
216
|
+
type: t.LiteralC<"questlist">;
|
|
217
|
+
value: t.NumberC;
|
|
218
|
+
}>, t.TypeC<{
|
|
219
|
+
type: t.LiteralC<"nudge">;
|
|
220
|
+
value: t.NumberC;
|
|
221
|
+
}>, t.TypeC<{
|
|
222
|
+
type: t.LiteralC<"go_to_step">;
|
|
223
|
+
value: t.NumberC;
|
|
224
|
+
}>, t.TypeC<{
|
|
225
|
+
type: t.LiteralC<"step_back">;
|
|
226
|
+
}>, t.IntersectionC<[t.TypeC<{
|
|
227
|
+
type: t.LiteralC<"open_bar">;
|
|
228
|
+
}>, t.PartialC<{
|
|
229
|
+
value: t.StringC;
|
|
230
|
+
categoryFilter: t.NumberC;
|
|
231
|
+
}>]>, t.TypeC<{
|
|
232
|
+
type: t.LiteralC<"open_helphub">;
|
|
233
|
+
}>, t.TypeC<{
|
|
234
|
+
type: t.LiteralC<"open_copilot">;
|
|
144
235
|
}>]>;
|
|
145
236
|
}>>;
|
|
146
237
|
helphub_manual_suggested_queries: t.ArrayC<t.StringC>;
|
|
238
|
+
copilot_name: t.StringC;
|
|
239
|
+
copilot_avatar: t.StringC;
|
|
240
|
+
copilot_personality: t.UnionC<[t.TypeC<{
|
|
241
|
+
template: t.UnionC<[t.LiteralC<"professional">, t.LiteralC<"friendly">, t.LiteralC<"confident">, t.LiteralC<"serious">, t.LiteralC<"empathetic">]>;
|
|
242
|
+
}>, t.TypeC<{
|
|
243
|
+
template: t.LiteralC<"custom">;
|
|
244
|
+
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">]>>;
|
|
245
|
+
response_length: t.UnionC<[t.LiteralC<"short">, t.LiteralC<"conversational">, t.LiteralC<"long">]>;
|
|
246
|
+
response_format: t.UnionC<[t.LiteralC<"lists">, t.LiteralC<"paragraphs">, t.LiteralC<"mixed">]>;
|
|
247
|
+
}>]>;
|
|
147
248
|
nudge_rate_limit: t.UnionC<[t.NullC, t.NumberC]>;
|
|
148
249
|
bar_hide_completed_nudges_questlists: t.BooleanC;
|
|
149
250
|
nudge_rate_period: t.UnionC<[t.LiteralC<"day">, t.LiteralC<"week">, t.LiteralC<"session">]>;
|
|
251
|
+
share_link_param: t.StringC;
|
|
150
252
|
installed_at: t.UnionC<[t.StringC, t.NullC]>;
|
|
151
253
|
integrations: t.PartialC<{
|
|
152
254
|
algolia: t.TypeC<{
|
|
@@ -158,27 +260,84 @@ declare const OrganizationAdditionalV: t.TypeC<{
|
|
|
158
260
|
segments: t.RecordC<t.StringC, t.StringC>;
|
|
159
261
|
send_events_to_heap: t.BooleanC;
|
|
160
262
|
}>;
|
|
263
|
+
amplitude: t.TypeC<{
|
|
264
|
+
enabled: t.BooleanC;
|
|
265
|
+
}>;
|
|
266
|
+
logrocket: t.TypeC<{
|
|
267
|
+
enabled: t.BooleanC;
|
|
268
|
+
}>;
|
|
269
|
+
mixpanel: t.TypeC<{
|
|
270
|
+
enabled: t.BooleanC;
|
|
271
|
+
}>;
|
|
272
|
+
posthog: t.TypeC<{
|
|
273
|
+
enabled: t.BooleanC;
|
|
274
|
+
}>;
|
|
275
|
+
rudderstack: t.TypeC<{
|
|
276
|
+
enabled: t.BooleanC;
|
|
277
|
+
}>;
|
|
278
|
+
slack: t.TypeC<{
|
|
279
|
+
channelId: t.StringC;
|
|
280
|
+
configuration: t.TypeC<{
|
|
281
|
+
analytic_events: t.ArrayC<t.StringC>;
|
|
282
|
+
}>;
|
|
283
|
+
}>;
|
|
284
|
+
hubspot: t.PartialC<{
|
|
285
|
+
send_events_to_hubspot: t.BooleanC;
|
|
286
|
+
lists: t.RecordC<t.StringC, t.StringC>;
|
|
287
|
+
}>;
|
|
161
288
|
}>;
|
|
162
|
-
|
|
289
|
+
copilot_enabled: t.BooleanC;
|
|
290
|
+
user_property_targeting: t.BooleanC;
|
|
291
|
+
ab_test_conditions: t.BooleanC;
|
|
292
|
+
spotlight_ask_copilot_enabled: t.BooleanC;
|
|
293
|
+
spotlight_ask_copilot_label: t.UnionC<[t.StringC, t.NullC]>;
|
|
294
|
+
/** @deprecated Replaced by the `copilot_enabled` field */
|
|
295
|
+
helphub_ai_enabled: t.BooleanC;
|
|
296
|
+
/** @deprecated Removed entirely */
|
|
297
|
+
copilot_experiences_enabled: t.BooleanC;
|
|
298
|
+
/** @deprecated Replaced by a combination of `copilot_enabled` and `helphub_enabled` */
|
|
299
|
+
helphub_chat_only_mode: t.BooleanC;
|
|
300
|
+
}>, t.TypeC<{
|
|
301
|
+
helphub_launcher_offset_x: t.NumberC;
|
|
302
|
+
helphub_launcher_offset_y: t.NumberC;
|
|
303
|
+
helphub_launcher_anchor: t.StringC;
|
|
304
|
+
helphub_launcher_position: t.UnionC<[t.LiteralC<"topRight">, t.LiteralC<"topLeft">, t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
|
|
305
|
+
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">]>;
|
|
306
|
+
helphub_mobile_launcher_offset_x: t.NumberC;
|
|
307
|
+
helphub_mobile_launcher_offset_y: t.NumberC;
|
|
308
|
+
helphub_mobile_launcher_anchor: t.StringC;
|
|
309
|
+
helphub_mobile_launcher_position: t.UnionC<[t.LiteralC<"topRight">, t.LiteralC<"topLeft">, t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
|
|
310
|
+
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">]>;
|
|
311
|
+
}>]>;
|
|
163
312
|
export declare const defaults: t.TypeOf<typeof OrganizationAdditionalV>;
|
|
164
313
|
export declare const OrganizationV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
|
|
165
314
|
id: t.UnionC<[t.NumberC, t.StringC]>;
|
|
166
315
|
name: t.StringC;
|
|
167
316
|
created: t.StringC;
|
|
168
|
-
}>, t.PartialC<{}>]>, t.TypeC<{
|
|
317
|
+
}>, t.PartialC<{}>]>, t.IntersectionC<[t.TypeC<{
|
|
318
|
+
disabled: t.BooleanC;
|
|
169
319
|
launcher_type: t.UnionC<[t.LiteralC<"minimal">, t.LiteralC<"alternate">, t.LiteralC<"prompt">, t.LiteralC<"none">]>;
|
|
170
320
|
launcher_position: t.UnionC<[t.LiteralC<"topRight">, t.LiteralC<"topLeft">, t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
|
|
171
321
|
show_launcher_recommendations: t.BooleanC;
|
|
172
322
|
recommendations_type: t.UnionC<[t.LiteralC<"None">, t.LiteralC<"Custom">, t.LiteralC<"Algorithm">, t.UndefinedC]>;
|
|
173
323
|
launcher_offset_x: t.NumberC;
|
|
174
324
|
launcher_offset_y: t.NumberC;
|
|
175
|
-
helphub_launcher_offset_x: t.NumberC;
|
|
176
|
-
helphub_launcher_offset_y: t.NumberC;
|
|
177
|
-
helphub_launcher_anchor: t.StringC;
|
|
178
|
-
helphub_launcher_position: t.UnionC<[t.LiteralC<"topRight">, t.LiteralC<"topLeft">, t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
|
|
179
|
-
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">]>;
|
|
180
325
|
base_url: t.StringC;
|
|
181
326
|
theme: t.ObjectC;
|
|
327
|
+
themeV2: t.UnionC<[t.TypeC<{
|
|
328
|
+
light_mode: t.TypeC<{
|
|
329
|
+
var_defaults: t.RecordC<t.StringC, t.StringC>;
|
|
330
|
+
var_overrides: t.RecordC<t.StringC, t.StringC>;
|
|
331
|
+
component_overrides: t.RecordC<t.StringC, t.AnyC>;
|
|
332
|
+
mobile_overrides: t.RecordC<t.StringC, t.AnyC>;
|
|
333
|
+
}>;
|
|
334
|
+
dark_mode: t.TypeC<{
|
|
335
|
+
var_defaults: t.RecordC<t.StringC, t.StringC>;
|
|
336
|
+
var_overrides: t.RecordC<t.StringC, t.StringC>;
|
|
337
|
+
component_overrides: t.RecordC<t.StringC, t.AnyC>;
|
|
338
|
+
mobile_overrides: t.RecordC<t.StringC, t.AnyC>;
|
|
339
|
+
}>;
|
|
340
|
+
}>, t.NullC, t.UndefinedC]>;
|
|
182
341
|
icon: t.StringC;
|
|
183
342
|
icon_suggest: t.StringC;
|
|
184
343
|
icon_tutorial: t.StringC;
|
|
@@ -271,29 +430,88 @@ export declare const OrganizationV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
|
|
|
271
430
|
slash_filters_enabled: t.BooleanC;
|
|
272
431
|
recents_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
|
|
273
432
|
recommended_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
|
|
433
|
+
experiences_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
|
|
274
434
|
show_suggested_synonyms: t.BooleanC;
|
|
275
435
|
has_hotloaded_help_docs: t.BooleanC;
|
|
276
436
|
bar_enabled: t.BooleanC;
|
|
277
437
|
in_bar_doc_search: t.BooleanC;
|
|
278
438
|
featured_item_cards: t.BooleanC;
|
|
279
|
-
helphub_ai_enabled: t.BooleanC;
|
|
280
439
|
helphub_suggested_queries_enabled: t.BooleanC;
|
|
281
440
|
helphub_continuations_enabled: t.BooleanC;
|
|
282
|
-
helphub_chat_only_mode: t.BooleanC;
|
|
283
441
|
helphub_enabled: t.BooleanC;
|
|
284
442
|
helphub_chat_fallback_message: t.UnionC<[t.StringC, t.NullC]>;
|
|
285
443
|
helphub_chat_fallback_actions: t.ArrayC<t.TypeC<{
|
|
286
444
|
cta: t.StringC;
|
|
287
445
|
action: t.UnionC<[t.TypeC<{
|
|
288
446
|
type: t.LiteralC<"execute_command">;
|
|
289
|
-
meta: t.TypeC<{
|
|
447
|
+
meta: t.IntersectionC<[t.TypeC<{
|
|
290
448
|
command: t.StringC;
|
|
449
|
+
}>, t.PartialC<{
|
|
450
|
+
type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
|
|
451
|
+
}>]>;
|
|
452
|
+
}>, t.TypeC<{
|
|
453
|
+
type: t.LiteralC<"no_action">;
|
|
454
|
+
}>, t.TypeC<{
|
|
455
|
+
type: t.LiteralC<"click">;
|
|
456
|
+
value: t.StringC;
|
|
457
|
+
}>, t.TypeC<{
|
|
458
|
+
type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
|
|
459
|
+
value: t.ArrayC<t.StringC>;
|
|
460
|
+
}>, t.IntersectionC<[t.TypeC<{
|
|
461
|
+
type: t.LiteralC<"link">;
|
|
462
|
+
value: t.StringC;
|
|
463
|
+
}>, t.PartialC<{
|
|
464
|
+
operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
|
|
465
|
+
}>]>, t.TypeC<{
|
|
466
|
+
type: t.LiteralC<"open_chat">;
|
|
467
|
+
meta: t.TypeC<{
|
|
468
|
+
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<"">]>;
|
|
291
469
|
}>;
|
|
470
|
+
}>, t.TypeC<{
|
|
471
|
+
type: t.LiteralC<"dismiss">;
|
|
472
|
+
}>, t.TypeC<{
|
|
473
|
+
type: t.LiteralC<"snooze">;
|
|
474
|
+
}>, t.TypeC<{
|
|
475
|
+
type: t.LiteralC<"questlist">;
|
|
476
|
+
value: t.NumberC;
|
|
477
|
+
}>, t.TypeC<{
|
|
478
|
+
type: t.LiteralC<"nudge">;
|
|
479
|
+
value: t.NumberC;
|
|
480
|
+
}>, t.TypeC<{
|
|
481
|
+
type: t.LiteralC<"go_to_step">;
|
|
482
|
+
value: t.NumberC;
|
|
483
|
+
}>, t.TypeC<{
|
|
484
|
+
type: t.LiteralC<"step_back">;
|
|
485
|
+
}>, t.IntersectionC<[t.TypeC<{
|
|
486
|
+
type: t.LiteralC<"open_bar">;
|
|
487
|
+
}>, t.PartialC<{
|
|
488
|
+
value: t.StringC;
|
|
489
|
+
categoryFilter: t.NumberC;
|
|
490
|
+
}>]>, t.TypeC<{
|
|
491
|
+
type: t.LiteralC<"open_helphub">;
|
|
492
|
+
}>, t.TypeC<{
|
|
493
|
+
type: t.LiteralC<"open_copilot">;
|
|
494
|
+
}>]>;
|
|
495
|
+
}>>;
|
|
496
|
+
copilot_negative_feedback_fallback_enabled: t.BooleanC;
|
|
497
|
+
copilot_negative_feedback_fallback_message: t.UnionC<[t.StringC, t.NullC]>;
|
|
498
|
+
copilot_negative_feedback_fallback_actions: t.ArrayC<t.TypeC<{
|
|
499
|
+
cta: t.StringC;
|
|
500
|
+
action: t.UnionC<[t.TypeC<{
|
|
501
|
+
type: t.LiteralC<"execute_command">;
|
|
502
|
+
meta: t.IntersectionC<[t.TypeC<{
|
|
503
|
+
command: t.StringC;
|
|
504
|
+
}>, t.PartialC<{
|
|
505
|
+
type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
|
|
506
|
+
}>]>;
|
|
292
507
|
}>, t.TypeC<{
|
|
293
508
|
type: t.LiteralC<"no_action">;
|
|
294
509
|
}>, t.TypeC<{
|
|
295
510
|
type: t.LiteralC<"click">;
|
|
296
511
|
value: t.StringC;
|
|
512
|
+
}>, t.TypeC<{
|
|
513
|
+
type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
|
|
514
|
+
value: t.ArrayC<t.StringC>;
|
|
297
515
|
}>, t.IntersectionC<[t.TypeC<{
|
|
298
516
|
type: t.LiteralC<"link">;
|
|
299
517
|
value: t.StringC;
|
|
@@ -302,16 +520,49 @@ export declare const OrganizationV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
|
|
|
302
520
|
}>]>, t.TypeC<{
|
|
303
521
|
type: t.LiteralC<"open_chat">;
|
|
304
522
|
meta: t.TypeC<{
|
|
305
|
-
type: t.
|
|
523
|
+
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<"">]>;
|
|
306
524
|
}>;
|
|
307
525
|
}>, t.TypeC<{
|
|
308
526
|
type: t.LiteralC<"dismiss">;
|
|
527
|
+
}>, t.TypeC<{
|
|
528
|
+
type: t.LiteralC<"snooze">;
|
|
529
|
+
}>, t.TypeC<{
|
|
530
|
+
type: t.LiteralC<"questlist">;
|
|
531
|
+
value: t.NumberC;
|
|
532
|
+
}>, t.TypeC<{
|
|
533
|
+
type: t.LiteralC<"nudge">;
|
|
534
|
+
value: t.NumberC;
|
|
535
|
+
}>, t.TypeC<{
|
|
536
|
+
type: t.LiteralC<"go_to_step">;
|
|
537
|
+
value: t.NumberC;
|
|
538
|
+
}>, t.TypeC<{
|
|
539
|
+
type: t.LiteralC<"step_back">;
|
|
540
|
+
}>, t.IntersectionC<[t.TypeC<{
|
|
541
|
+
type: t.LiteralC<"open_bar">;
|
|
542
|
+
}>, t.PartialC<{
|
|
543
|
+
value: t.StringC;
|
|
544
|
+
categoryFilter: t.NumberC;
|
|
545
|
+
}>]>, t.TypeC<{
|
|
546
|
+
type: t.LiteralC<"open_helphub">;
|
|
547
|
+
}>, t.TypeC<{
|
|
548
|
+
type: t.LiteralC<"open_copilot">;
|
|
309
549
|
}>]>;
|
|
310
550
|
}>>;
|
|
311
551
|
helphub_manual_suggested_queries: t.ArrayC<t.StringC>;
|
|
552
|
+
copilot_name: t.StringC;
|
|
553
|
+
copilot_avatar: t.StringC;
|
|
554
|
+
copilot_personality: t.UnionC<[t.TypeC<{
|
|
555
|
+
template: t.UnionC<[t.LiteralC<"professional">, t.LiteralC<"friendly">, t.LiteralC<"confident">, t.LiteralC<"serious">, t.LiteralC<"empathetic">]>;
|
|
556
|
+
}>, t.TypeC<{
|
|
557
|
+
template: t.LiteralC<"custom">;
|
|
558
|
+
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">]>>;
|
|
559
|
+
response_length: t.UnionC<[t.LiteralC<"short">, t.LiteralC<"conversational">, t.LiteralC<"long">]>;
|
|
560
|
+
response_format: t.UnionC<[t.LiteralC<"lists">, t.LiteralC<"paragraphs">, t.LiteralC<"mixed">]>;
|
|
561
|
+
}>]>;
|
|
312
562
|
nudge_rate_limit: t.UnionC<[t.NullC, t.NumberC]>;
|
|
313
563
|
bar_hide_completed_nudges_questlists: t.BooleanC;
|
|
314
564
|
nudge_rate_period: t.UnionC<[t.LiteralC<"day">, t.LiteralC<"week">, t.LiteralC<"session">]>;
|
|
565
|
+
share_link_param: t.StringC;
|
|
315
566
|
installed_at: t.UnionC<[t.StringC, t.NullC]>;
|
|
316
567
|
integrations: t.PartialC<{
|
|
317
568
|
algolia: t.TypeC<{
|
|
@@ -323,7 +574,54 @@ export declare const OrganizationV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
|
|
|
323
574
|
segments: t.RecordC<t.StringC, t.StringC>;
|
|
324
575
|
send_events_to_heap: t.BooleanC;
|
|
325
576
|
}>;
|
|
577
|
+
amplitude: t.TypeC<{
|
|
578
|
+
enabled: t.BooleanC;
|
|
579
|
+
}>;
|
|
580
|
+
logrocket: t.TypeC<{
|
|
581
|
+
enabled: t.BooleanC;
|
|
582
|
+
}>;
|
|
583
|
+
mixpanel: t.TypeC<{
|
|
584
|
+
enabled: t.BooleanC;
|
|
585
|
+
}>;
|
|
586
|
+
posthog: t.TypeC<{
|
|
587
|
+
enabled: t.BooleanC;
|
|
588
|
+
}>;
|
|
589
|
+
rudderstack: t.TypeC<{
|
|
590
|
+
enabled: t.BooleanC;
|
|
591
|
+
}>;
|
|
592
|
+
slack: t.TypeC<{
|
|
593
|
+
channelId: t.StringC;
|
|
594
|
+
configuration: t.TypeC<{
|
|
595
|
+
analytic_events: t.ArrayC<t.StringC>;
|
|
596
|
+
}>;
|
|
597
|
+
}>;
|
|
598
|
+
hubspot: t.PartialC<{
|
|
599
|
+
send_events_to_hubspot: t.BooleanC;
|
|
600
|
+
lists: t.RecordC<t.StringC, t.StringC>;
|
|
601
|
+
}>;
|
|
326
602
|
}>;
|
|
327
|
-
|
|
603
|
+
copilot_enabled: t.BooleanC;
|
|
604
|
+
user_property_targeting: t.BooleanC;
|
|
605
|
+
ab_test_conditions: t.BooleanC;
|
|
606
|
+
spotlight_ask_copilot_enabled: t.BooleanC;
|
|
607
|
+
spotlight_ask_copilot_label: t.UnionC<[t.StringC, t.NullC]>;
|
|
608
|
+
/** @deprecated Replaced by the `copilot_enabled` field */
|
|
609
|
+
helphub_ai_enabled: t.BooleanC;
|
|
610
|
+
/** @deprecated Removed entirely */
|
|
611
|
+
copilot_experiences_enabled: t.BooleanC;
|
|
612
|
+
/** @deprecated Replaced by a combination of `copilot_enabled` and `helphub_enabled` */
|
|
613
|
+
helphub_chat_only_mode: t.BooleanC;
|
|
614
|
+
}>, t.TypeC<{
|
|
615
|
+
helphub_launcher_offset_x: t.NumberC;
|
|
616
|
+
helphub_launcher_offset_y: t.NumberC;
|
|
617
|
+
helphub_launcher_anchor: t.StringC;
|
|
618
|
+
helphub_launcher_position: t.UnionC<[t.LiteralC<"topRight">, t.LiteralC<"topLeft">, t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
|
|
619
|
+
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">]>;
|
|
620
|
+
helphub_mobile_launcher_offset_x: t.NumberC;
|
|
621
|
+
helphub_mobile_launcher_offset_y: t.NumberC;
|
|
622
|
+
helphub_mobile_launcher_anchor: t.StringC;
|
|
623
|
+
helphub_mobile_launcher_position: t.UnionC<[t.LiteralC<"topRight">, t.LiteralC<"topLeft">, t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
|
|
624
|
+
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">]>;
|
|
625
|
+
}>]>]>;
|
|
328
626
|
export declare const unknownOrganization: IOrganizationType;
|
|
329
627
|
export {};
|
|
@@ -3,7 +3,7 @@ export declare const SearchFieldConfigV: t.TypeC<{
|
|
|
3
3
|
key: t.StringC;
|
|
4
4
|
label: t.StringC;
|
|
5
5
|
}>;
|
|
6
|
-
export declare const
|
|
6
|
+
export declare const RecordSettingsV: t.PartialC<{
|
|
7
7
|
name: t.StringC;
|
|
8
8
|
search: t.BooleanC;
|
|
9
9
|
label_field: t.StringC;
|
|
@@ -60,7 +60,7 @@ export declare const ResourceSettingsV: t.PartialC<{
|
|
|
60
60
|
}>]>]>>]>;
|
|
61
61
|
show_preview: t.BooleanC;
|
|
62
62
|
}>;
|
|
63
|
-
export declare const
|
|
63
|
+
export declare const RecordSettingsByContextKeyV: t.RecordC<t.StringC, t.PartialC<{
|
|
64
64
|
name: t.StringC;
|
|
65
65
|
search: t.BooleanC;
|
|
66
66
|
label_field: t.StringC;
|