commandbar 1.8.7 → 1.10.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (61) hide show
  1. package/build/{internal/src/client → commandbar/src/shared/services/analytics}/EventHandler.d.ts +51 -15
  2. package/build/commandbar/src/shared/services/analytics/types.d.ts +77 -0
  3. package/build/commandbar-js/src/index.d.ts +2 -2
  4. package/build/commandbar-js/src/index.js +1 -1
  5. package/build/internal/src/client/AddContextOptions.d.ts +8 -0
  6. package/build/internal/src/client/CommandBarClientSDK.d.ts +70 -19
  7. package/build/internal/src/client/CommandBarProxySDK.d.ts +3 -3
  8. package/build/internal/src/client/CommandBarSDK.d.ts +34 -18
  9. package/build/internal/src/client/SDKConfig.d.ts +3 -2
  10. package/build/internal/src/client/globals.d.ts +6 -0
  11. package/build/internal/src/client/symbols.d.ts +13 -6
  12. package/build/internal/src/middleware/CommandFromClientV.d.ts +88 -18
  13. package/build/internal/src/middleware/IRecordSettings.d.ts +3 -0
  14. package/build/internal/src/middleware/OrganizationV.d.ts +320 -22
  15. package/build/internal/src/middleware/{ResourceSettingsV.d.ts → RecordSettingsV.d.ts} +2 -2
  16. package/build/internal/src/middleware/additionalResource.d.ts +270 -27
  17. package/build/internal/src/middleware/billing.d.ts +31 -0
  18. package/build/internal/src/middleware/chat.d.ts +12933 -0
  19. package/build/internal/src/middleware/checklist.d.ts +589 -70
  20. package/build/internal/src/middleware/command.d.ts +5433 -677
  21. package/build/internal/src/middleware/detailPreview.d.ts +12 -1
  22. package/build/internal/src/middleware/endUser.d.ts +132 -0
  23. package/build/internal/src/middleware/entityChanges.d.ts +17 -0
  24. package/build/internal/src/middleware/experienceTemplate.d.ts +59 -0
  25. package/build/internal/src/middleware/experiencesSearch.d.ts +3579 -0
  26. package/build/internal/src/middleware/flags.d.ts +20 -0
  27. package/build/internal/src/middleware/generics.d.ts +12 -11
  28. package/build/internal/src/middleware/helpDocsIntegration.d.ts +63 -8
  29. package/build/internal/src/middleware/helpDocsSearch.d.ts +2540 -0
  30. package/build/internal/src/middleware/helpHub.d.ts +26 -0
  31. package/build/internal/src/middleware/helpers/actions.d.ts +174 -16
  32. package/build/internal/src/middleware/helpers/commandTemplate.d.ts +144 -2
  33. package/build/internal/src/middleware/helpers/copilotPersonality.d.ts +12 -0
  34. package/build/internal/src/middleware/helpers/goals.d.ts +4 -2
  35. package/build/internal/src/middleware/helpers/pushTrigger.d.ts +28 -0
  36. package/build/internal/src/middleware/helpers/rules.d.ts +318 -50
  37. package/build/internal/src/middleware/network.d.ts +27 -3
  38. package/build/internal/src/middleware/nudge.d.ts +2220 -91
  39. package/build/internal/src/middleware/organization.d.ts +2289 -152
  40. package/build/internal/src/middleware/organizationSettings.d.ts +435 -20
  41. package/build/internal/src/middleware/profile.d.ts +2 -0
  42. package/build/internal/src/middleware/recommendationSet.d.ts +489 -1007
  43. package/build/internal/src/middleware/releases.d.ts +1 -1
  44. package/build/internal/src/middleware/theme.d.ts +425 -0
  45. package/build/internal/src/middleware/types.d.ts +88 -34
  46. package/build/internal/src/middleware/user.d.ts +1 -0
  47. package/build/internal/src/util/dispatchCustomEvent.d.ts +5 -3
  48. package/build/internal/src/util/operatingSystem.d.ts +11 -0
  49. package/build/internal/src/util/sentry.d.ts +23 -0
  50. package/package.json +3 -3
  51. package/src/index.ts +2 -2
  52. package/src/init.ts +11 -6
  53. package/src/snippet.ts +2 -2
  54. package/build/internal/src/client/AnalyticsEventTypes.d.ts +0 -1
  55. package/build/internal/src/client/SentryReporter.d.ts +0 -63
  56. package/build/internal/src/middleware/IResourceSettings.d.ts +0 -3
  57. package/build/internal/src/middleware/chatAnalytics.d.ts +0 -2601
  58. package/build/internal/src/middleware/dashboardFlags.d.ts +0 -9
  59. package/build/internal/src/middleware/helpers/endUser.d.ts +0 -11
  60. package/build/internal/src/middleware/qaPair.d.ts +0 -676
  61. package/build/internal/src/util/integrations.d.ts +0 -1
@@ -1,5 +1,5 @@
1
1
  import * as t from 'io-ts';
2
- export declare const RecommendationSetV: t.IntersectionC<[t.TypeC<{}>, t.IntersectionC<[t.TypeC<{
2
+ export declare const RecommendationSetBaseV: t.TypeC<{
3
3
  id: t.NumberC;
4
4
  widget: t.StringC;
5
5
  default: t.BooleanC;
@@ -19,668 +19,63 @@ export declare const RecommendationSetV: t.IntersectionC<[t.TypeC<{}>, t.Interse
19
19
  reason: t.StringC;
20
20
  }>]>;
21
21
  }>]>;
22
- }>, t.PartialC<{}>]>, t.TypeC<{
23
- commands: t.ArrayC<t.Type<{
24
- id: number;
25
- organization: string | number;
26
- text: string;
27
- template: ({
28
- type: "admin";
29
- value: string;
30
- } & {} & {
31
- commandType?: "object" | "help" | "independent" | undefined;
32
- object?: string | undefined;
33
- hoverTooltip?: boolean | undefined;
34
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
35
- }) | ({
36
- type: "callback";
37
- value: string;
38
- } & {} & {
39
- commandType?: "object" | "help" | "independent" | undefined;
40
- object?: string | undefined;
41
- hoverTooltip?: boolean | undefined;
42
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
43
- }) | ({
44
- type: "link";
45
- value: string;
46
- } & {
47
- operation?: "self" | "router" | "blank" | undefined;
48
- } & {} & {
49
- commandType?: "object" | "help" | "independent" | undefined;
50
- object?: string | undefined;
51
- hoverTooltip?: boolean | undefined;
52
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
53
- }) | ({
54
- type: "click" | "clickByXpath" | "clickBySelector";
55
- value: string[];
56
- } & {} & {
57
- commandType?: "object" | "help" | "independent" | undefined;
58
- object?: string | undefined;
59
- hoverTooltip?: boolean | undefined;
60
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
61
- }) | ({
62
- type: "builtin";
63
- value: string;
64
- } & {} & {
65
- commandType?: "object" | "help" | "independent" | undefined;
66
- object?: string | undefined;
67
- hoverTooltip?: boolean | undefined;
68
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
69
- }) | ({
70
- type: "webhook";
71
- value: string;
72
- } & {} & {
73
- commandType?: "object" | "help" | "independent" | undefined;
74
- object?: string | undefined;
75
- hoverTooltip?: boolean | undefined;
76
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
77
- }) | ({
78
- type: "script";
79
- value: string;
80
- } & {} & {
81
- commandType?: "object" | "help" | "independent" | undefined;
82
- object?: string | undefined;
83
- hoverTooltip?: boolean | undefined;
84
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
85
- }) | ({
86
- type: "request";
87
- value: {
88
- method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
89
- url: string;
90
- } & {
91
- headers?: {
92
- [key: string]: unknown;
93
- } | undefined;
94
- body?: {
95
- [key: string]: unknown;
96
- } | undefined;
97
- onSend?: string | undefined;
98
- onSuccess?: string | undefined;
99
- onError?: string | undefined;
100
- };
101
- } & {} & {
102
- commandType?: "object" | "help" | "independent" | undefined;
103
- object?: string | undefined;
104
- hoverTooltip?: boolean | undefined;
105
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
106
- }) | ({
107
- type: "appcues";
108
- value: string;
109
- } & {} & {
110
- commandType?: "object" | "help" | "independent" | undefined;
111
- object?: string | undefined;
112
- hoverTooltip?: boolean | undefined;
113
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
114
- }) | ({
115
- type: "video";
116
- value: string;
117
- } & {} & {
118
- commandType?: "object" | "help" | "independent" | undefined;
119
- object?: string | undefined;
120
- hoverTooltip?: boolean | undefined;
121
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
122
- }) | ({
123
- type: "helpdoc";
124
- value: string;
125
- } & {
126
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
127
- doc_metadata?: {
128
- content_type?: string | undefined;
129
- date?: string | undefined;
130
- } | undefined;
131
- } & {
132
- doc_type?: "answer" | "doc" | undefined;
133
- } & {} & {
134
- commandType?: "object" | "help" | "independent" | undefined;
135
- object?: string | undefined;
136
- hoverTooltip?: boolean | undefined;
137
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
138
- }) | ({
139
- type: "trigger";
140
- value: any;
141
- } & {} & {
142
- commandType?: "object" | "help" | "independent" | undefined;
143
- object?: string | undefined;
144
- hoverTooltip?: boolean | undefined;
145
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
146
- });
147
- } & {
148
- disabledReason?: string | undefined;
149
- source?: string | undefined;
150
- name?: string | undefined;
151
- last_available?: string | null | undefined;
152
- modified?: string | undefined;
153
- isAsync?: boolean | undefined;
154
- } & {
155
- arguments: {
156
- [x: string]: ({
157
- type: "context";
158
- value: string;
159
- order_key: number;
160
- } & {
161
- label?: string | undefined;
162
- chosen?: string | number | undefined;
163
- selected?: any[] | undefined;
164
- input_type?: string | undefined;
165
- preselected_key?: string | undefined;
166
- label_field?: string | undefined;
167
- loaded?: any[] | undefined;
168
- allow_create?: boolean | undefined;
169
- allow_create_label?: string | undefined;
170
- show_in_record_action_list?: boolean | undefined;
171
- show_in_default_list?: boolean | undefined;
172
- auto_choose?: boolean | undefined;
173
- is_private?: boolean | undefined;
174
- }) | ({
175
- type: "set";
176
- value: string[] | number[] | {
177
- [key: string]: unknown;
178
- }[];
179
- order_key: number;
180
- } & {
181
- label?: string | undefined;
182
- chosen?: string | number | undefined;
183
- selected?: any[] | undefined;
184
- input_type?: string | undefined;
185
- preselected_key?: string | undefined;
186
- label_field?: string | undefined;
187
- loaded?: any[] | undefined;
188
- allow_create?: boolean | undefined;
189
- allow_create_label?: string | undefined;
190
- auto_choose?: boolean | undefined;
191
- is_private?: boolean | undefined;
192
- }) | ({
193
- type: "provided";
194
- value: "time" | "text";
195
- order_key: number;
196
- } & {
197
- label?: string | undefined;
198
- chosen?: string | number | undefined;
199
- selected?: any[] | undefined;
200
- input_type?: string | undefined;
201
- preselected_key?: string | undefined;
202
- label_field?: string | undefined;
203
- loaded?: any[] | undefined;
204
- dateTimeArgumentTypeId?: number | undefined;
205
- allow_create?: boolean | undefined;
206
- allow_create_label?: string | undefined;
207
- auto_choose?: boolean | undefined;
208
- is_private?: boolean | undefined;
209
- }) | ({
210
- type: "html" | "video";
211
- value: {
212
- source: string;
213
- } & {
214
- title?: string | undefined;
215
- description?: string | undefined;
216
- url?: string | undefined;
217
- };
218
- order_key: number;
219
- } & {
220
- label?: string | undefined;
221
- chosen?: string | number | undefined;
222
- selected?: any[] | undefined;
223
- input_type?: string | undefined;
224
- preselected_key?: string | undefined;
225
- label_field?: string | undefined;
226
- loaded?: any[] | undefined;
227
- allow_create?: boolean | undefined;
228
- allow_create_label?: string | undefined;
229
- is_private?: boolean | undefined;
230
- auto_choose?: boolean | undefined;
231
- });
232
- };
233
- tags: string[];
234
- availability_rules: ({
235
- type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
236
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
237
- } & {
238
- field?: string | undefined;
239
- value?: string | undefined;
240
- reason?: string | undefined;
241
- rule_id?: string | number | undefined;
242
- })[];
243
- recommend_rules: (({
244
- type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
245
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
246
- } & {
247
- field?: string | undefined;
248
- value?: string | undefined;
249
- reason?: string | undefined;
250
- rule_id?: string | number | undefined;
251
- }) | ({
252
- type: "always";
253
- } & {
254
- operator?: null | undefined;
255
- field?: null | undefined;
256
- value?: null | undefined;
257
- reason?: null | undefined;
258
- rule_id?: string | number | undefined;
259
- }))[];
260
- availability_expression: import("./helpers/rules").RuleExpression | null;
261
- recommend_expression: import("./helpers/rules").RuleExpression | null;
262
- always_recommend: boolean;
263
- confirm: string;
264
- shortcut: string[];
265
- explanation: string;
266
- heading: string;
267
- is_live: boolean;
268
- category: number | null;
269
- sort_key: number | null;
270
- icon: string | null;
271
- icon_color: string | null;
272
- image_color: string | null;
273
- image: string | null;
274
- celebrate: boolean | {
275
- angle?: number | undefined;
276
- spread?: number | undefined;
277
- width?: string | undefined;
278
- height?: string | undefined;
279
- duration?: number | undefined;
280
- dragFriction?: number | undefined;
281
- stagger?: number | undefined;
282
- startVelocity?: number | undefined;
283
- elementCount?: number | undefined;
284
- decay?: number | undefined;
285
- colors?: string[] | undefined;
286
- random?: any;
287
- } | null;
288
- recommend_sort_key: number | null;
289
- shortcut_mac: string[];
290
- shortcut_win: string[];
291
- hotkey_mac: string;
292
- hotkey_win: string;
293
- detail: string | ({
294
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
295
- value: string;
296
- } & {
297
- position?: "inline" | "popover" | undefined;
298
- }) | (string | ({
299
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
300
- value: string;
301
- } & {
302
- position?: "inline" | "popover" | undefined;
303
- }))[] | null;
304
- content: string | ({
305
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
306
- value: string;
307
- } & {
308
- position?: "inline" | "popover" | undefined;
309
- }) | (string | ({
310
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
311
- value: string;
312
- } & {
313
- position?: "inline" | "popover" | undefined;
314
- }))[] | null;
315
- show_preview: boolean;
316
- next_steps: (string | number | {
317
- cta: string;
318
- action: {
319
- type: "execute_command";
320
- meta: {
321
- command: string;
322
- };
323
- } | {
324
- type: "no_action";
325
- } | {
326
- type: "click";
327
- value: string;
328
- } | ({
329
- type: "link";
330
- value: string;
331
- } & {
332
- operation?: "self" | "router" | "blank" | undefined;
333
- }) | {
334
- type: "open_chat";
335
- meta: {
336
- type: string;
337
- };
338
- } | {
339
- type: "dismiss";
340
- };
341
- })[];
342
- extra: string | null;
343
- thumbnail: {
344
- src: string;
345
- file_name: string;
346
- size: string;
347
- } | null;
348
- } & {
349
- third_party_source?: string | null | undefined;
350
- third_party_id?: string | null | undefined;
351
- training_only?: boolean | undefined;
352
- }, {
353
- id: number;
354
- organization: string | number;
355
- text: string;
356
- template: ({
357
- type: "admin";
358
- value: string;
359
- } & {} & {
360
- commandType?: "object" | "help" | "independent" | undefined;
361
- object?: string | undefined;
362
- hoverTooltip?: boolean | undefined;
363
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
364
- }) | ({
365
- type: "callback";
366
- value: string;
367
- } & {} & {
368
- commandType?: "object" | "help" | "independent" | undefined;
369
- object?: string | undefined;
370
- hoverTooltip?: boolean | undefined;
371
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
372
- }) | ({
373
- type: "link";
374
- value: string;
375
- } & {
376
- operation?: "self" | "router" | "blank" | undefined;
377
- } & {} & {
378
- commandType?: "object" | "help" | "independent" | undefined;
379
- object?: string | undefined;
380
- hoverTooltip?: boolean | undefined;
381
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
382
- }) | ({
383
- type: "click" | "clickByXpath" | "clickBySelector";
384
- value: string[];
385
- } & {} & {
386
- commandType?: "object" | "help" | "independent" | undefined;
387
- object?: string | undefined;
388
- hoverTooltip?: boolean | undefined;
389
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
390
- }) | ({
391
- type: "builtin";
392
- value: string;
393
- } & {} & {
394
- commandType?: "object" | "help" | "independent" | undefined;
395
- object?: string | undefined;
396
- hoverTooltip?: boolean | undefined;
397
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
398
- }) | ({
399
- type: "webhook";
400
- value: string;
401
- } & {} & {
402
- commandType?: "object" | "help" | "independent" | undefined;
403
- object?: string | undefined;
404
- hoverTooltip?: boolean | undefined;
405
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
406
- }) | ({
407
- type: "script";
408
- value: string;
409
- } & {} & {
410
- commandType?: "object" | "help" | "independent" | undefined;
411
- object?: string | undefined;
412
- hoverTooltip?: boolean | undefined;
413
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
414
- }) | ({
415
- type: "request";
416
- value: {
417
- method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
418
- url: string;
419
- } & {
420
- headers?: {
421
- [key: string]: unknown;
422
- } | undefined;
423
- body?: {
424
- [key: string]: unknown;
425
- } | undefined;
426
- onSend?: string | undefined;
427
- onSuccess?: string | undefined;
428
- onError?: string | undefined;
429
- };
430
- } & {} & {
431
- commandType?: "object" | "help" | "independent" | undefined;
432
- object?: string | undefined;
433
- hoverTooltip?: boolean | undefined;
434
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
435
- }) | ({
436
- type: "appcues";
437
- value: string;
438
- } & {} & {
439
- commandType?: "object" | "help" | "independent" | undefined;
440
- object?: string | undefined;
441
- hoverTooltip?: boolean | undefined;
442
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
443
- }) | ({
444
- type: "video";
445
- value: string;
446
- } & {} & {
447
- commandType?: "object" | "help" | "independent" | undefined;
448
- object?: string | undefined;
449
- hoverTooltip?: boolean | undefined;
450
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
451
- }) | ({
452
- type: "helpdoc";
453
- value: string;
454
- } & {
455
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
456
- doc_metadata?: {
457
- content_type?: string | undefined;
458
- date?: string | undefined;
459
- } | undefined;
460
- } & {
461
- doc_type?: "answer" | "doc" | undefined;
462
- } & {} & {
463
- commandType?: "object" | "help" | "independent" | undefined;
464
- object?: string | undefined;
465
- hoverTooltip?: boolean | undefined;
466
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
467
- }) | ({
468
- type: "trigger";
469
- value: any;
470
- } & {} & {
471
- commandType?: "object" | "help" | "independent" | undefined;
472
- object?: string | undefined;
473
- hoverTooltip?: boolean | undefined;
474
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
475
- });
476
- } & {
477
- disabledReason?: string | undefined;
478
- source?: string | undefined;
479
- name?: string | undefined;
480
- last_available?: string | null | undefined;
481
- modified?: string | undefined;
482
- isAsync?: boolean | undefined;
483
- } & {
484
- arguments: {
485
- [x: string]: ({
486
- type: "context";
487
- value: string;
488
- order_key: number;
489
- } & {
490
- label?: string | undefined;
491
- chosen?: string | number | undefined;
492
- selected?: any[] | undefined;
493
- input_type?: string | undefined;
494
- preselected_key?: string | undefined;
495
- label_field?: string | undefined;
496
- loaded?: any[] | undefined;
497
- allow_create?: boolean | undefined;
498
- allow_create_label?: string | undefined;
499
- show_in_record_action_list?: boolean | undefined;
500
- show_in_default_list?: boolean | undefined;
501
- auto_choose?: boolean | undefined;
502
- is_private?: boolean | undefined;
503
- }) | ({
504
- type: "set";
505
- value: string[] | number[] | {
506
- [key: string]: unknown;
507
- }[];
508
- order_key: number;
509
- } & {
510
- label?: string | undefined;
511
- chosen?: string | number | undefined;
512
- selected?: any[] | undefined;
513
- input_type?: string | undefined;
514
- preselected_key?: string | undefined;
515
- label_field?: string | undefined;
516
- loaded?: any[] | undefined;
517
- allow_create?: boolean | undefined;
518
- allow_create_label?: string | undefined;
519
- auto_choose?: boolean | undefined;
520
- is_private?: boolean | undefined;
521
- }) | ({
522
- type: "provided";
523
- value: "time" | "text";
524
- order_key: number;
525
- } & {
526
- label?: string | undefined;
527
- chosen?: string | number | undefined;
528
- selected?: any[] | undefined;
529
- input_type?: string | undefined;
530
- preselected_key?: string | undefined;
531
- label_field?: string | undefined;
532
- loaded?: any[] | undefined;
533
- dateTimeArgumentTypeId?: number | undefined;
534
- allow_create?: boolean | undefined;
535
- allow_create_label?: string | undefined;
536
- auto_choose?: boolean | undefined;
537
- is_private?: boolean | undefined;
538
- }) | ({
539
- type: "html" | "video";
540
- value: {
541
- source: string;
542
- } & {
543
- title?: string | undefined;
544
- description?: string | undefined;
545
- url?: string | undefined;
546
- };
547
- order_key: number;
548
- } & {
549
- label?: string | undefined;
550
- chosen?: string | number | undefined;
551
- selected?: any[] | undefined;
552
- input_type?: string | undefined;
553
- preselected_key?: string | undefined;
554
- label_field?: string | undefined;
555
- loaded?: any[] | undefined;
556
- allow_create?: boolean | undefined;
557
- allow_create_label?: string | undefined;
558
- is_private?: boolean | undefined;
559
- auto_choose?: boolean | undefined;
560
- });
561
- };
562
- tags: string[];
563
- availability_rules: ({
564
- type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
565
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
566
- } & {
567
- field?: string | undefined;
568
- value?: string | undefined;
569
- reason?: string | undefined;
570
- rule_id?: string | number | undefined;
571
- })[];
572
- recommend_rules: (({
573
- type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
574
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
575
- } & {
576
- field?: string | undefined;
577
- value?: string | undefined;
578
- reason?: string | undefined;
579
- rule_id?: string | number | undefined;
580
- }) | ({
581
- type: "always";
582
- } & {
583
- operator?: null | undefined;
584
- field?: null | undefined;
585
- value?: null | undefined;
586
- reason?: null | undefined;
587
- rule_id?: string | number | undefined;
588
- }))[];
589
- availability_expression: import("./helpers/rules").RuleExpression | null;
590
- recommend_expression: import("./helpers/rules").RuleExpression | null;
591
- always_recommend: boolean;
592
- confirm: string;
593
- shortcut: string[];
594
- explanation: string;
595
- heading: string;
596
- is_live: boolean;
597
- category: number | null;
598
- sort_key: number | null;
599
- icon: string | null;
600
- icon_color: string | null;
601
- image_color: string | null;
602
- image: string | null;
603
- celebrate: boolean | {
604
- angle?: number | undefined;
605
- spread?: number | undefined;
606
- width?: string | undefined;
607
- height?: string | undefined;
608
- duration?: number | undefined;
609
- dragFriction?: number | undefined;
610
- stagger?: number | undefined;
611
- startVelocity?: number | undefined;
612
- elementCount?: number | undefined;
613
- decay?: number | undefined;
614
- colors?: string[] | undefined;
615
- random?: any;
616
- } | null;
617
- recommend_sort_key: number | null;
618
- shortcut_mac: string[];
619
- shortcut_win: string[];
620
- hotkey_mac: string;
621
- hotkey_win: string;
622
- detail: string | ({
623
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
624
- value: string;
625
- } & {
626
- position?: "inline" | "popover" | undefined;
627
- }) | (string | ({
628
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
629
- value: string;
630
- } & {
631
- position?: "inline" | "popover" | undefined;
632
- }))[] | null;
633
- content: string | ({
634
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
635
- value: string;
636
- } & {
637
- position?: "inline" | "popover" | undefined;
638
- }) | (string | ({
639
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
640
- value: string;
641
- } & {
642
- position?: "inline" | "popover" | undefined;
643
- }))[] | null;
644
- show_preview: boolean;
645
- next_steps: (string | number | {
646
- cta: string;
647
- action: {
648
- type: "execute_command";
649
- meta: {
650
- command: string;
651
- };
652
- } | {
653
- type: "no_action";
654
- } | {
655
- type: "click";
656
- value: string;
657
- } | ({
658
- type: "link";
659
- value: string;
660
- } & {
661
- operation?: "self" | "router" | "blank" | undefined;
662
- }) | {
663
- type: "open_chat";
664
- meta: {
665
- type: string;
666
- };
667
- } | {
668
- type: "dismiss";
669
- };
670
- })[];
671
- extra: string | null;
672
- thumbnail: {
673
- src: string;
674
- file_name: string;
675
- size: string;
676
- } | null;
677
- } & {
678
- third_party_source?: string | null | undefined;
679
- third_party_id?: string | null | undefined;
680
- training_only?: boolean | undefined;
681
- }, any>>;
682
- }>]>;
683
- export declare const EditorRecommendationSetV: t.IntersectionC<[t.TypeC<{}>, t.IntersectionC<[t.TypeC<{
22
+ }>;
23
+ export declare const RecommendationSetAdditionalV: t.TypeC<{
24
+ actions: t.ArrayC<t.TypeC<{
25
+ action: t.UnionC<[t.TypeC<{
26
+ type: t.LiteralC<"execute_command">;
27
+ meta: t.IntersectionC<[t.TypeC<{
28
+ command: t.StringC;
29
+ }>, t.PartialC<{
30
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
31
+ }>]>;
32
+ }>, t.TypeC<{
33
+ type: t.LiteralC<"no_action">;
34
+ }>, t.TypeC<{
35
+ type: t.LiteralC<"click">;
36
+ value: t.StringC;
37
+ }>, t.TypeC<{
38
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
39
+ value: t.ArrayC<t.StringC>;
40
+ }>, t.IntersectionC<[t.TypeC<{
41
+ type: t.LiteralC<"link">;
42
+ value: t.StringC;
43
+ }>, t.PartialC<{
44
+ operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
45
+ }>]>, t.TypeC<{
46
+ type: t.LiteralC<"open_chat">;
47
+ meta: t.TypeC<{
48
+ 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<"">]>;
49
+ }>;
50
+ }>, t.TypeC<{
51
+ type: t.LiteralC<"dismiss">;
52
+ }>, t.TypeC<{
53
+ type: t.LiteralC<"snooze">;
54
+ }>, t.TypeC<{
55
+ type: t.LiteralC<"questlist">;
56
+ value: t.NumberC;
57
+ }>, t.TypeC<{
58
+ type: t.LiteralC<"nudge">;
59
+ value: t.NumberC;
60
+ }>, t.TypeC<{
61
+ type: t.LiteralC<"go_to_step">;
62
+ value: t.NumberC;
63
+ }>, t.TypeC<{
64
+ type: t.LiteralC<"step_back">;
65
+ }>, t.IntersectionC<[t.TypeC<{
66
+ type: t.LiteralC<"open_bar">;
67
+ }>, t.PartialC<{
68
+ value: t.StringC;
69
+ categoryFilter: t.NumberC;
70
+ }>]>, t.TypeC<{
71
+ type: t.LiteralC<"open_helphub">;
72
+ }>, t.TypeC<{
73
+ type: t.LiteralC<"open_copilot">;
74
+ }>]>;
75
+ cta: t.StringC;
76
+ }>>;
77
+ }>;
78
+ export declare const RecommendationSetV: t.IntersectionC<[t.TypeC<{
684
79
  id: t.NumberC;
685
80
  widget: t.StringC;
686
81
  default: t.BooleanC;
@@ -700,11 +95,63 @@ export declare const EditorRecommendationSetV: t.IntersectionC<[t.TypeC<{}>, t.I
700
95
  reason: t.StringC;
701
96
  }>]>;
702
97
  }>]>;
703
- }>, t.PartialC<{}>]>, t.TypeC<{
704
- command_ids: t.ArrayC<t.NumberC>;
98
+ }>, t.TypeC<{
99
+ actions: t.ArrayC<t.TypeC<{
100
+ action: t.UnionC<[t.TypeC<{
101
+ type: t.LiteralC<"execute_command">;
102
+ meta: t.IntersectionC<[t.TypeC<{
103
+ command: t.StringC;
104
+ }>, t.PartialC<{
105
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
106
+ }>]>;
107
+ }>, t.TypeC<{
108
+ type: t.LiteralC<"no_action">;
109
+ }>, t.TypeC<{
110
+ type: t.LiteralC<"click">;
111
+ value: t.StringC;
112
+ }>, t.TypeC<{
113
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
114
+ value: t.ArrayC<t.StringC>;
115
+ }>, t.IntersectionC<[t.TypeC<{
116
+ type: t.LiteralC<"link">;
117
+ value: t.StringC;
118
+ }>, t.PartialC<{
119
+ operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
120
+ }>]>, t.TypeC<{
121
+ type: t.LiteralC<"open_chat">;
122
+ meta: t.TypeC<{
123
+ 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<"">]>;
124
+ }>;
125
+ }>, t.TypeC<{
126
+ type: t.LiteralC<"dismiss">;
127
+ }>, t.TypeC<{
128
+ type: t.LiteralC<"snooze">;
129
+ }>, t.TypeC<{
130
+ type: t.LiteralC<"questlist">;
131
+ value: t.NumberC;
132
+ }>, t.TypeC<{
133
+ type: t.LiteralC<"nudge">;
134
+ value: t.NumberC;
135
+ }>, t.TypeC<{
136
+ type: t.LiteralC<"go_to_step">;
137
+ value: t.NumberC;
138
+ }>, t.TypeC<{
139
+ type: t.LiteralC<"step_back">;
140
+ }>, t.IntersectionC<[t.TypeC<{
141
+ type: t.LiteralC<"open_bar">;
142
+ }>, t.PartialC<{
143
+ value: t.StringC;
144
+ categoryFilter: t.NumberC;
145
+ }>]>, t.TypeC<{
146
+ type: t.LiteralC<"open_helphub">;
147
+ }>, t.TypeC<{
148
+ type: t.LiteralC<"open_copilot">;
149
+ }>]>;
150
+ cta: t.StringC;
151
+ }>>;
705
152
  }>]>;
706
153
  export declare class RecommendationSet {
707
- static decode: (data: any) => {} & {
154
+ static decode: (data: any) => {
708
155
  id: number;
709
156
  widget: string;
710
157
  default: boolean;
@@ -724,339 +171,62 @@ export declare class RecommendationSet {
724
171
  reason?: string | undefined;
725
172
  };
726
173
  };
727
- } & {} & {
728
- commands: ({
729
- id: number;
730
- organization: string | number;
731
- text: string;
732
- template: ({
733
- type: "admin";
734
- value: string;
735
- } & {} & {
736
- commandType?: "object" | "help" | "independent" | undefined;
737
- object?: string | undefined;
738
- hoverTooltip?: boolean | undefined;
739
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
740
- }) | ({
741
- type: "callback";
174
+ } & {
175
+ actions: {
176
+ action: {
177
+ type: "execute_command";
178
+ meta: {
179
+ command: string;
180
+ } & {
181
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
182
+ };
183
+ } | {
184
+ type: "click";
742
185
  value: string;
743
- } & {} & {
744
- commandType?: "object" | "help" | "independent" | undefined;
745
- object?: string | undefined;
746
- hoverTooltip?: boolean | undefined;
747
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
748
- }) | ({
186
+ } | {
187
+ type: "click" | "clickBySelector" | "clickByXpath";
188
+ value: string[];
189
+ } | ({
749
190
  type: "link";
750
191
  value: string;
751
192
  } & {
752
193
  operation?: "self" | "router" | "blank" | undefined;
753
- } & {} & {
754
- commandType?: "object" | "help" | "independent" | undefined;
755
- object?: string | undefined;
756
- hoverTooltip?: boolean | undefined;
757
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
758
- }) | ({
759
- type: "click" | "clickByXpath" | "clickBySelector";
760
- value: string[];
761
- } & {} & {
762
- commandType?: "object" | "help" | "independent" | undefined;
763
- object?: string | undefined;
764
- hoverTooltip?: boolean | undefined;
765
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
766
- }) | ({
767
- type: "builtin";
768
- value: string;
769
- } & {} & {
770
- commandType?: "object" | "help" | "independent" | undefined;
771
- object?: string | undefined;
772
- hoverTooltip?: boolean | undefined;
773
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
774
- }) | ({
775
- type: "webhook";
776
- value: string;
777
- } & {} & {
778
- commandType?: "object" | "help" | "independent" | undefined;
779
- object?: string | undefined;
780
- hoverTooltip?: boolean | undefined;
781
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
782
- }) | ({
783
- type: "script";
784
- value: string;
785
- } & {} & {
786
- commandType?: "object" | "help" | "independent" | undefined;
787
- object?: string | undefined;
788
- hoverTooltip?: boolean | undefined;
789
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
790
- }) | ({
791
- type: "request";
792
- value: {
793
- method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
794
- url: string;
795
- } & {
796
- headers?: {
797
- [key: string]: unknown;
798
- } | undefined;
799
- body?: {
800
- [key: string]: unknown;
801
- } | undefined;
802
- onSend?: string | undefined;
803
- onSuccess?: string | undefined;
804
- onError?: string | undefined;
194
+ }) | {
195
+ type: "open_chat";
196
+ meta: {
197
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
805
198
  };
806
- } & {} & {
807
- commandType?: "object" | "help" | "independent" | undefined;
808
- object?: string | undefined;
809
- hoverTooltip?: boolean | undefined;
810
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
811
- }) | ({
812
- type: "appcues";
813
- value: string;
814
- } & {} & {
815
- commandType?: "object" | "help" | "independent" | undefined;
816
- object?: string | undefined;
817
- hoverTooltip?: boolean | undefined;
818
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
819
- }) | ({
820
- type: "video";
821
- value: string;
822
- } & {} & {
823
- commandType?: "object" | "help" | "independent" | undefined;
824
- object?: string | undefined;
825
- hoverTooltip?: boolean | undefined;
826
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
827
- }) | ({
828
- type: "helpdoc";
829
- value: string;
830
- } & {
831
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
832
- doc_metadata?: {
833
- content_type?: string | undefined;
834
- date?: string | undefined;
835
- } | undefined;
836
- } & {
837
- doc_type?: "answer" | "doc" | undefined;
838
- } & {} & {
839
- commandType?: "object" | "help" | "independent" | undefined;
840
- object?: string | undefined;
841
- hoverTooltip?: boolean | undefined;
842
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
843
- }) | ({
844
- type: "trigger";
845
- value: any;
846
- } & {} & {
847
- commandType?: "object" | "help" | "independent" | undefined;
848
- object?: string | undefined;
849
- hoverTooltip?: boolean | undefined;
850
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
851
- });
852
- } & {
853
- disabledReason?: string | undefined;
854
- source?: string | undefined;
855
- name?: string | undefined;
856
- last_available?: string | null | undefined;
857
- modified?: string | undefined;
858
- isAsync?: boolean | undefined;
859
- } & {
860
- arguments: {
861
- [x: string]: ({
862
- type: "context";
863
- value: string;
864
- order_key: number;
865
- } & {
866
- label?: string | undefined;
867
- chosen?: string | number | undefined;
868
- selected?: any[] | undefined;
869
- input_type?: string | undefined;
870
- preselected_key?: string | undefined;
871
- label_field?: string | undefined;
872
- loaded?: any[] | undefined;
873
- allow_create?: boolean | undefined;
874
- allow_create_label?: string | undefined;
875
- show_in_record_action_list?: boolean | undefined;
876
- show_in_default_list?: boolean | undefined;
877
- auto_choose?: boolean | undefined;
878
- is_private?: boolean | undefined;
879
- }) | ({
880
- type: "set";
881
- value: string[] | number[] | {
882
- [key: string]: unknown;
883
- }[];
884
- order_key: number;
885
- } & {
886
- label?: string | undefined;
887
- chosen?: string | number | undefined;
888
- selected?: any[] | undefined;
889
- input_type?: string | undefined;
890
- preselected_key?: string | undefined;
891
- label_field?: string | undefined;
892
- loaded?: any[] | undefined;
893
- allow_create?: boolean | undefined;
894
- allow_create_label?: string | undefined;
895
- auto_choose?: boolean | undefined;
896
- is_private?: boolean | undefined;
897
- }) | ({
898
- type: "provided";
899
- value: "time" | "text";
900
- order_key: number;
901
- } & {
902
- label?: string | undefined;
903
- chosen?: string | number | undefined;
904
- selected?: any[] | undefined;
905
- input_type?: string | undefined;
906
- preselected_key?: string | undefined;
907
- label_field?: string | undefined;
908
- loaded?: any[] | undefined;
909
- dateTimeArgumentTypeId?: number | undefined;
910
- allow_create?: boolean | undefined;
911
- allow_create_label?: string | undefined;
912
- auto_choose?: boolean | undefined;
913
- is_private?: boolean | undefined;
914
- }) | ({
915
- type: "html" | "video";
916
- value: {
917
- source: string;
918
- } & {
919
- title?: string | undefined;
920
- description?: string | undefined;
921
- url?: string | undefined;
922
- };
923
- order_key: number;
924
- } & {
925
- label?: string | undefined;
926
- chosen?: string | number | undefined;
927
- selected?: any[] | undefined;
928
- input_type?: string | undefined;
929
- preselected_key?: string | undefined;
930
- label_field?: string | undefined;
931
- loaded?: any[] | undefined;
932
- allow_create?: boolean | undefined;
933
- allow_create_label?: string | undefined;
934
- is_private?: boolean | undefined;
935
- auto_choose?: boolean | undefined;
936
- });
937
- };
938
- tags: string[];
939
- availability_rules: ({
940
- type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
941
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
942
- } & {
943
- field?: string | undefined;
944
- value?: string | undefined;
945
- reason?: string | undefined;
946
- rule_id?: string | number | undefined;
947
- })[];
948
- recommend_rules: (({
949
- type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
950
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
199
+ } | {
200
+ type: "dismiss";
201
+ } | {
202
+ type: "snooze";
203
+ } | {
204
+ type: "questlist";
205
+ value: number;
206
+ } | {
207
+ type: "step_back";
208
+ } | {
209
+ type: "nudge";
210
+ value: number;
211
+ } | {
212
+ type: "go_to_step";
213
+ value: number;
214
+ } | ({
215
+ type: "open_bar";
951
216
  } & {
952
- field?: string | undefined;
953
217
  value?: string | undefined;
954
- reason?: string | undefined;
955
- rule_id?: string | number | undefined;
956
- }) | ({
957
- type: "always";
958
- } & {
959
- operator?: null | undefined;
960
- field?: null | undefined;
961
- value?: null | undefined;
962
- reason?: null | undefined;
963
- rule_id?: string | number | undefined;
964
- }))[];
965
- availability_expression: import("./helpers/rules").RuleExpression | null;
966
- recommend_expression: import("./helpers/rules").RuleExpression | null;
967
- always_recommend: boolean;
968
- confirm: string;
969
- shortcut: string[];
970
- explanation: string;
971
- heading: string;
972
- is_live: boolean;
973
- category: number | null;
974
- sort_key: number | null;
975
- icon: string | null;
976
- icon_color: string | null;
977
- image_color: string | null;
978
- image: string | null;
979
- celebrate: boolean | {
980
- angle?: number | undefined;
981
- spread?: number | undefined;
982
- width?: string | undefined;
983
- height?: string | undefined;
984
- duration?: number | undefined;
985
- dragFriction?: number | undefined;
986
- stagger?: number | undefined;
987
- startVelocity?: number | undefined;
988
- elementCount?: number | undefined;
989
- decay?: number | undefined;
990
- colors?: string[] | undefined;
991
- random?: any;
992
- } | null;
993
- recommend_sort_key: number | null;
994
- shortcut_mac: string[];
995
- shortcut_win: string[];
996
- hotkey_mac: string;
997
- hotkey_win: string;
998
- detail: string | ({
999
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1000
- value: string;
1001
- } & {
1002
- position?: "inline" | "popover" | undefined;
1003
- }) | (string | ({
1004
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1005
- value: string;
1006
- } & {
1007
- position?: "inline" | "popover" | undefined;
1008
- }))[] | null;
1009
- content: string | ({
1010
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1011
- value: string;
1012
- } & {
1013
- position?: "inline" | "popover" | undefined;
1014
- }) | (string | ({
1015
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1016
- value: string;
1017
- } & {
1018
- position?: "inline" | "popover" | undefined;
1019
- }))[] | null;
1020
- show_preview: boolean;
1021
- next_steps: (string | number | {
1022
- cta: string;
1023
- action: {
1024
- type: "execute_command";
1025
- meta: {
1026
- command: string;
1027
- };
1028
- } | {
1029
- type: "no_action";
1030
- } | {
1031
- type: "click";
1032
- value: string;
1033
- } | ({
1034
- type: "link";
1035
- value: string;
1036
- } & {
1037
- operation?: "self" | "router" | "blank" | undefined;
1038
- }) | {
1039
- type: "open_chat";
1040
- meta: {
1041
- type: string;
1042
- };
1043
- } | {
1044
- type: "dismiss";
1045
- };
1046
- })[];
1047
- extra: string | null;
1048
- thumbnail: {
1049
- src: string;
1050
- file_name: string;
1051
- size: string;
1052
- } | null;
1053
- } & {
1054
- third_party_source?: string | null | undefined;
1055
- third_party_id?: string | null | undefined;
1056
- training_only?: boolean | undefined;
1057
- })[];
218
+ categoryFilter?: number | undefined;
219
+ }) | {
220
+ type: "open_helphub";
221
+ } | {
222
+ type: "open_copilot";
223
+ } | {
224
+ type: "no_action";
225
+ };
226
+ cta: string;
227
+ }[];
1058
228
  };
1059
- static create: (object: {} & {
229
+ static create: (object: {
1060
230
  id: number;
1061
231
  widget: string;
1062
232
  default: boolean;
@@ -1076,9 +246,61 @@ export declare class RecommendationSet {
1076
246
  reason?: string | undefined;
1077
247
  };
1078
248
  };
1079
- } & {} & {
1080
- command_ids: number[];
1081
- }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{} & {
249
+ } & {
250
+ actions: {
251
+ action: {
252
+ type: "execute_command";
253
+ meta: {
254
+ command: string;
255
+ } & {
256
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
257
+ };
258
+ } | {
259
+ type: "click";
260
+ value: string;
261
+ } | {
262
+ type: "click" | "clickBySelector" | "clickByXpath";
263
+ value: string[];
264
+ } | ({
265
+ type: "link";
266
+ value: string;
267
+ } & {
268
+ operation?: "self" | "router" | "blank" | undefined;
269
+ }) | {
270
+ type: "open_chat";
271
+ meta: {
272
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
273
+ };
274
+ } | {
275
+ type: "dismiss";
276
+ } | {
277
+ type: "snooze";
278
+ } | {
279
+ type: "questlist";
280
+ value: number;
281
+ } | {
282
+ type: "step_back";
283
+ } | {
284
+ type: "nudge";
285
+ value: number;
286
+ } | {
287
+ type: "go_to_step";
288
+ value: number;
289
+ } | ({
290
+ type: "open_bar";
291
+ } & {
292
+ value?: string | undefined;
293
+ categoryFilter?: number | undefined;
294
+ }) | {
295
+ type: "open_helphub";
296
+ } | {
297
+ type: "open_copilot";
298
+ } | {
299
+ type: "no_action";
300
+ };
301
+ cta: string;
302
+ }[];
303
+ }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
1082
304
  id: number;
1083
305
  widget: string;
1084
306
  default: boolean;
@@ -1098,10 +320,62 @@ export declare class RecommendationSet {
1098
320
  reason?: string | undefined;
1099
321
  };
1100
322
  };
1101
- } & {} & {
1102
- command_ids: number[];
323
+ } & {
324
+ actions: {
325
+ action: {
326
+ type: "execute_command";
327
+ meta: {
328
+ command: string;
329
+ } & {
330
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
331
+ };
332
+ } | {
333
+ type: "click";
334
+ value: string;
335
+ } | {
336
+ type: "click" | "clickBySelector" | "clickByXpath";
337
+ value: string[];
338
+ } | ({
339
+ type: "link";
340
+ value: string;
341
+ } & {
342
+ operation?: "self" | "router" | "blank" | undefined;
343
+ }) | {
344
+ type: "open_chat";
345
+ meta: {
346
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
347
+ };
348
+ } | {
349
+ type: "dismiss";
350
+ } | {
351
+ type: "snooze";
352
+ } | {
353
+ type: "questlist";
354
+ value: number;
355
+ } | {
356
+ type: "step_back";
357
+ } | {
358
+ type: "nudge";
359
+ value: number;
360
+ } | {
361
+ type: "go_to_step";
362
+ value: number;
363
+ } | ({
364
+ type: "open_bar";
365
+ } & {
366
+ value?: string | undefined;
367
+ categoryFilter?: number | undefined;
368
+ }) | {
369
+ type: "open_helphub";
370
+ } | {
371
+ type: "open_copilot";
372
+ } | {
373
+ type: "no_action";
374
+ };
375
+ cta: string;
376
+ }[];
1103
377
  }>;
1104
- static update: (object: {} & {
378
+ static update: (object: {
1105
379
  id: number;
1106
380
  widget: string;
1107
381
  default: boolean;
@@ -1121,9 +395,61 @@ export declare class RecommendationSet {
1121
395
  reason?: string | undefined;
1122
396
  };
1123
397
  };
1124
- } & {} & {
1125
- command_ids: number[];
1126
- }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{} & {
398
+ } & {
399
+ actions: {
400
+ action: {
401
+ type: "execute_command";
402
+ meta: {
403
+ command: string;
404
+ } & {
405
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
406
+ };
407
+ } | {
408
+ type: "click";
409
+ value: string;
410
+ } | {
411
+ type: "click" | "clickBySelector" | "clickByXpath";
412
+ value: string[];
413
+ } | ({
414
+ type: "link";
415
+ value: string;
416
+ } & {
417
+ operation?: "self" | "router" | "blank" | undefined;
418
+ }) | {
419
+ type: "open_chat";
420
+ meta: {
421
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
422
+ };
423
+ } | {
424
+ type: "dismiss";
425
+ } | {
426
+ type: "snooze";
427
+ } | {
428
+ type: "questlist";
429
+ value: number;
430
+ } | {
431
+ type: "step_back";
432
+ } | {
433
+ type: "nudge";
434
+ value: number;
435
+ } | {
436
+ type: "go_to_step";
437
+ value: number;
438
+ } | ({
439
+ type: "open_bar";
440
+ } & {
441
+ value?: string | undefined;
442
+ categoryFilter?: number | undefined;
443
+ }) | {
444
+ type: "open_helphub";
445
+ } | {
446
+ type: "open_copilot";
447
+ } | {
448
+ type: "no_action";
449
+ };
450
+ cta: string;
451
+ }[];
452
+ }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
1127
453
  id: number;
1128
454
  widget: string;
1129
455
  default: boolean;
@@ -1143,11 +469,63 @@ export declare class RecommendationSet {
1143
469
  reason?: string | undefined;
1144
470
  };
1145
471
  };
1146
- } & {} & {
1147
- command_ids: number[];
472
+ } & {
473
+ actions: {
474
+ action: {
475
+ type: "execute_command";
476
+ meta: {
477
+ command: string;
478
+ } & {
479
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
480
+ };
481
+ } | {
482
+ type: "click";
483
+ value: string;
484
+ } | {
485
+ type: "click" | "clickBySelector" | "clickByXpath";
486
+ value: string[];
487
+ } | ({
488
+ type: "link";
489
+ value: string;
490
+ } & {
491
+ operation?: "self" | "router" | "blank" | undefined;
492
+ }) | {
493
+ type: "open_chat";
494
+ meta: {
495
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
496
+ };
497
+ } | {
498
+ type: "dismiss";
499
+ } | {
500
+ type: "snooze";
501
+ } | {
502
+ type: "questlist";
503
+ value: number;
504
+ } | {
505
+ type: "step_back";
506
+ } | {
507
+ type: "nudge";
508
+ value: number;
509
+ } | {
510
+ type: "go_to_step";
511
+ value: number;
512
+ } | ({
513
+ type: "open_bar";
514
+ } & {
515
+ value?: string | undefined;
516
+ categoryFilter?: number | undefined;
517
+ }) | {
518
+ type: "open_helphub";
519
+ } | {
520
+ type: "open_copilot";
521
+ } | {
522
+ type: "no_action";
523
+ };
524
+ cta: string;
525
+ }[];
1148
526
  }>;
1149
527
  static delete: (id: string | number, params?: Record<string, string> | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
1150
- static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({} & {
528
+ static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
1151
529
  id: number;
1152
530
  widget: string;
1153
531
  default: boolean;
@@ -1167,13 +545,65 @@ export declare class RecommendationSet {
1167
545
  reason?: string | undefined;
1168
546
  };
1169
547
  };
1170
- } & {} & {
1171
- command_ids: number[];
548
+ } & {
549
+ actions: {
550
+ action: {
551
+ type: "execute_command";
552
+ meta: {
553
+ command: string;
554
+ } & {
555
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
556
+ };
557
+ } | {
558
+ type: "click";
559
+ value: string;
560
+ } | {
561
+ type: "click" | "clickBySelector" | "clickByXpath";
562
+ value: string[];
563
+ } | ({
564
+ type: "link";
565
+ value: string;
566
+ } & {
567
+ operation?: "self" | "router" | "blank" | undefined;
568
+ }) | {
569
+ type: "open_chat";
570
+ meta: {
571
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
572
+ };
573
+ } | {
574
+ type: "dismiss";
575
+ } | {
576
+ type: "snooze";
577
+ } | {
578
+ type: "questlist";
579
+ value: number;
580
+ } | {
581
+ type: "step_back";
582
+ } | {
583
+ type: "nudge";
584
+ value: number;
585
+ } | {
586
+ type: "go_to_step";
587
+ value: number;
588
+ } | ({
589
+ type: "open_bar";
590
+ } & {
591
+ value?: string | undefined;
592
+ categoryFilter?: number | undefined;
593
+ }) | {
594
+ type: "open_helphub";
595
+ } | {
596
+ type: "open_copilot";
597
+ } | {
598
+ type: "no_action";
599
+ };
600
+ cta: string;
601
+ }[];
1172
602
  })[]>;
1173
603
  static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
1174
604
  onSuccess?: (() => void) | undefined;
1175
605
  onError?: ((err: string) => void) | undefined;
1176
- } | undefined) => Promise<{} & {
606
+ } | undefined) => Promise<{
1177
607
  id: number;
1178
608
  widget: string;
1179
609
  default: boolean;
@@ -1193,7 +623,59 @@ export declare class RecommendationSet {
1193
623
  reason?: string | undefined;
1194
624
  };
1195
625
  };
1196
- } & {} & {
1197
- command_ids: number[];
626
+ } & {
627
+ actions: {
628
+ action: {
629
+ type: "execute_command";
630
+ meta: {
631
+ command: string;
632
+ } & {
633
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
634
+ };
635
+ } | {
636
+ type: "click";
637
+ value: string;
638
+ } | {
639
+ type: "click" | "clickBySelector" | "clickByXpath";
640
+ value: string[];
641
+ } | ({
642
+ type: "link";
643
+ value: string;
644
+ } & {
645
+ operation?: "self" | "router" | "blank" | undefined;
646
+ }) | {
647
+ type: "open_chat";
648
+ meta: {
649
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
650
+ };
651
+ } | {
652
+ type: "dismiss";
653
+ } | {
654
+ type: "snooze";
655
+ } | {
656
+ type: "questlist";
657
+ value: number;
658
+ } | {
659
+ type: "step_back";
660
+ } | {
661
+ type: "nudge";
662
+ value: number;
663
+ } | {
664
+ type: "go_to_step";
665
+ value: number;
666
+ } | ({
667
+ type: "open_bar";
668
+ } & {
669
+ value?: string | undefined;
670
+ categoryFilter?: number | undefined;
671
+ }) | {
672
+ type: "open_helphub";
673
+ } | {
674
+ type: "open_copilot";
675
+ } | {
676
+ type: "no_action";
677
+ };
678
+ cta: string;
679
+ }[];
1198
680
  }>;
1199
681
  }