commandbar 1.8.7 → 1.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (41) hide show
  1. package/build/commandbar-js/src/index.js +1 -1
  2. package/build/internal/src/client/AddContextOptions.d.ts +4 -0
  3. package/build/internal/src/client/AnalyticsEventTypes.d.ts +1 -1
  4. package/build/internal/src/client/CommandBarClientSDK.d.ts +25 -7
  5. package/build/internal/src/client/CommandBarProxySDK.d.ts +3 -3
  6. package/build/internal/src/client/CommandBarSDK.d.ts +23 -12
  7. package/build/internal/src/client/EventHandler.d.ts +19 -5
  8. package/build/internal/src/client/globals.d.ts +6 -0
  9. package/build/internal/src/client/symbols.d.ts +11 -6
  10. package/build/internal/src/middleware/CommandFromClientV.d.ts +68 -10
  11. package/build/internal/src/middleware/OrganizationV.d.ts +124 -20
  12. package/build/internal/src/middleware/additionalResource.d.ts +178 -16
  13. package/build/internal/src/middleware/billing.d.ts +33 -0
  14. package/build/internal/src/middleware/chat.d.ts +10913 -0
  15. package/build/internal/src/middleware/checklist.d.ts +106 -28
  16. package/build/internal/src/middleware/command.d.ts +3778 -446
  17. package/build/internal/src/middleware/detailPreview.d.ts +12 -1
  18. package/build/internal/src/middleware/endUser.d.ts +104 -0
  19. package/build/internal/src/middleware/generics.d.ts +12 -11
  20. package/build/internal/src/middleware/helpDocsIntegration.d.ts +54 -8
  21. package/build/internal/src/middleware/helpDocsSearch.d.ts +2204 -0
  22. package/build/internal/src/middleware/helpHub.d.ts +26 -0
  23. package/build/internal/src/middleware/helpers/actions.d.ts +116 -8
  24. package/build/internal/src/middleware/helpers/commandTemplate.d.ts +82 -2
  25. package/build/internal/src/middleware/helpers/pushTrigger.d.ts +6 -0
  26. package/build/internal/src/middleware/helpers/rules.d.ts +285 -26
  27. package/build/internal/src/middleware/network.d.ts +18 -3
  28. package/build/internal/src/middleware/nudge.d.ts +1193 -43
  29. package/build/internal/src/middleware/organization.d.ts +1051 -141
  30. package/build/internal/src/middleware/organizationSettings.d.ts +129 -22
  31. package/build/internal/src/middleware/recommendationSet.d.ts +408 -1007
  32. package/build/internal/src/middleware/types.d.ts +43 -25
  33. package/build/internal/src/util/dispatchCustomEvent.d.ts +3 -1
  34. package/build/internal/src/util/operatingSystem.d.ts +13 -0
  35. package/build/internal/src/util/sentry.d.ts +23 -0
  36. package/package.json +3 -3
  37. package/build/internal/src/client/SentryReporter.d.ts +0 -63
  38. package/build/internal/src/middleware/chatAnalytics.d.ts +0 -2601
  39. package/build/internal/src/middleware/helpers/endUser.d.ts +0 -11
  40. package/build/internal/src/middleware/qaPair.d.ts +0 -676
  41. package/build/internal/src/util/integrations.d.ts +0 -1
package/build/internal/src/middleware/chatAnalytics.d.ts DELETED
@@ -1,2601 +0,0 @@
1
- import * as t from 'io-ts';
2
- export declare const AIMessageV: t.TypeC<{
3
- uuid: t.UnionC<[t.NullC, t.StringC]>;
4
- error: t.StringC;
5
- incomplete: t.BooleanC;
6
- no_answer: t.BooleanC;
7
- used_fallback: t.BooleanC;
8
- feedback: t.UnionC<[t.NullC, t.TypeC<{
9
- rating: t.UnionC<[t.LiteralC<-1>, t.LiteralC<0>, t.LiteralC<1>]>;
10
- }>]>;
11
- continuations: t.UnionC<[t.NullC, t.ArrayC<t.StringC>]>;
12
- fallback_ctas: t.UnionC<[t.NullC, t.ArrayC<t.StringC>]>;
13
- message_type: t.LiteralC<"AI">;
14
- value: t.TypeC<{
15
- chat_id: t.StringC;
16
- answer: t.StringC;
17
- command_id: t.UnionC<[t.NullC, t.NumberC]>;
18
- command_title: t.UnionC<[t.NullC, t.StringC]>;
19
- passage_id: t.UnionC<[t.NullC, t.NumberC]>;
20
- message_id: t.UnionC<[t.NullC, t.NumberC]>;
21
- doc: t.UnionC<[t.NullC, t.TypeC<{
22
- title: t.StringC;
23
- excerpt: t.StringC;
24
- content: t.StringC;
25
- command: t.Type<{
26
- id: number;
27
- organization: string | number;
28
- text: string;
29
- template: ({
30
- type: "admin";
31
- value: string;
32
- } & {} & {
33
- commandType?: "object" | "help" | "independent" | undefined;
34
- object?: string | undefined;
35
- hoverTooltip?: boolean | undefined;
36
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
37
- }) | ({
38
- type: "callback";
39
- value: string;
40
- } & {} & {
41
- commandType?: "object" | "help" | "independent" | undefined;
42
- object?: string | undefined;
43
- hoverTooltip?: boolean | undefined;
44
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
45
- }) | ({
46
- type: "link";
47
- value: string;
48
- } & {
49
- operation?: "self" | "router" | "blank" | undefined;
50
- } & {} & {
51
- commandType?: "object" | "help" | "independent" | undefined;
52
- object?: string | undefined;
53
- hoverTooltip?: boolean | undefined;
54
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
55
- }) | ({
56
- type: "click" | "clickByXpath" | "clickBySelector";
57
- value: string[];
58
- } & {} & {
59
- commandType?: "object" | "help" | "independent" | undefined;
60
- object?: string | undefined;
61
- hoverTooltip?: boolean | undefined;
62
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
63
- }) | ({
64
- type: "builtin";
65
- value: string;
66
- } & {} & {
67
- commandType?: "object" | "help" | "independent" | undefined;
68
- object?: string | undefined;
69
- hoverTooltip?: boolean | undefined;
70
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
71
- }) | ({
72
- type: "webhook";
73
- value: string;
74
- } & {} & {
75
- commandType?: "object" | "help" | "independent" | undefined;
76
- object?: string | undefined;
77
- hoverTooltip?: boolean | undefined;
78
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
79
- }) | ({
80
- type: "script";
81
- value: string;
82
- } & {} & {
83
- commandType?: "object" | "help" | "independent" | undefined;
84
- object?: string | undefined;
85
- hoverTooltip?: boolean | undefined;
86
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
87
- }) | ({
88
- type: "request";
89
- value: {
90
- method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
91
- url: string;
92
- } & {
93
- headers?: {
94
- [key: string]: unknown;
95
- } | undefined;
96
- body?: {
97
- [key: string]: unknown;
98
- } | undefined;
99
- onSend?: string | undefined;
100
- onSuccess?: string | undefined;
101
- onError?: string | undefined;
102
- };
103
- } & {} & {
104
- commandType?: "object" | "help" | "independent" | undefined;
105
- object?: string | undefined;
106
- hoverTooltip?: boolean | undefined;
107
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
108
- }) | ({
109
- type: "appcues";
110
- value: string;
111
- } & {} & {
112
- commandType?: "object" | "help" | "independent" | undefined;
113
- object?: string | undefined;
114
- hoverTooltip?: boolean | undefined;
115
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
116
- }) | ({
117
- type: "video";
118
- value: string;
119
- } & {} & {
120
- commandType?: "object" | "help" | "independent" | undefined;
121
- object?: string | undefined;
122
- hoverTooltip?: boolean | undefined;
123
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
124
- }) | ({
125
- type: "helpdoc";
126
- value: string;
127
- } & {
128
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
129
- doc_metadata?: {
130
- content_type?: string | undefined;
131
- date?: string | undefined;
132
- } | undefined;
133
- } & {
134
- doc_type?: "answer" | "doc" | undefined;
135
- } & {} & {
136
- commandType?: "object" | "help" | "independent" | undefined;
137
- object?: string | undefined;
138
- hoverTooltip?: boolean | undefined;
139
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
140
- }) | ({
141
- type: "trigger";
142
- value: any;
143
- } & {} & {
144
- commandType?: "object" | "help" | "independent" | undefined;
145
- object?: string | undefined;
146
- hoverTooltip?: boolean | undefined;
147
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
148
- });
149
- } & {
150
- disabledReason?: string | undefined;
151
- source?: string | undefined;
152
- name?: string | undefined;
153
- last_available?: string | null | undefined;
154
- modified?: string | undefined;
155
- isAsync?: boolean | undefined;
156
- } & {
157
- arguments: {
158
- [x: string]: ({
159
- type: "context";
160
- value: string;
161
- order_key: number;
162
- } & {
163
- label?: string | undefined;
164
- chosen?: string | number | undefined;
165
- selected?: any[] | undefined;
166
- input_type?: string | undefined;
167
- preselected_key?: string | undefined;
168
- label_field?: string | undefined;
169
- loaded?: any[] | undefined;
170
- allow_create?: boolean | undefined;
171
- allow_create_label?: string | undefined;
172
- show_in_record_action_list?: boolean | undefined;
173
- show_in_default_list?: boolean | undefined;
174
- auto_choose?: boolean | undefined;
175
- is_private?: boolean | undefined;
176
- }) | ({
177
- type: "set";
178
- value: string[] | number[] | {
179
- [key: string]: unknown;
180
- }[];
181
- order_key: number;
182
- } & {
183
- label?: string | undefined;
184
- chosen?: string | number | undefined;
185
- selected?: any[] | undefined;
186
- input_type?: string | undefined;
187
- preselected_key?: string | undefined;
188
- label_field?: string | undefined;
189
- loaded?: any[] | undefined;
190
- allow_create?: boolean | undefined;
191
- allow_create_label?: string | undefined;
192
- auto_choose?: boolean | undefined;
193
- is_private?: boolean | undefined;
194
- }) | ({
195
- type: "provided";
196
- value: "time" | "text";
197
- order_key: number;
198
- } & {
199
- label?: string | undefined;
200
- chosen?: string | number | undefined;
201
- selected?: any[] | undefined;
202
- input_type?: string | undefined;
203
- preselected_key?: string | undefined;
204
- label_field?: string | undefined;
205
- loaded?: any[] | undefined;
206
- dateTimeArgumentTypeId?: number | undefined;
207
- allow_create?: boolean | undefined;
208
- allow_create_label?: string | undefined;
209
- auto_choose?: boolean | undefined;
210
- is_private?: boolean | undefined;
211
- }) | ({
212
- type: "html" | "video";
213
- value: {
214
- source: string;
215
- } & {
216
- title?: string | undefined;
217
- description?: string | undefined;
218
- url?: string | undefined;
219
- };
220
- order_key: number;
221
- } & {
222
- label?: string | undefined;
223
- chosen?: string | number | undefined;
224
- selected?: any[] | undefined;
225
- input_type?: string | undefined;
226
- preselected_key?: string | undefined;
227
- label_field?: string | undefined;
228
- loaded?: any[] | undefined;
229
- allow_create?: boolean | undefined;
230
- allow_create_label?: string | undefined;
231
- is_private?: boolean | undefined;
232
- auto_choose?: boolean | undefined;
233
- });
234
- };
235
- tags: string[];
236
- availability_rules: ({
237
- type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
238
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
239
- } & {
240
- field?: string | undefined;
241
- value?: string | undefined;
242
- reason?: string | undefined;
243
- rule_id?: string | number | undefined;
244
- })[];
245
- recommend_rules: (({
246
- type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
247
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
248
- } & {
249
- field?: string | undefined;
250
- value?: string | undefined;
251
- reason?: string | undefined;
252
- rule_id?: string | number | undefined;
253
- }) | ({
254
- type: "always";
255
- } & {
256
- operator?: null | undefined;
257
- field?: null | undefined;
258
- value?: null | undefined;
259
- reason?: null | undefined;
260
- rule_id?: string | number | undefined;
261
- }))[];
262
- availability_expression: import("./helpers/rules").RuleExpression | null;
263
- recommend_expression: import("./helpers/rules").RuleExpression | null;
264
- always_recommend: boolean;
265
- confirm: string;
266
- shortcut: string[];
267
- explanation: string;
268
- heading: string;
269
- is_live: boolean;
270
- category: number | null;
271
- sort_key: number | null;
272
- icon: string | null;
273
- icon_color: string | null;
274
- image_color: string | null;
275
- image: string | null;
276
- celebrate: boolean | {
277
- angle?: number | undefined;
278
- spread?: number | undefined;
279
- width?: string | undefined;
280
- height?: string | undefined;
281
- duration?: number | undefined;
282
- dragFriction?: number | undefined;
283
- stagger?: number | undefined;
284
- startVelocity?: number | undefined;
285
- elementCount?: number | undefined;
286
- decay?: number | undefined;
287
- colors?: string[] | undefined;
288
- random?: any;
289
- } | null;
290
- recommend_sort_key: number | null;
291
- shortcut_mac: string[];
292
- shortcut_win: string[];
293
- hotkey_mac: string;
294
- hotkey_win: string;
295
- detail: string | ({
296
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
297
- value: string;
298
- } & {
299
- position?: "inline" | "popover" | undefined;
300
- }) | (string | ({
301
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
302
- value: string;
303
- } & {
304
- position?: "inline" | "popover" | undefined;
305
- }))[] | null;
306
- content: string | ({
307
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
308
- value: string;
309
- } & {
310
- position?: "inline" | "popover" | undefined;
311
- }) | (string | ({
312
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
313
- value: string;
314
- } & {
315
- position?: "inline" | "popover" | undefined;
316
- }))[] | null;
317
- show_preview: boolean;
318
- next_steps: (string | number | {
319
- cta: string;
320
- action: {
321
- type: "execute_command";
322
- meta: {
323
- command: string;
324
- };
325
- } | {
326
- type: "no_action";
327
- } | {
328
- type: "click";
329
- value: string;
330
- } | ({
331
- type: "link";
332
- value: string;
333
- } & {
334
- operation?: "self" | "router" | "blank" | undefined;
335
- }) | {
336
- type: "open_chat";
337
- meta: {
338
- type: string;
339
- };
340
- } | {
341
- type: "dismiss";
342
- };
343
- })[];
344
- extra: string | null;
345
- thumbnail: {
346
- src: string;
347
- file_name: string;
348
- size: string;
349
- } | null;
350
- } & {
351
- third_party_source?: string | null | undefined;
352
- third_party_id?: string | null | undefined;
353
- training_only?: boolean | undefined;
354
- }, {
355
- id: number;
356
- organization: string | number;
357
- text: string;
358
- template: ({
359
- type: "admin";
360
- value: string;
361
- } & {} & {
362
- commandType?: "object" | "help" | "independent" | undefined;
363
- object?: string | undefined;
364
- hoverTooltip?: boolean | undefined;
365
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
366
- }) | ({
367
- type: "callback";
368
- value: string;
369
- } & {} & {
370
- commandType?: "object" | "help" | "independent" | undefined;
371
- object?: string | undefined;
372
- hoverTooltip?: boolean | undefined;
373
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
374
- }) | ({
375
- type: "link";
376
- value: string;
377
- } & {
378
- operation?: "self" | "router" | "blank" | undefined;
379
- } & {} & {
380
- commandType?: "object" | "help" | "independent" | undefined;
381
- object?: string | undefined;
382
- hoverTooltip?: boolean | undefined;
383
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
384
- }) | ({
385
- type: "click" | "clickByXpath" | "clickBySelector";
386
- value: string[];
387
- } & {} & {
388
- commandType?: "object" | "help" | "independent" | undefined;
389
- object?: string | undefined;
390
- hoverTooltip?: boolean | undefined;
391
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
392
- }) | ({
393
- type: "builtin";
394
- value: string;
395
- } & {} & {
396
- commandType?: "object" | "help" | "independent" | undefined;
397
- object?: string | undefined;
398
- hoverTooltip?: boolean | undefined;
399
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
400
- }) | ({
401
- type: "webhook";
402
- value: string;
403
- } & {} & {
404
- commandType?: "object" | "help" | "independent" | undefined;
405
- object?: string | undefined;
406
- hoverTooltip?: boolean | undefined;
407
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
408
- }) | ({
409
- type: "script";
410
- value: string;
411
- } & {} & {
412
- commandType?: "object" | "help" | "independent" | undefined;
413
- object?: string | undefined;
414
- hoverTooltip?: boolean | undefined;
415
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
416
- }) | ({
417
- type: "request";
418
- value: {
419
- method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
420
- url: string;
421
- } & {
422
- headers?: {
423
- [key: string]: unknown;
424
- } | undefined;
425
- body?: {
426
- [key: string]: unknown;
427
- } | undefined;
428
- onSend?: string | undefined;
429
- onSuccess?: string | undefined;
430
- onError?: string | undefined;
431
- };
432
- } & {} & {
433
- commandType?: "object" | "help" | "independent" | undefined;
434
- object?: string | undefined;
435
- hoverTooltip?: boolean | undefined;
436
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
437
- }) | ({
438
- type: "appcues";
439
- value: string;
440
- } & {} & {
441
- commandType?: "object" | "help" | "independent" | undefined;
442
- object?: string | undefined;
443
- hoverTooltip?: boolean | undefined;
444
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
445
- }) | ({
446
- type: "video";
447
- value: string;
448
- } & {} & {
449
- commandType?: "object" | "help" | "independent" | undefined;
450
- object?: string | undefined;
451
- hoverTooltip?: boolean | undefined;
452
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
453
- }) | ({
454
- type: "helpdoc";
455
- value: string;
456
- } & {
457
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
458
- doc_metadata?: {
459
- content_type?: string | undefined;
460
- date?: string | undefined;
461
- } | undefined;
462
- } & {
463
- doc_type?: "answer" | "doc" | undefined;
464
- } & {} & {
465
- commandType?: "object" | "help" | "independent" | undefined;
466
- object?: string | undefined;
467
- hoverTooltip?: boolean | undefined;
468
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
469
- }) | ({
470
- type: "trigger";
471
- value: any;
472
- } & {} & {
473
- commandType?: "object" | "help" | "independent" | undefined;
474
- object?: string | undefined;
475
- hoverTooltip?: boolean | undefined;
476
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
477
- });
478
- } & {
479
- disabledReason?: string | undefined;
480
- source?: string | undefined;
481
- name?: string | undefined;
482
- last_available?: string | null | undefined;
483
- modified?: string | undefined;
484
- isAsync?: boolean | undefined;
485
- } & {
486
- arguments: {
487
- [x: string]: ({
488
- type: "context";
489
- value: string;
490
- order_key: number;
491
- } & {
492
- label?: string | undefined;
493
- chosen?: string | number | undefined;
494
- selected?: any[] | undefined;
495
- input_type?: string | undefined;
496
- preselected_key?: string | undefined;
497
- label_field?: string | undefined;
498
- loaded?: any[] | undefined;
499
- allow_create?: boolean | undefined;
500
- allow_create_label?: string | undefined;
501
- show_in_record_action_list?: boolean | undefined;
502
- show_in_default_list?: boolean | undefined;
503
- auto_choose?: boolean | undefined;
504
- is_private?: boolean | undefined;
505
- }) | ({
506
- type: "set";
507
- value: string[] | number[] | {
508
- [key: string]: unknown;
509
- }[];
510
- order_key: number;
511
- } & {
512
- label?: string | undefined;
513
- chosen?: string | number | undefined;
514
- selected?: any[] | undefined;
515
- input_type?: string | undefined;
516
- preselected_key?: string | undefined;
517
- label_field?: string | undefined;
518
- loaded?: any[] | undefined;
519
- allow_create?: boolean | undefined;
520
- allow_create_label?: string | undefined;
521
- auto_choose?: boolean | undefined;
522
- is_private?: boolean | undefined;
523
- }) | ({
524
- type: "provided";
525
- value: "time" | "text";
526
- order_key: number;
527
- } & {
528
- label?: string | undefined;
529
- chosen?: string | number | undefined;
530
- selected?: any[] | undefined;
531
- input_type?: string | undefined;
532
- preselected_key?: string | undefined;
533
- label_field?: string | undefined;
534
- loaded?: any[] | undefined;
535
- dateTimeArgumentTypeId?: number | undefined;
536
- allow_create?: boolean | undefined;
537
- allow_create_label?: string | undefined;
538
- auto_choose?: boolean | undefined;
539
- is_private?: boolean | undefined;
540
- }) | ({
541
- type: "html" | "video";
542
- value: {
543
- source: string;
544
- } & {
545
- title?: string | undefined;
546
- description?: string | undefined;
547
- url?: string | undefined;
548
- };
549
- order_key: number;
550
- } & {
551
- label?: string | undefined;
552
- chosen?: string | number | undefined;
553
- selected?: any[] | undefined;
554
- input_type?: string | undefined;
555
- preselected_key?: string | undefined;
556
- label_field?: string | undefined;
557
- loaded?: any[] | undefined;
558
- allow_create?: boolean | undefined;
559
- allow_create_label?: string | undefined;
560
- is_private?: boolean | undefined;
561
- auto_choose?: boolean | undefined;
562
- });
563
- };
564
- tags: string[];
565
- availability_rules: ({
566
- type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
567
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
568
- } & {
569
- field?: string | undefined;
570
- value?: string | undefined;
571
- reason?: string | undefined;
572
- rule_id?: string | number | undefined;
573
- })[];
574
- recommend_rules: (({
575
- type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
576
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
577
- } & {
578
- field?: string | undefined;
579
- value?: string | undefined;
580
- reason?: string | undefined;
581
- rule_id?: string | number | undefined;
582
- }) | ({
583
- type: "always";
584
- } & {
585
- operator?: null | undefined;
586
- field?: null | undefined;
587
- value?: null | undefined;
588
- reason?: null | undefined;
589
- rule_id?: string | number | undefined;
590
- }))[];
591
- availability_expression: import("./helpers/rules").RuleExpression | null;
592
- recommend_expression: import("./helpers/rules").RuleExpression | null;
593
- always_recommend: boolean;
594
- confirm: string;
595
- shortcut: string[];
596
- explanation: string;
597
- heading: string;
598
- is_live: boolean;
599
- category: number | null;
600
- sort_key: number | null;
601
- icon: string | null;
602
- icon_color: string | null;
603
- image_color: string | null;
604
- image: string | null;
605
- celebrate: boolean | {
606
- angle?: number | undefined;
607
- spread?: number | undefined;
608
- width?: string | undefined;
609
- height?: string | undefined;
610
- duration?: number | undefined;
611
- dragFriction?: number | undefined;
612
- stagger?: number | undefined;
613
- startVelocity?: number | undefined;
614
- elementCount?: number | undefined;
615
- decay?: number | undefined;
616
- colors?: string[] | undefined;
617
- random?: any;
618
- } | null;
619
- recommend_sort_key: number | null;
620
- shortcut_mac: string[];
621
- shortcut_win: string[];
622
- hotkey_mac: string;
623
- hotkey_win: string;
624
- detail: string | ({
625
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
626
- value: string;
627
- } & {
628
- position?: "inline" | "popover" | undefined;
629
- }) | (string | ({
630
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
631
- value: string;
632
- } & {
633
- position?: "inline" | "popover" | undefined;
634
- }))[] | null;
635
- content: string | ({
636
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
637
- value: string;
638
- } & {
639
- position?: "inline" | "popover" | undefined;
640
- }) | (string | ({
641
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
642
- value: string;
643
- } & {
644
- position?: "inline" | "popover" | undefined;
645
- }))[] | null;
646
- show_preview: boolean;
647
- next_steps: (string | number | {
648
- cta: string;
649
- action: {
650
- type: "execute_command";
651
- meta: {
652
- command: string;
653
- };
654
- } | {
655
- type: "no_action";
656
- } | {
657
- type: "click";
658
- value: string;
659
- } | ({
660
- type: "link";
661
- value: string;
662
- } & {
663
- operation?: "self" | "router" | "blank" | undefined;
664
- }) | {
665
- type: "open_chat";
666
- meta: {
667
- type: string;
668
- };
669
- } | {
670
- type: "dismiss";
671
- };
672
- })[];
673
- extra: string | null;
674
- thumbnail: {
675
- src: string;
676
- file_name: string;
677
- size: string;
678
- } | null;
679
- } & {
680
- third_party_source?: string | null | undefined;
681
- third_party_id?: string | null | undefined;
682
- training_only?: boolean | undefined;
683
- }, any>;
684
- }>]>;
685
- }>;
686
- }>;
687
- export declare const UserMessageV: t.TypeC<{
688
- uuid: t.UnionC<[t.NullC, t.StringC]>;
689
- error: t.StringC;
690
- incomplete: t.BooleanC;
691
- no_answer: t.BooleanC;
692
- used_fallback: t.BooleanC;
693
- feedback: t.UnionC<[t.NullC, t.TypeC<{
694
- rating: t.UnionC<[t.LiteralC<-1>, t.LiteralC<0>, t.LiteralC<1>]>;
695
- }>]>;
696
- continuations: t.UnionC<[t.NullC, t.ArrayC<t.StringC>]>;
697
- fallback_ctas: t.UnionC<[t.NullC, t.ArrayC<t.StringC>]>;
698
- message_type: t.LiteralC<"USER">;
699
- value: t.TypeC<{
700
- question: t.StringC;
701
- command_ids: t.ArrayC<t.NumberC>;
702
- }>;
703
- }>;
704
- export declare const MessageV: t.UnionC<[t.TypeC<{
705
- uuid: t.UnionC<[t.NullC, t.StringC]>;
706
- error: t.StringC;
707
- incomplete: t.BooleanC;
708
- no_answer: t.BooleanC;
709
- used_fallback: t.BooleanC;
710
- feedback: t.UnionC<[t.NullC, t.TypeC<{
711
- rating: t.UnionC<[t.LiteralC<-1>, t.LiteralC<0>, t.LiteralC<1>]>;
712
- }>]>;
713
- continuations: t.UnionC<[t.NullC, t.ArrayC<t.StringC>]>;
714
- fallback_ctas: t.UnionC<[t.NullC, t.ArrayC<t.StringC>]>;
715
- message_type: t.LiteralC<"AI">;
716
- value: t.TypeC<{
717
- chat_id: t.StringC;
718
- answer: t.StringC;
719
- command_id: t.UnionC<[t.NullC, t.NumberC]>;
720
- command_title: t.UnionC<[t.NullC, t.StringC]>;
721
- passage_id: t.UnionC<[t.NullC, t.NumberC]>;
722
- message_id: t.UnionC<[t.NullC, t.NumberC]>;
723
- doc: t.UnionC<[t.NullC, t.TypeC<{
724
- title: t.StringC;
725
- excerpt: t.StringC;
726
- content: t.StringC;
727
- command: t.Type<{
728
- id: number;
729
- organization: string | number;
730
- text: string;
731
- template: ({
732
- type: "admin";
733
- value: string;
734
- } & {} & {
735
- commandType?: "object" | "help" | "independent" | undefined;
736
- object?: string | undefined;
737
- hoverTooltip?: boolean | undefined;
738
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
739
- }) | ({
740
- type: "callback";
741
- value: string;
742
- } & {} & {
743
- commandType?: "object" | "help" | "independent" | undefined;
744
- object?: string | undefined;
745
- hoverTooltip?: boolean | undefined;
746
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
747
- }) | ({
748
- type: "link";
749
- value: string;
750
- } & {
751
- operation?: "self" | "router" | "blank" | undefined;
752
- } & {} & {
753
- commandType?: "object" | "help" | "independent" | undefined;
754
- object?: string | undefined;
755
- hoverTooltip?: boolean | undefined;
756
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
757
- }) | ({
758
- type: "click" | "clickByXpath" | "clickBySelector";
759
- value: string[];
760
- } & {} & {
761
- commandType?: "object" | "help" | "independent" | undefined;
762
- object?: string | undefined;
763
- hoverTooltip?: boolean | undefined;
764
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
765
- }) | ({
766
- type: "builtin";
767
- value: string;
768
- } & {} & {
769
- commandType?: "object" | "help" | "independent" | undefined;
770
- object?: string | undefined;
771
- hoverTooltip?: boolean | undefined;
772
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
773
- }) | ({
774
- type: "webhook";
775
- value: string;
776
- } & {} & {
777
- commandType?: "object" | "help" | "independent" | undefined;
778
- object?: string | undefined;
779
- hoverTooltip?: boolean | undefined;
780
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
781
- }) | ({
782
- type: "script";
783
- value: string;
784
- } & {} & {
785
- commandType?: "object" | "help" | "independent" | undefined;
786
- object?: string | undefined;
787
- hoverTooltip?: boolean | undefined;
788
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
789
- }) | ({
790
- type: "request";
791
- value: {
792
- method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
793
- url: string;
794
- } & {
795
- headers?: {
796
- [key: string]: unknown;
797
- } | undefined;
798
- body?: {
799
- [key: string]: unknown;
800
- } | undefined;
801
- onSend?: string | undefined;
802
- onSuccess?: string | undefined;
803
- onError?: string | undefined;
804
- };
805
- } & {} & {
806
- commandType?: "object" | "help" | "independent" | undefined;
807
- object?: string | undefined;
808
- hoverTooltip?: boolean | undefined;
809
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
810
- }) | ({
811
- type: "appcues";
812
- value: string;
813
- } & {} & {
814
- commandType?: "object" | "help" | "independent" | undefined;
815
- object?: string | undefined;
816
- hoverTooltip?: boolean | undefined;
817
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
818
- }) | ({
819
- type: "video";
820
- value: string;
821
- } & {} & {
822
- commandType?: "object" | "help" | "independent" | undefined;
823
- object?: string | undefined;
824
- hoverTooltip?: boolean | undefined;
825
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
826
- }) | ({
827
- type: "helpdoc";
828
- value: string;
829
- } & {
830
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
831
- doc_metadata?: {
832
- content_type?: string | undefined;
833
- date?: string | undefined;
834
- } | undefined;
835
- } & {
836
- doc_type?: "answer" | "doc" | undefined;
837
- } & {} & {
838
- commandType?: "object" | "help" | "independent" | undefined;
839
- object?: string | undefined;
840
- hoverTooltip?: boolean | undefined;
841
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
842
- }) | ({
843
- type: "trigger";
844
- value: any;
845
- } & {} & {
846
- commandType?: "object" | "help" | "independent" | undefined;
847
- object?: string | undefined;
848
- hoverTooltip?: boolean | undefined;
849
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
850
- });
851
- } & {
852
- disabledReason?: string | undefined;
853
- source?: string | undefined;
854
- name?: string | undefined;
855
- last_available?: string | null | undefined;
856
- modified?: string | undefined;
857
- isAsync?: boolean | undefined;
858
- } & {
859
- arguments: {
860
- [x: string]: ({
861
- type: "context";
862
- value: string;
863
- order_key: number;
864
- } & {
865
- label?: string | undefined;
866
- chosen?: string | number | undefined;
867
- selected?: any[] | undefined;
868
- input_type?: string | undefined;
869
- preselected_key?: string | undefined;
870
- label_field?: string | undefined;
871
- loaded?: any[] | undefined;
872
- allow_create?: boolean | undefined;
873
- allow_create_label?: string | undefined;
874
- show_in_record_action_list?: boolean | undefined;
875
- show_in_default_list?: boolean | undefined;
876
- auto_choose?: boolean | undefined;
877
- is_private?: boolean | undefined;
878
- }) | ({
879
- type: "set";
880
- value: string[] | number[] | {
881
- [key: string]: unknown;
882
- }[];
883
- order_key: number;
884
- } & {
885
- label?: string | undefined;
886
- chosen?: string | number | undefined;
887
- selected?: any[] | undefined;
888
- input_type?: string | undefined;
889
- preselected_key?: string | undefined;
890
- label_field?: string | undefined;
891
- loaded?: any[] | undefined;
892
- allow_create?: boolean | undefined;
893
- allow_create_label?: string | undefined;
894
- auto_choose?: boolean | undefined;
895
- is_private?: boolean | undefined;
896
- }) | ({
897
- type: "provided";
898
- value: "time" | "text";
899
- order_key: number;
900
- } & {
901
- label?: string | undefined;
902
- chosen?: string | number | undefined;
903
- selected?: any[] | undefined;
904
- input_type?: string | undefined;
905
- preselected_key?: string | undefined;
906
- label_field?: string | undefined;
907
- loaded?: any[] | undefined;
908
- dateTimeArgumentTypeId?: number | undefined;
909
- allow_create?: boolean | undefined;
910
- allow_create_label?: string | undefined;
911
- auto_choose?: boolean | undefined;
912
- is_private?: boolean | undefined;
913
- }) | ({
914
- type: "html" | "video";
915
- value: {
916
- source: string;
917
- } & {
918
- title?: string | undefined;
919
- description?: string | undefined;
920
- url?: string | undefined;
921
- };
922
- order_key: number;
923
- } & {
924
- label?: string | undefined;
925
- chosen?: string | number | undefined;
926
- selected?: any[] | undefined;
927
- input_type?: string | undefined;
928
- preselected_key?: string | undefined;
929
- label_field?: string | undefined;
930
- loaded?: any[] | undefined;
931
- allow_create?: boolean | undefined;
932
- allow_create_label?: string | undefined;
933
- is_private?: boolean | undefined;
934
- auto_choose?: boolean | undefined;
935
- });
936
- };
937
- tags: string[];
938
- availability_rules: ({
939
- type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
940
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
941
- } & {
942
- field?: string | undefined;
943
- value?: string | undefined;
944
- reason?: string | undefined;
945
- rule_id?: string | number | undefined;
946
- })[];
947
- recommend_rules: (({
948
- type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
949
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
950
- } & {
951
- field?: string | undefined;
952
- value?: string | undefined;
953
- reason?: string | undefined;
954
- rule_id?: string | number | undefined;
955
- }) | ({
956
- type: "always";
957
- } & {
958
- operator?: null | undefined;
959
- field?: null | undefined;
960
- value?: null | undefined;
961
- reason?: null | undefined;
962
- rule_id?: string | number | undefined;
963
- }))[];
964
- availability_expression: import("./helpers/rules").RuleExpression | null;
965
- recommend_expression: import("./helpers/rules").RuleExpression | null;
966
- always_recommend: boolean;
967
- confirm: string;
968
- shortcut: string[];
969
- explanation: string;
970
- heading: string;
971
- is_live: boolean;
972
- category: number | null;
973
- sort_key: number | null;
974
- icon: string | null;
975
- icon_color: string | null;
976
- image_color: string | null;
977
- image: string | null;
978
- celebrate: boolean | {
979
- angle?: number | undefined;
980
- spread?: number | undefined;
981
- width?: string | undefined;
982
- height?: string | undefined;
983
- duration?: number | undefined;
984
- dragFriction?: number | undefined;
985
- stagger?: number | undefined;
986
- startVelocity?: number | undefined;
987
- elementCount?: number | undefined;
988
- decay?: number | undefined;
989
- colors?: string[] | undefined;
990
- random?: any;
991
- } | null;
992
- recommend_sort_key: number | null;
993
- shortcut_mac: string[];
994
- shortcut_win: string[];
995
- hotkey_mac: string;
996
- hotkey_win: string;
997
- detail: string | ({
998
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
999
- value: string;
1000
- } & {
1001
- position?: "inline" | "popover" | undefined;
1002
- }) | (string | ({
1003
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1004
- value: string;
1005
- } & {
1006
- position?: "inline" | "popover" | undefined;
1007
- }))[] | null;
1008
- content: string | ({
1009
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1010
- value: string;
1011
- } & {
1012
- position?: "inline" | "popover" | undefined;
1013
- }) | (string | ({
1014
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1015
- value: string;
1016
- } & {
1017
- position?: "inline" | "popover" | undefined;
1018
- }))[] | null;
1019
- show_preview: boolean;
1020
- next_steps: (string | number | {
1021
- cta: string;
1022
- action: {
1023
- type: "execute_command";
1024
- meta: {
1025
- command: string;
1026
- };
1027
- } | {
1028
- type: "no_action";
1029
- } | {
1030
- type: "click";
1031
- value: string;
1032
- } | ({
1033
- type: "link";
1034
- value: string;
1035
- } & {
1036
- operation?: "self" | "router" | "blank" | undefined;
1037
- }) | {
1038
- type: "open_chat";
1039
- meta: {
1040
- type: string;
1041
- };
1042
- } | {
1043
- type: "dismiss";
1044
- };
1045
- })[];
1046
- extra: string | null;
1047
- thumbnail: {
1048
- src: string;
1049
- file_name: string;
1050
- size: string;
1051
- } | null;
1052
- } & {
1053
- third_party_source?: string | null | undefined;
1054
- third_party_id?: string | null | undefined;
1055
- training_only?: boolean | undefined;
1056
- }, {
1057
- id: number;
1058
- organization: string | number;
1059
- text: string;
1060
- template: ({
1061
- type: "admin";
1062
- value: string;
1063
- } & {} & {
1064
- commandType?: "object" | "help" | "independent" | undefined;
1065
- object?: string | undefined;
1066
- hoverTooltip?: boolean | undefined;
1067
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1068
- }) | ({
1069
- type: "callback";
1070
- value: string;
1071
- } & {} & {
1072
- commandType?: "object" | "help" | "independent" | undefined;
1073
- object?: string | undefined;
1074
- hoverTooltip?: boolean | undefined;
1075
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1076
- }) | ({
1077
- type: "link";
1078
- value: string;
1079
- } & {
1080
- operation?: "self" | "router" | "blank" | undefined;
1081
- } & {} & {
1082
- commandType?: "object" | "help" | "independent" | undefined;
1083
- object?: string | undefined;
1084
- hoverTooltip?: boolean | undefined;
1085
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1086
- }) | ({
1087
- type: "click" | "clickByXpath" | "clickBySelector";
1088
- value: string[];
1089
- } & {} & {
1090
- commandType?: "object" | "help" | "independent" | undefined;
1091
- object?: string | undefined;
1092
- hoverTooltip?: boolean | undefined;
1093
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1094
- }) | ({
1095
- type: "builtin";
1096
- value: string;
1097
- } & {} & {
1098
- commandType?: "object" | "help" | "independent" | undefined;
1099
- object?: string | undefined;
1100
- hoverTooltip?: boolean | undefined;
1101
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1102
- }) | ({
1103
- type: "webhook";
1104
- value: string;
1105
- } & {} & {
1106
- commandType?: "object" | "help" | "independent" | undefined;
1107
- object?: string | undefined;
1108
- hoverTooltip?: boolean | undefined;
1109
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1110
- }) | ({
1111
- type: "script";
1112
- value: string;
1113
- } & {} & {
1114
- commandType?: "object" | "help" | "independent" | undefined;
1115
- object?: string | undefined;
1116
- hoverTooltip?: boolean | undefined;
1117
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1118
- }) | ({
1119
- type: "request";
1120
- value: {
1121
- method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
1122
- url: string;
1123
- } & {
1124
- headers?: {
1125
- [key: string]: unknown;
1126
- } | undefined;
1127
- body?: {
1128
- [key: string]: unknown;
1129
- } | undefined;
1130
- onSend?: string | undefined;
1131
- onSuccess?: string | undefined;
1132
- onError?: string | undefined;
1133
- };
1134
- } & {} & {
1135
- commandType?: "object" | "help" | "independent" | undefined;
1136
- object?: string | undefined;
1137
- hoverTooltip?: boolean | undefined;
1138
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1139
- }) | ({
1140
- type: "appcues";
1141
- value: string;
1142
- } & {} & {
1143
- commandType?: "object" | "help" | "independent" | undefined;
1144
- object?: string | undefined;
1145
- hoverTooltip?: boolean | undefined;
1146
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1147
- }) | ({
1148
- type: "video";
1149
- value: string;
1150
- } & {} & {
1151
- commandType?: "object" | "help" | "independent" | undefined;
1152
- object?: string | undefined;
1153
- hoverTooltip?: boolean | undefined;
1154
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1155
- }) | ({
1156
- type: "helpdoc";
1157
- value: string;
1158
- } & {
1159
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1160
- doc_metadata?: {
1161
- content_type?: string | undefined;
1162
- date?: string | undefined;
1163
- } | undefined;
1164
- } & {
1165
- doc_type?: "answer" | "doc" | undefined;
1166
- } & {} & {
1167
- commandType?: "object" | "help" | "independent" | undefined;
1168
- object?: string | undefined;
1169
- hoverTooltip?: boolean | undefined;
1170
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1171
- }) | ({
1172
- type: "trigger";
1173
- value: any;
1174
- } & {} & {
1175
- commandType?: "object" | "help" | "independent" | undefined;
1176
- object?: string | undefined;
1177
- hoverTooltip?: boolean | undefined;
1178
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1179
- });
1180
- } & {
1181
- disabledReason?: string | undefined;
1182
- source?: string | undefined;
1183
- name?: string | undefined;
1184
- last_available?: string | null | undefined;
1185
- modified?: string | undefined;
1186
- isAsync?: boolean | undefined;
1187
- } & {
1188
- arguments: {
1189
- [x: string]: ({
1190
- type: "context";
1191
- value: string;
1192
- order_key: number;
1193
- } & {
1194
- label?: string | undefined;
1195
- chosen?: string | number | undefined;
1196
- selected?: any[] | undefined;
1197
- input_type?: string | undefined;
1198
- preselected_key?: string | undefined;
1199
- label_field?: string | undefined;
1200
- loaded?: any[] | undefined;
1201
- allow_create?: boolean | undefined;
1202
- allow_create_label?: string | undefined;
1203
- show_in_record_action_list?: boolean | undefined;
1204
- show_in_default_list?: boolean | undefined;
1205
- auto_choose?: boolean | undefined;
1206
- is_private?: boolean | undefined;
1207
- }) | ({
1208
- type: "set";
1209
- value: string[] | number[] | {
1210
- [key: string]: unknown;
1211
- }[];
1212
- order_key: number;
1213
- } & {
1214
- label?: string | undefined;
1215
- chosen?: string | number | undefined;
1216
- selected?: any[] | undefined;
1217
- input_type?: string | undefined;
1218
- preselected_key?: string | undefined;
1219
- label_field?: string | undefined;
1220
- loaded?: any[] | undefined;
1221
- allow_create?: boolean | undefined;
1222
- allow_create_label?: string | undefined;
1223
- auto_choose?: boolean | undefined;
1224
- is_private?: boolean | undefined;
1225
- }) | ({
1226
- type: "provided";
1227
- value: "time" | "text";
1228
- order_key: number;
1229
- } & {
1230
- label?: string | undefined;
1231
- chosen?: string | number | undefined;
1232
- selected?: any[] | undefined;
1233
- input_type?: string | undefined;
1234
- preselected_key?: string | undefined;
1235
- label_field?: string | undefined;
1236
- loaded?: any[] | undefined;
1237
- dateTimeArgumentTypeId?: number | undefined;
1238
- allow_create?: boolean | undefined;
1239
- allow_create_label?: string | undefined;
1240
- auto_choose?: boolean | undefined;
1241
- is_private?: boolean | undefined;
1242
- }) | ({
1243
- type: "html" | "video";
1244
- value: {
1245
- source: string;
1246
- } & {
1247
- title?: string | undefined;
1248
- description?: string | undefined;
1249
- url?: string | undefined;
1250
- };
1251
- order_key: number;
1252
- } & {
1253
- label?: string | undefined;
1254
- chosen?: string | number | undefined;
1255
- selected?: any[] | undefined;
1256
- input_type?: string | undefined;
1257
- preselected_key?: string | undefined;
1258
- label_field?: string | undefined;
1259
- loaded?: any[] | undefined;
1260
- allow_create?: boolean | undefined;
1261
- allow_create_label?: string | undefined;
1262
- is_private?: boolean | undefined;
1263
- auto_choose?: boolean | undefined;
1264
- });
1265
- };
1266
- tags: string[];
1267
- availability_rules: ({
1268
- type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
1269
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
1270
- } & {
1271
- field?: string | undefined;
1272
- value?: string | undefined;
1273
- reason?: string | undefined;
1274
- rule_id?: string | number | undefined;
1275
- })[];
1276
- recommend_rules: (({
1277
- type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
1278
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
1279
- } & {
1280
- field?: string | undefined;
1281
- value?: string | undefined;
1282
- reason?: string | undefined;
1283
- rule_id?: string | number | undefined;
1284
- }) | ({
1285
- type: "always";
1286
- } & {
1287
- operator?: null | undefined;
1288
- field?: null | undefined;
1289
- value?: null | undefined;
1290
- reason?: null | undefined;
1291
- rule_id?: string | number | undefined;
1292
- }))[];
1293
- availability_expression: import("./helpers/rules").RuleExpression | null;
1294
- recommend_expression: import("./helpers/rules").RuleExpression | null;
1295
- always_recommend: boolean;
1296
- confirm: string;
1297
- shortcut: string[];
1298
- explanation: string;
1299
- heading: string;
1300
- is_live: boolean;
1301
- category: number | null;
1302
- sort_key: number | null;
1303
- icon: string | null;
1304
- icon_color: string | null;
1305
- image_color: string | null;
1306
- image: string | null;
1307
- celebrate: boolean | {
1308
- angle?: number | undefined;
1309
- spread?: number | undefined;
1310
- width?: string | undefined;
1311
- height?: string | undefined;
1312
- duration?: number | undefined;
1313
- dragFriction?: number | undefined;
1314
- stagger?: number | undefined;
1315
- startVelocity?: number | undefined;
1316
- elementCount?: number | undefined;
1317
- decay?: number | undefined;
1318
- colors?: string[] | undefined;
1319
- random?: any;
1320
- } | null;
1321
- recommend_sort_key: number | null;
1322
- shortcut_mac: string[];
1323
- shortcut_win: string[];
1324
- hotkey_mac: string;
1325
- hotkey_win: string;
1326
- detail: string | ({
1327
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1328
- value: string;
1329
- } & {
1330
- position?: "inline" | "popover" | undefined;
1331
- }) | (string | ({
1332
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1333
- value: string;
1334
- } & {
1335
- position?: "inline" | "popover" | undefined;
1336
- }))[] | null;
1337
- content: string | ({
1338
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1339
- value: string;
1340
- } & {
1341
- position?: "inline" | "popover" | undefined;
1342
- }) | (string | ({
1343
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1344
- value: string;
1345
- } & {
1346
- position?: "inline" | "popover" | undefined;
1347
- }))[] | null;
1348
- show_preview: boolean;
1349
- next_steps: (string | number | {
1350
- cta: string;
1351
- action: {
1352
- type: "execute_command";
1353
- meta: {
1354
- command: string;
1355
- };
1356
- } | {
1357
- type: "no_action";
1358
- } | {
1359
- type: "click";
1360
- value: string;
1361
- } | ({
1362
- type: "link";
1363
- value: string;
1364
- } & {
1365
- operation?: "self" | "router" | "blank" | undefined;
1366
- }) | {
1367
- type: "open_chat";
1368
- meta: {
1369
- type: string;
1370
- };
1371
- } | {
1372
- type: "dismiss";
1373
- };
1374
- })[];
1375
- extra: string | null;
1376
- thumbnail: {
1377
- src: string;
1378
- file_name: string;
1379
- size: string;
1380
- } | null;
1381
- } & {
1382
- third_party_source?: string | null | undefined;
1383
- third_party_id?: string | null | undefined;
1384
- training_only?: boolean | undefined;
1385
- }, any>;
1386
- }>]>;
1387
- }>;
1388
- }>, t.TypeC<{
1389
- uuid: t.UnionC<[t.NullC, t.StringC]>;
1390
- error: t.StringC;
1391
- incomplete: t.BooleanC;
1392
- no_answer: t.BooleanC;
1393
- used_fallback: t.BooleanC;
1394
- feedback: t.UnionC<[t.NullC, t.TypeC<{
1395
- rating: t.UnionC<[t.LiteralC<-1>, t.LiteralC<0>, t.LiteralC<1>]>;
1396
- }>]>;
1397
- continuations: t.UnionC<[t.NullC, t.ArrayC<t.StringC>]>;
1398
- fallback_ctas: t.UnionC<[t.NullC, t.ArrayC<t.StringC>]>;
1399
- message_type: t.LiteralC<"USER">;
1400
- value: t.TypeC<{
1401
- question: t.StringC;
1402
- command_ids: t.ArrayC<t.NumberC>;
1403
- }>;
1404
- }>, t.TypeC<{
1405
- uuid: t.UnionC<[t.NullC, t.StringC]>;
1406
- error: t.StringC;
1407
- incomplete: t.BooleanC;
1408
- no_answer: t.BooleanC;
1409
- used_fallback: t.BooleanC;
1410
- feedback: t.UnionC<[t.NullC, t.TypeC<{
1411
- rating: t.UnionC<[t.LiteralC<-1>, t.LiteralC<0>, t.LiteralC<1>]>;
1412
- }>]>;
1413
- continuations: t.UnionC<[t.NullC, t.ArrayC<t.StringC>]>;
1414
- fallback_ctas: t.UnionC<[t.NullC, t.ArrayC<t.StringC>]>;
1415
- message_type: t.LiteralC<"CONTINUATION">;
1416
- value: t.AnyC;
1417
- }>, t.TypeC<{
1418
- uuid: t.UnionC<[t.NullC, t.StringC]>;
1419
- error: t.StringC;
1420
- incomplete: t.BooleanC;
1421
- no_answer: t.BooleanC;
1422
- used_fallback: t.BooleanC;
1423
- feedback: t.UnionC<[t.NullC, t.TypeC<{
1424
- rating: t.UnionC<[t.LiteralC<-1>, t.LiteralC<0>, t.LiteralC<1>]>;
1425
- }>]>;
1426
- continuations: t.UnionC<[t.NullC, t.ArrayC<t.StringC>]>;
1427
- fallback_ctas: t.UnionC<[t.NullC, t.ArrayC<t.StringC>]>;
1428
- message_type: t.LiteralC<"ANSWER">;
1429
- value: t.AnyC;
1430
- }>]>;
1431
- export declare const ChatAnalyticsV: t.TypeC<{
1432
- total_count: t.NumberC;
1433
- current_count: t.NumberC;
1434
- next: t.UnionC<[t.NullC, t.NumberC]>;
1435
- previous: t.UnionC<[t.NullC, t.NumberC]>;
1436
- chat_id_found: t.BooleanC;
1437
- results: t.ArrayC<t.TypeC<{
1438
- id: t.StringC;
1439
- messages: t.ArrayC<t.UnionC<[t.TypeC<{
1440
- uuid: t.UnionC<[t.NullC, t.StringC]>;
1441
- error: t.StringC;
1442
- incomplete: t.BooleanC;
1443
- no_answer: t.BooleanC;
1444
- used_fallback: t.BooleanC;
1445
- feedback: t.UnionC<[t.NullC, t.TypeC<{
1446
- rating: t.UnionC<[t.LiteralC<-1>, t.LiteralC<0>, t.LiteralC<1>]>;
1447
- }>]>;
1448
- continuations: t.UnionC<[t.NullC, t.ArrayC<t.StringC>]>;
1449
- fallback_ctas: t.UnionC<[t.NullC, t.ArrayC<t.StringC>]>;
1450
- message_type: t.LiteralC<"AI">;
1451
- value: t.TypeC<{
1452
- chat_id: t.StringC;
1453
- answer: t.StringC;
1454
- command_id: t.UnionC<[t.NullC, t.NumberC]>;
1455
- command_title: t.UnionC<[t.NullC, t.StringC]>;
1456
- passage_id: t.UnionC<[t.NullC, t.NumberC]>;
1457
- message_id: t.UnionC<[t.NullC, t.NumberC]>;
1458
- doc: t.UnionC<[t.NullC, t.TypeC<{
1459
- title: t.StringC;
1460
- excerpt: t.StringC;
1461
- content: t.StringC;
1462
- command: t.Type<{
1463
- id: number;
1464
- organization: string | number;
1465
- text: string;
1466
- template: ({
1467
- type: "admin";
1468
- value: string;
1469
- } & {} & {
1470
- commandType?: "object" | "help" | "independent" | undefined;
1471
- object?: string | undefined;
1472
- hoverTooltip?: boolean | undefined;
1473
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1474
- }) | ({
1475
- type: "callback";
1476
- value: string;
1477
- } & {} & {
1478
- commandType?: "object" | "help" | "independent" | undefined;
1479
- object?: string | undefined;
1480
- hoverTooltip?: boolean | undefined;
1481
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1482
- }) | ({
1483
- type: "link";
1484
- value: string;
1485
- } & {
1486
- operation?: "self" | "router" | "blank" | undefined;
1487
- } & {} & {
1488
- commandType?: "object" | "help" | "independent" | undefined;
1489
- object?: string | undefined;
1490
- hoverTooltip?: boolean | undefined;
1491
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1492
- }) | ({
1493
- type: "click" | "clickByXpath" | "clickBySelector";
1494
- value: string[];
1495
- } & {} & {
1496
- commandType?: "object" | "help" | "independent" | undefined;
1497
- object?: string | undefined;
1498
- hoverTooltip?: boolean | undefined;
1499
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1500
- }) | ({
1501
- type: "builtin";
1502
- value: string;
1503
- } & {} & {
1504
- commandType?: "object" | "help" | "independent" | undefined;
1505
- object?: string | undefined;
1506
- hoverTooltip?: boolean | undefined;
1507
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1508
- }) | ({
1509
- type: "webhook";
1510
- value: string;
1511
- } & {} & {
1512
- commandType?: "object" | "help" | "independent" | undefined;
1513
- object?: string | undefined;
1514
- hoverTooltip?: boolean | undefined;
1515
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1516
- }) | ({
1517
- type: "script";
1518
- value: string;
1519
- } & {} & {
1520
- commandType?: "object" | "help" | "independent" | undefined;
1521
- object?: string | undefined;
1522
- hoverTooltip?: boolean | undefined;
1523
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1524
- }) | ({
1525
- type: "request";
1526
- value: {
1527
- method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
1528
- url: string;
1529
- } & {
1530
- headers?: {
1531
- [key: string]: unknown;
1532
- } | undefined;
1533
- body?: {
1534
- [key: string]: unknown;
1535
- } | undefined;
1536
- onSend?: string | undefined;
1537
- onSuccess?: string | undefined;
1538
- onError?: string | undefined;
1539
- };
1540
- } & {} & {
1541
- commandType?: "object" | "help" | "independent" | undefined;
1542
- object?: string | undefined;
1543
- hoverTooltip?: boolean | undefined;
1544
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1545
- }) | ({
1546
- type: "appcues";
1547
- value: string;
1548
- } & {} & {
1549
- commandType?: "object" | "help" | "independent" | undefined;
1550
- object?: string | undefined;
1551
- hoverTooltip?: boolean | undefined;
1552
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1553
- }) | ({
1554
- type: "video";
1555
- value: string;
1556
- } & {} & {
1557
- commandType?: "object" | "help" | "independent" | undefined;
1558
- object?: string | undefined;
1559
- hoverTooltip?: boolean | undefined;
1560
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1561
- }) | ({
1562
- type: "helpdoc";
1563
- value: string;
1564
- } & {
1565
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1566
- doc_metadata?: {
1567
- content_type?: string | undefined;
1568
- date?: string | undefined;
1569
- } | undefined;
1570
- } & {
1571
- doc_type?: "answer" | "doc" | undefined;
1572
- } & {} & {
1573
- commandType?: "object" | "help" | "independent" | undefined;
1574
- object?: string | undefined;
1575
- hoverTooltip?: boolean | undefined;
1576
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1577
- }) | ({
1578
- type: "trigger";
1579
- value: any;
1580
- } & {} & {
1581
- commandType?: "object" | "help" | "independent" | undefined;
1582
- object?: string | undefined;
1583
- hoverTooltip?: boolean | undefined;
1584
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1585
- });
1586
- } & {
1587
- disabledReason?: string | undefined;
1588
- source?: string | undefined;
1589
- name?: string | undefined;
1590
- last_available?: string | null | undefined;
1591
- modified?: string | undefined;
1592
- isAsync?: boolean | undefined;
1593
- } & {
1594
- arguments: {
1595
- [x: string]: ({
1596
- type: "context";
1597
- value: string;
1598
- order_key: number;
1599
- } & {
1600
- label?: string | undefined;
1601
- chosen?: string | number | undefined;
1602
- selected?: any[] | undefined;
1603
- input_type?: string | undefined;
1604
- preselected_key?: string | undefined;
1605
- label_field?: string | undefined;
1606
- loaded?: any[] | undefined;
1607
- allow_create?: boolean | undefined;
1608
- allow_create_label?: string | undefined;
1609
- show_in_record_action_list?: boolean | undefined;
1610
- show_in_default_list?: boolean | undefined;
1611
- auto_choose?: boolean | undefined;
1612
- is_private?: boolean | undefined;
1613
- }) | ({
1614
- type: "set";
1615
- value: string[] | number[] | {
1616
- [key: string]: unknown;
1617
- }[];
1618
- order_key: number;
1619
- } & {
1620
- label?: string | undefined;
1621
- chosen?: string | number | undefined;
1622
- selected?: any[] | undefined;
1623
- input_type?: string | undefined;
1624
- preselected_key?: string | undefined;
1625
- label_field?: string | undefined;
1626
- loaded?: any[] | undefined;
1627
- allow_create?: boolean | undefined;
1628
- allow_create_label?: string | undefined;
1629
- auto_choose?: boolean | undefined;
1630
- is_private?: boolean | undefined;
1631
- }) | ({
1632
- type: "provided";
1633
- value: "time" | "text";
1634
- order_key: number;
1635
- } & {
1636
- label?: string | undefined;
1637
- chosen?: string | number | undefined;
1638
- selected?: any[] | undefined;
1639
- input_type?: string | undefined;
1640
- preselected_key?: string | undefined;
1641
- label_field?: string | undefined;
1642
- loaded?: any[] | undefined;
1643
- dateTimeArgumentTypeId?: number | undefined;
1644
- allow_create?: boolean | undefined;
1645
- allow_create_label?: string | undefined;
1646
- auto_choose?: boolean | undefined;
1647
- is_private?: boolean | undefined;
1648
- }) | ({
1649
- type: "html" | "video";
1650
- value: {
1651
- source: string;
1652
- } & {
1653
- title?: string | undefined;
1654
- description?: string | undefined;
1655
- url?: string | undefined;
1656
- };
1657
- order_key: number;
1658
- } & {
1659
- label?: string | undefined;
1660
- chosen?: string | number | undefined;
1661
- selected?: any[] | undefined;
1662
- input_type?: string | undefined;
1663
- preselected_key?: string | undefined;
1664
- label_field?: string | undefined;
1665
- loaded?: any[] | undefined;
1666
- allow_create?: boolean | undefined;
1667
- allow_create_label?: string | undefined;
1668
- is_private?: boolean | undefined;
1669
- auto_choose?: boolean | undefined;
1670
- });
1671
- };
1672
- tags: string[];
1673
- availability_rules: ({
1674
- type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
1675
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
1676
- } & {
1677
- field?: string | undefined;
1678
- value?: string | undefined;
1679
- reason?: string | undefined;
1680
- rule_id?: string | number | undefined;
1681
- })[];
1682
- recommend_rules: (({
1683
- type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
1684
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
1685
- } & {
1686
- field?: string | undefined;
1687
- value?: string | undefined;
1688
- reason?: string | undefined;
1689
- rule_id?: string | number | undefined;
1690
- }) | ({
1691
- type: "always";
1692
- } & {
1693
- operator?: null | undefined;
1694
- field?: null | undefined;
1695
- value?: null | undefined;
1696
- reason?: null | undefined;
1697
- rule_id?: string | number | undefined;
1698
- }))[];
1699
- availability_expression: import("./helpers/rules").RuleExpression | null;
1700
- recommend_expression: import("./helpers/rules").RuleExpression | null;
1701
- always_recommend: boolean;
1702
- confirm: string;
1703
- shortcut: string[];
1704
- explanation: string;
1705
- heading: string;
1706
- is_live: boolean;
1707
- category: number | null;
1708
- sort_key: number | null;
1709
- icon: string | null;
1710
- icon_color: string | null;
1711
- image_color: string | null;
1712
- image: string | null;
1713
- celebrate: boolean | {
1714
- angle?: number | undefined;
1715
- spread?: number | undefined;
1716
- width?: string | undefined;
1717
- height?: string | undefined;
1718
- duration?: number | undefined;
1719
- dragFriction?: number | undefined;
1720
- stagger?: number | undefined;
1721
- startVelocity?: number | undefined;
1722
- elementCount?: number | undefined;
1723
- decay?: number | undefined;
1724
- colors?: string[] | undefined;
1725
- random?: any;
1726
- } | null;
1727
- recommend_sort_key: number | null;
1728
- shortcut_mac: string[];
1729
- shortcut_win: string[];
1730
- hotkey_mac: string;
1731
- hotkey_win: string;
1732
- detail: string | ({
1733
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1734
- value: string;
1735
- } & {
1736
- position?: "inline" | "popover" | undefined;
1737
- }) | (string | ({
1738
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1739
- value: string;
1740
- } & {
1741
- position?: "inline" | "popover" | undefined;
1742
- }))[] | null;
1743
- content: string | ({
1744
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1745
- value: string;
1746
- } & {
1747
- position?: "inline" | "popover" | undefined;
1748
- }) | (string | ({
1749
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
1750
- value: string;
1751
- } & {
1752
- position?: "inline" | "popover" | undefined;
1753
- }))[] | null;
1754
- show_preview: boolean;
1755
- next_steps: (string | number | {
1756
- cta: string;
1757
- action: {
1758
- type: "execute_command";
1759
- meta: {
1760
- command: string;
1761
- };
1762
- } | {
1763
- type: "no_action";
1764
- } | {
1765
- type: "click";
1766
- value: string;
1767
- } | ({
1768
- type: "link";
1769
- value: string;
1770
- } & {
1771
- operation?: "self" | "router" | "blank" | undefined;
1772
- }) | {
1773
- type: "open_chat";
1774
- meta: {
1775
- type: string;
1776
- };
1777
- } | {
1778
- type: "dismiss";
1779
- };
1780
- })[];
1781
- extra: string | null;
1782
- thumbnail: {
1783
- src: string;
1784
- file_name: string;
1785
- size: string;
1786
- } | null;
1787
- } & {
1788
- third_party_source?: string | null | undefined;
1789
- third_party_id?: string | null | undefined;
1790
- training_only?: boolean | undefined;
1791
- }, {
1792
- id: number;
1793
- organization: string | number;
1794
- text: string;
1795
- template: ({
1796
- type: "admin";
1797
- value: string;
1798
- } & {} & {
1799
- commandType?: "object" | "help" | "independent" | undefined;
1800
- object?: string | undefined;
1801
- hoverTooltip?: boolean | undefined;
1802
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1803
- }) | ({
1804
- type: "callback";
1805
- value: string;
1806
- } & {} & {
1807
- commandType?: "object" | "help" | "independent" | undefined;
1808
- object?: string | undefined;
1809
- hoverTooltip?: boolean | undefined;
1810
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1811
- }) | ({
1812
- type: "link";
1813
- value: string;
1814
- } & {
1815
- operation?: "self" | "router" | "blank" | undefined;
1816
- } & {} & {
1817
- commandType?: "object" | "help" | "independent" | undefined;
1818
- object?: string | undefined;
1819
- hoverTooltip?: boolean | undefined;
1820
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1821
- }) | ({
1822
- type: "click" | "clickByXpath" | "clickBySelector";
1823
- value: string[];
1824
- } & {} & {
1825
- commandType?: "object" | "help" | "independent" | undefined;
1826
- object?: string | undefined;
1827
- hoverTooltip?: boolean | undefined;
1828
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1829
- }) | ({
1830
- type: "builtin";
1831
- value: string;
1832
- } & {} & {
1833
- commandType?: "object" | "help" | "independent" | undefined;
1834
- object?: string | undefined;
1835
- hoverTooltip?: boolean | undefined;
1836
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1837
- }) | ({
1838
- type: "webhook";
1839
- value: string;
1840
- } & {} & {
1841
- commandType?: "object" | "help" | "independent" | undefined;
1842
- object?: string | undefined;
1843
- hoverTooltip?: boolean | undefined;
1844
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1845
- }) | ({
1846
- type: "script";
1847
- value: string;
1848
- } & {} & {
1849
- commandType?: "object" | "help" | "independent" | undefined;
1850
- object?: string | undefined;
1851
- hoverTooltip?: boolean | undefined;
1852
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1853
- }) | ({
1854
- type: "request";
1855
- value: {
1856
- method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
1857
- url: string;
1858
- } & {
1859
- headers?: {
1860
- [key: string]: unknown;
1861
- } | undefined;
1862
- body?: {
1863
- [key: string]: unknown;
1864
- } | undefined;
1865
- onSend?: string | undefined;
1866
- onSuccess?: string | undefined;
1867
- onError?: string | undefined;
1868
- };
1869
- } & {} & {
1870
- commandType?: "object" | "help" | "independent" | undefined;
1871
- object?: string | undefined;
1872
- hoverTooltip?: boolean | undefined;
1873
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1874
- }) | ({
1875
- type: "appcues";
1876
- value: string;
1877
- } & {} & {
1878
- commandType?: "object" | "help" | "independent" | undefined;
1879
- object?: string | undefined;
1880
- hoverTooltip?: boolean | undefined;
1881
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1882
- }) | ({
1883
- type: "video";
1884
- value: string;
1885
- } & {} & {
1886
- commandType?: "object" | "help" | "independent" | undefined;
1887
- object?: string | undefined;
1888
- hoverTooltip?: boolean | undefined;
1889
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1890
- }) | ({
1891
- type: "helpdoc";
1892
- value: string;
1893
- } & {
1894
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1895
- doc_metadata?: {
1896
- content_type?: string | undefined;
1897
- date?: string | undefined;
1898
- } | undefined;
1899
- } & {
1900
- doc_type?: "answer" | "doc" | undefined;
1901
- } & {} & {
1902
- commandType?: "object" | "help" | "independent" | undefined;
1903
- object?: string | undefined;
1904
- hoverTooltip?: boolean | undefined;
1905
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1906
- }) | ({
1907
- type: "trigger";
1908
- value: any;
1909
- } & {} & {
1910
- commandType?: "object" | "help" | "independent" | undefined;
1911
- object?: string | undefined;
1912
- hoverTooltip?: boolean | undefined;
1913
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
1914
- });
1915
- } & {
1916
- disabledReason?: string | undefined;
1917
- source?: string | undefined;
1918
- name?: string | undefined;
1919
- last_available?: string | null | undefined;
1920
- modified?: string | undefined;
1921
- isAsync?: boolean | undefined;
1922
- } & {
1923
- arguments: {
1924
- [x: string]: ({
1925
- type: "context";
1926
- value: string;
1927
- order_key: number;
1928
- } & {
1929
- label?: string | undefined;
1930
- chosen?: string | number | undefined;
1931
- selected?: any[] | undefined;
1932
- input_type?: string | undefined;
1933
- preselected_key?: string | undefined;
1934
- label_field?: string | undefined;
1935
- loaded?: any[] | undefined;
1936
- allow_create?: boolean | undefined;
1937
- allow_create_label?: string | undefined;
1938
- show_in_record_action_list?: boolean | undefined;
1939
- show_in_default_list?: boolean | undefined;
1940
- auto_choose?: boolean | undefined;
1941
- is_private?: boolean | undefined;
1942
- }) | ({
1943
- type: "set";
1944
- value: string[] | number[] | {
1945
- [key: string]: unknown;
1946
- }[];
1947
- order_key: number;
1948
- } & {
1949
- label?: string | undefined;
1950
- chosen?: string | number | undefined;
1951
- selected?: any[] | undefined;
1952
- input_type?: string | undefined;
1953
- preselected_key?: string | undefined;
1954
- label_field?: string | undefined;
1955
- loaded?: any[] | undefined;
1956
- allow_create?: boolean | undefined;
1957
- allow_create_label?: string | undefined;
1958
- auto_choose?: boolean | undefined;
1959
- is_private?: boolean | undefined;
1960
- }) | ({
1961
- type: "provided";
1962
- value: "time" | "text";
1963
- order_key: number;
1964
- } & {
1965
- label?: string | undefined;
1966
- chosen?: string | number | undefined;
1967
- selected?: any[] | undefined;
1968
- input_type?: string | undefined;
1969
- preselected_key?: string | undefined;
1970
- label_field?: string | undefined;
1971
- loaded?: any[] | undefined;
1972
- dateTimeArgumentTypeId?: number | undefined;
1973
- allow_create?: boolean | undefined;
1974
- allow_create_label?: string | undefined;
1975
- auto_choose?: boolean | undefined;
1976
- is_private?: boolean | undefined;
1977
- }) | ({
1978
- type: "html" | "video";
1979
- value: {
1980
- source: string;
1981
- } & {
1982
- title?: string | undefined;
1983
- description?: string | undefined;
1984
- url?: string | undefined;
1985
- };
1986
- order_key: number;
1987
- } & {
1988
- label?: string | undefined;
1989
- chosen?: string | number | undefined;
1990
- selected?: any[] | undefined;
1991
- input_type?: string | undefined;
1992
- preselected_key?: string | undefined;
1993
- label_field?: string | undefined;
1994
- loaded?: any[] | undefined;
1995
- allow_create?: boolean | undefined;
1996
- allow_create_label?: string | undefined;
1997
- is_private?: boolean | undefined;
1998
- auto_choose?: boolean | undefined;
1999
- });
2000
- };
2001
- tags: string[];
2002
- availability_rules: ({
2003
- type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
2004
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
2005
- } & {
2006
- field?: string | undefined;
2007
- value?: string | undefined;
2008
- reason?: string | undefined;
2009
- rule_id?: string | number | undefined;
2010
- })[];
2011
- recommend_rules: (({
2012
- type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
2013
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
2014
- } & {
2015
- field?: string | undefined;
2016
- value?: string | undefined;
2017
- reason?: string | undefined;
2018
- rule_id?: string | number | undefined;
2019
- }) | ({
2020
- type: "always";
2021
- } & {
2022
- operator?: null | undefined;
2023
- field?: null | undefined;
2024
- value?: null | undefined;
2025
- reason?: null | undefined;
2026
- rule_id?: string | number | undefined;
2027
- }))[];
2028
- availability_expression: import("./helpers/rules").RuleExpression | null;
2029
- recommend_expression: import("./helpers/rules").RuleExpression | null;
2030
- always_recommend: boolean;
2031
- confirm: string;
2032
- shortcut: string[];
2033
- explanation: string;
2034
- heading: string;
2035
- is_live: boolean;
2036
- category: number | null;
2037
- sort_key: number | null;
2038
- icon: string | null;
2039
- icon_color: string | null;
2040
- image_color: string | null;
2041
- image: string | null;
2042
- celebrate: boolean | {
2043
- angle?: number | undefined;
2044
- spread?: number | undefined;
2045
- width?: string | undefined;
2046
- height?: string | undefined;
2047
- duration?: number | undefined;
2048
- dragFriction?: number | undefined;
2049
- stagger?: number | undefined;
2050
- startVelocity?: number | undefined;
2051
- elementCount?: number | undefined;
2052
- decay?: number | undefined;
2053
- colors?: string[] | undefined;
2054
- random?: any;
2055
- } | null;
2056
- recommend_sort_key: number | null;
2057
- shortcut_mac: string[];
2058
- shortcut_win: string[];
2059
- hotkey_mac: string;
2060
- hotkey_win: string;
2061
- detail: string | ({
2062
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
2063
- value: string;
2064
- } & {
2065
- position?: "inline" | "popover" | undefined;
2066
- }) | (string | ({
2067
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
2068
- value: string;
2069
- } & {
2070
- position?: "inline" | "popover" | undefined;
2071
- }))[] | null;
2072
- content: string | ({
2073
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
2074
- value: string;
2075
- } & {
2076
- position?: "inline" | "popover" | undefined;
2077
- }) | (string | ({
2078
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
2079
- value: string;
2080
- } & {
2081
- position?: "inline" | "popover" | undefined;
2082
- }))[] | null;
2083
- show_preview: boolean;
2084
- next_steps: (string | number | {
2085
- cta: string;
2086
- action: {
2087
- type: "execute_command";
2088
- meta: {
2089
- command: string;
2090
- };
2091
- } | {
2092
- type: "no_action";
2093
- } | {
2094
- type: "click";
2095
- value: string;
2096
- } | ({
2097
- type: "link";
2098
- value: string;
2099
- } & {
2100
- operation?: "self" | "router" | "blank" | undefined;
2101
- }) | {
2102
- type: "open_chat";
2103
- meta: {
2104
- type: string;
2105
- };
2106
- } | {
2107
- type: "dismiss";
2108
- };
2109
- })[];
2110
- extra: string | null;
2111
- thumbnail: {
2112
- src: string;
2113
- file_name: string;
2114
- size: string;
2115
- } | null;
2116
- } & {
2117
- third_party_source?: string | null | undefined;
2118
- third_party_id?: string | null | undefined;
2119
- training_only?: boolean | undefined;
2120
- }, any>;
2121
- }>]>;
2122
- }>;
2123
- }>, t.TypeC<{
2124
- uuid: t.UnionC<[t.NullC, t.StringC]>;
2125
- error: t.StringC;
2126
- incomplete: t.BooleanC;
2127
- no_answer: t.BooleanC;
2128
- used_fallback: t.BooleanC;
2129
- feedback: t.UnionC<[t.NullC, t.TypeC<{
2130
- rating: t.UnionC<[t.LiteralC<-1>, t.LiteralC<0>, t.LiteralC<1>]>;
2131
- }>]>;
2132
- continuations: t.UnionC<[t.NullC, t.ArrayC<t.StringC>]>;
2133
- fallback_ctas: t.UnionC<[t.NullC, t.ArrayC<t.StringC>]>;
2134
- message_type: t.LiteralC<"USER">;
2135
- value: t.TypeC<{
2136
- question: t.StringC;
2137
- command_ids: t.ArrayC<t.NumberC>;
2138
- }>;
2139
- }>, t.TypeC<{
2140
- uuid: t.UnionC<[t.NullC, t.StringC]>;
2141
- error: t.StringC;
2142
- incomplete: t.BooleanC;
2143
- no_answer: t.BooleanC;
2144
- used_fallback: t.BooleanC;
2145
- feedback: t.UnionC<[t.NullC, t.TypeC<{
2146
- rating: t.UnionC<[t.LiteralC<-1>, t.LiteralC<0>, t.LiteralC<1>]>;
2147
- }>]>;
2148
- continuations: t.UnionC<[t.NullC, t.ArrayC<t.StringC>]>;
2149
- fallback_ctas: t.UnionC<[t.NullC, t.ArrayC<t.StringC>]>;
2150
- message_type: t.LiteralC<"CONTINUATION">;
2151
- value: t.AnyC;
2152
- }>, t.TypeC<{
2153
- uuid: t.UnionC<[t.NullC, t.StringC]>;
2154
- error: t.StringC;
2155
- incomplete: t.BooleanC;
2156
- no_answer: t.BooleanC;
2157
- used_fallback: t.BooleanC;
2158
- feedback: t.UnionC<[t.NullC, t.TypeC<{
2159
- rating: t.UnionC<[t.LiteralC<-1>, t.LiteralC<0>, t.LiteralC<1>]>;
2160
- }>]>;
2161
- continuations: t.UnionC<[t.NullC, t.ArrayC<t.StringC>]>;
2162
- fallback_ctas: t.UnionC<[t.NullC, t.ArrayC<t.StringC>]>;
2163
- message_type: t.LiteralC<"ANSWER">;
2164
- value: t.AnyC;
2165
- }>]>>;
2166
- created: t.StringC;
2167
- modified: t.StringC;
2168
- context: t.AnyC;
2169
- organization: t.NumberC;
2170
- end_user: t.UnionC<[t.NullC, t.NumberC]>;
2171
- }>>;
2172
- }>;
2173
- export declare class ChatAnalytics {
2174
- static listChats: (params?: Record<string, string> | undefined, callbacks?: {
2175
- onSuccess?: (() => void) | undefined;
2176
- onError?: ((err: string) => void) | undefined;
2177
- } | undefined) => Promise<{
2178
- total_count: number;
2179
- current_count: number;
2180
- next: number | null;
2181
- previous: number | null;
2182
- chat_id_found: boolean;
2183
- results: {
2184
- id: string;
2185
- messages: ({
2186
- uuid: string | null;
2187
- error: string;
2188
- incomplete: boolean;
2189
- no_answer: boolean;
2190
- used_fallback: boolean;
2191
- feedback: {
2192
- rating: 0 | 1 | -1;
2193
- } | null;
2194
- continuations: string[] | null;
2195
- fallback_ctas: string[] | null;
2196
- message_type: "AI";
2197
- value: {
2198
- chat_id: string;
2199
- answer: string;
2200
- command_id: number | null;
2201
- command_title: string | null;
2202
- passage_id: number | null;
2203
- message_id: number | null;
2204
- doc: {
2205
- title: string;
2206
- excerpt: string;
2207
- content: string;
2208
- command: {
2209
- id: number;
2210
- organization: string | number;
2211
- text: string;
2212
- template: ({
2213
- type: "admin";
2214
- value: string;
2215
- } & {} & {
2216
- commandType?: "object" | "help" | "independent" | undefined;
2217
- object?: string | undefined;
2218
- hoverTooltip?: boolean | undefined;
2219
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2220
- }) | ({
2221
- type: "callback";
2222
- value: string;
2223
- } & {} & {
2224
- commandType?: "object" | "help" | "independent" | undefined;
2225
- object?: string | undefined;
2226
- hoverTooltip?: boolean | undefined;
2227
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2228
- }) | ({
2229
- type: "link";
2230
- value: string;
2231
- } & {
2232
- operation?: "self" | "router" | "blank" | undefined;
2233
- } & {} & {
2234
- commandType?: "object" | "help" | "independent" | undefined;
2235
- object?: string | undefined;
2236
- hoverTooltip?: boolean | undefined;
2237
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2238
- }) | ({
2239
- type: "click" | "clickByXpath" | "clickBySelector";
2240
- value: string[];
2241
- } & {} & {
2242
- commandType?: "object" | "help" | "independent" | undefined;
2243
- object?: string | undefined;
2244
- hoverTooltip?: boolean | undefined;
2245
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2246
- }) | ({
2247
- type: "builtin";
2248
- value: string;
2249
- } & {} & {
2250
- commandType?: "object" | "help" | "independent" | undefined;
2251
- object?: string | undefined;
2252
- hoverTooltip?: boolean | undefined;
2253
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2254
- }) | ({
2255
- type: "webhook";
2256
- value: string;
2257
- } & {} & {
2258
- commandType?: "object" | "help" | "independent" | undefined;
2259
- object?: string | undefined;
2260
- hoverTooltip?: boolean | undefined;
2261
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2262
- }) | ({
2263
- type: "script";
2264
- value: string;
2265
- } & {} & {
2266
- commandType?: "object" | "help" | "independent" | undefined;
2267
- object?: string | undefined;
2268
- hoverTooltip?: boolean | undefined;
2269
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2270
- }) | ({
2271
- type: "request";
2272
- value: {
2273
- method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
2274
- url: string;
2275
- } & {
2276
- headers?: {
2277
- [key: string]: unknown;
2278
- } | undefined;
2279
- body?: {
2280
- [key: string]: unknown;
2281
- } | undefined;
2282
- onSend?: string | undefined;
2283
- onSuccess?: string | undefined;
2284
- onError?: string | undefined;
2285
- };
2286
- } & {} & {
2287
- commandType?: "object" | "help" | "independent" | undefined;
2288
- object?: string | undefined;
2289
- hoverTooltip?: boolean | undefined;
2290
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2291
- }) | ({
2292
- type: "appcues";
2293
- value: string;
2294
- } & {} & {
2295
- commandType?: "object" | "help" | "independent" | undefined;
2296
- object?: string | undefined;
2297
- hoverTooltip?: boolean | undefined;
2298
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2299
- }) | ({
2300
- type: "video";
2301
- value: string;
2302
- } & {} & {
2303
- commandType?: "object" | "help" | "independent" | undefined;
2304
- object?: string | undefined;
2305
- hoverTooltip?: boolean | undefined;
2306
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2307
- }) | ({
2308
- type: "helpdoc";
2309
- value: string;
2310
- } & {
2311
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2312
- doc_metadata?: {
2313
- content_type?: string | undefined;
2314
- date?: string | undefined;
2315
- } | undefined;
2316
- } & {
2317
- doc_type?: "answer" | "doc" | undefined;
2318
- } & {} & {
2319
- commandType?: "object" | "help" | "independent" | undefined;
2320
- object?: string | undefined;
2321
- hoverTooltip?: boolean | undefined;
2322
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2323
- }) | ({
2324
- type: "trigger";
2325
- value: any;
2326
- } & {} & {
2327
- commandType?: "object" | "help" | "independent" | undefined;
2328
- object?: string | undefined;
2329
- hoverTooltip?: boolean | undefined;
2330
- operation?: "self" | "router" | "blank" | "help_hub" | undefined;
2331
- });
2332
- } & {
2333
- disabledReason?: string | undefined;
2334
- source?: string | undefined;
2335
- name?: string | undefined;
2336
- last_available?: string | null | undefined;
2337
- modified?: string | undefined;
2338
- isAsync?: boolean | undefined;
2339
- } & {
2340
- arguments: {
2341
- [x: string]: ({
2342
- type: "context";
2343
- value: string;
2344
- order_key: number;
2345
- } & {
2346
- label?: string | undefined;
2347
- chosen?: string | number | undefined;
2348
- selected?: any[] | undefined;
2349
- input_type?: string | undefined;
2350
- preselected_key?: string | undefined;
2351
- label_field?: string | undefined;
2352
- loaded?: any[] | undefined;
2353
- allow_create?: boolean | undefined;
2354
- allow_create_label?: string | undefined;
2355
- show_in_record_action_list?: boolean | undefined;
2356
- show_in_default_list?: boolean | undefined;
2357
- auto_choose?: boolean | undefined;
2358
- is_private?: boolean | undefined;
2359
- }) | ({
2360
- type: "set";
2361
- value: string[] | number[] | {
2362
- [key: string]: unknown;
2363
- }[];
2364
- order_key: number;
2365
- } & {
2366
- label?: string | undefined;
2367
- chosen?: string | number | undefined;
2368
- selected?: any[] | undefined;
2369
- input_type?: string | undefined;
2370
- preselected_key?: string | undefined;
2371
- label_field?: string | undefined;
2372
- loaded?: any[] | undefined;
2373
- allow_create?: boolean | undefined;
2374
- allow_create_label?: string | undefined;
2375
- auto_choose?: boolean | undefined;
2376
- is_private?: boolean | undefined;
2377
- }) | ({
2378
- type: "provided";
2379
- value: "time" | "text";
2380
- order_key: number;
2381
- } & {
2382
- label?: string | undefined;
2383
- chosen?: string | number | undefined;
2384
- selected?: any[] | undefined;
2385
- input_type?: string | undefined;
2386
- preselected_key?: string | undefined;
2387
- label_field?: string | undefined;
2388
- loaded?: any[] | undefined;
2389
- dateTimeArgumentTypeId?: number | undefined;
2390
- allow_create?: boolean | undefined;
2391
- allow_create_label?: string | undefined;
2392
- auto_choose?: boolean | undefined;
2393
- is_private?: boolean | undefined;
2394
- }) | ({
2395
- type: "html" | "video";
2396
- value: {
2397
- source: string;
2398
- } & {
2399
- title?: string | undefined;
2400
- description?: string | undefined;
2401
- url?: string | undefined;
2402
- };
2403
- order_key: number;
2404
- } & {
2405
- label?: string | undefined;
2406
- chosen?: string | number | undefined;
2407
- selected?: any[] | undefined;
2408
- input_type?: string | undefined;
2409
- preselected_key?: string | undefined;
2410
- label_field?: string | undefined;
2411
- loaded?: any[] | undefined;
2412
- allow_create?: boolean | undefined;
2413
- allow_create_label?: string | undefined;
2414
- is_private?: boolean | undefined;
2415
- auto_choose?: boolean | undefined;
2416
- });
2417
- };
2418
- tags: string[];
2419
- availability_rules: ({
2420
- type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
2421
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
2422
- } & {
2423
- field?: string | undefined;
2424
- value?: string | undefined;
2425
- reason?: string | undefined;
2426
- rule_id?: string | number | undefined;
2427
- })[];
2428
- recommend_rules: (({
2429
- type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
2430
- operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
2431
- } & {
2432
- field?: string | undefined;
2433
- value?: string | undefined;
2434
- reason?: string | undefined;
2435
- rule_id?: string | number | undefined;
2436
- }) | ({
2437
- type: "always";
2438
- } & {
2439
- operator?: null | undefined;
2440
- field?: null | undefined;
2441
- value?: null | undefined;
2442
- reason?: null | undefined;
2443
- rule_id?: string | number | undefined;
2444
- }))[];
2445
- availability_expression: import("./helpers/rules").RuleExpression | null;
2446
- recommend_expression: import("./helpers/rules").RuleExpression | null;
2447
- always_recommend: boolean;
2448
- confirm: string;
2449
- shortcut: string[];
2450
- explanation: string;
2451
- heading: string;
2452
- is_live: boolean;
2453
- category: number | null;
2454
- sort_key: number | null;
2455
- icon: string | null;
2456
- icon_color: string | null;
2457
- image_color: string | null;
2458
- image: string | null;
2459
- celebrate: boolean | {
2460
- angle?: number | undefined;
2461
- spread?: number | undefined;
2462
- width?: string | undefined;
2463
- height?: string | undefined;
2464
- duration?: number | undefined;
2465
- dragFriction?: number | undefined;
2466
- stagger?: number | undefined;
2467
- startVelocity?: number | undefined;
2468
- elementCount?: number | undefined;
2469
- decay?: number | undefined;
2470
- colors?: string[] | undefined;
2471
- random?: any;
2472
- } | null;
2473
- recommend_sort_key: number | null;
2474
- shortcut_mac: string[];
2475
- shortcut_win: string[];
2476
- hotkey_mac: string;
2477
- hotkey_win: string;
2478
- detail: string | ({
2479
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
2480
- value: string;
2481
- } & {
2482
- position?: "inline" | "popover" | undefined;
2483
- }) | (string | ({
2484
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
2485
- value: string;
2486
- } & {
2487
- position?: "inline" | "popover" | undefined;
2488
- }))[] | null;
2489
- content: string | ({
2490
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
2491
- value: string;
2492
- } & {
2493
- position?: "inline" | "popover" | undefined;
2494
- }) | (string | ({
2495
- type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
2496
- value: string;
2497
- } & {
2498
- position?: "inline" | "popover" | undefined;
2499
- }))[] | null;
2500
- show_preview: boolean;
2501
- next_steps: (string | number | {
2502
- cta: string;
2503
- action: {
2504
- type: "execute_command";
2505
- meta: {
2506
- command: string;
2507
- };
2508
- } | {
2509
- type: "no_action";
2510
- } | {
2511
- type: "click";
2512
- value: string;
2513
- } | ({
2514
- type: "link";
2515
- value: string;
2516
- } & {
2517
- operation?: "self" | "router" | "blank" | undefined;
2518
- }) | {
2519
- type: "open_chat";
2520
- meta: {
2521
- type: string;
2522
- };
2523
- } | {
2524
- type: "dismiss";
2525
- };
2526
- })[];
2527
- extra: string | null;
2528
- thumbnail: {
2529
- src: string;
2530
- file_name: string;
2531
- size: string;
2532
- } | null;
2533
- } & {
2534
- third_party_source?: string | null | undefined;
2535
- third_party_id?: string | null | undefined;
2536
- training_only?: boolean | undefined;
2537
- };
2538
- } | null;
2539
- };
2540
- } | {
2541
- uuid: string | null;
2542
- error: string;
2543
- incomplete: boolean;
2544
- no_answer: boolean;
2545
- used_fallback: boolean;
2546
- feedback: {
2547
- rating: 0 | 1 | -1;
2548
- } | null;
2549
- continuations: string[] | null;
2550
- fallback_ctas: string[] | null;
2551
- message_type: "USER";
2552
- value: {
2553
- question: string;
2554
- command_ids: number[];
2555
- };
2556
- } | {
2557
- uuid: string | null;
2558
- error: string;
2559
- incomplete: boolean;
2560
- no_answer: boolean;
2561
- used_fallback: boolean;
2562
- feedback: {
2563
- rating: 0 | 1 | -1;
2564
- } | null;
2565
- continuations: string[] | null;
2566
- fallback_ctas: string[] | null;
2567
- message_type: "CONTINUATION";
2568
- value: any;
2569
- } | {
2570
- uuid: string | null;
2571
- error: string;
2572
- incomplete: boolean;
2573
- no_answer: boolean;
2574
- used_fallback: boolean;
2575
- feedback: {
2576
- rating: 0 | 1 | -1;
2577
- } | null;
2578
- continuations: string[] | null;
2579
- fallback_ctas: string[] | null;
2580
- message_type: "ANSWER";
2581
- value: any;
2582
- })[];
2583
- created: string;
2584
- modified: string;
2585
- context: any;
2586
- organization: number;
2587
- end_user: number | null;
2588
- }[];
2589
- }>;
2590
- static getSummary: (params?: Record<string, string> | undefined, callbacks?: {
2591
- onSuccess?: (() => void) | undefined;
2592
- onError?: ((err: string) => void) | undefined;
2593
- } | undefined) => Promise<{
2594
- total_chats: number;
2595
- total_chats_change: number;
2596
- unique_end_users: number;
2597
- unique_end_users_change: number;
2598
- percent_chats_without_fallback: number;
2599
- percent_chats_without_fallback_change: number;
2600
- }>;
2601
- }