commandbar 1.8.7 → 1.10.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (61) hide show
  1. package/build/{internal/src/client → commandbar/src/shared/services/analytics}/EventHandler.d.ts +51 -15
  2. package/build/commandbar/src/shared/services/analytics/types.d.ts +77 -0
  3. package/build/commandbar-js/src/index.d.ts +2 -2
  4. package/build/commandbar-js/src/index.js +1 -1
  5. package/build/internal/src/client/AddContextOptions.d.ts +8 -0
  6. package/build/internal/src/client/CommandBarClientSDK.d.ts +70 -19
  7. package/build/internal/src/client/CommandBarProxySDK.d.ts +3 -3
  8. package/build/internal/src/client/CommandBarSDK.d.ts +34 -18
  9. package/build/internal/src/client/SDKConfig.d.ts +3 -2
  10. package/build/internal/src/client/globals.d.ts +6 -0
  11. package/build/internal/src/client/symbols.d.ts +13 -6
  12. package/build/internal/src/middleware/CommandFromClientV.d.ts +88 -18
  13. package/build/internal/src/middleware/IRecordSettings.d.ts +3 -0
  14. package/build/internal/src/middleware/OrganizationV.d.ts +320 -22
  15. package/build/internal/src/middleware/{ResourceSettingsV.d.ts → RecordSettingsV.d.ts} +2 -2
  16. package/build/internal/src/middleware/additionalResource.d.ts +270 -27
  17. package/build/internal/src/middleware/billing.d.ts +31 -0
  18. package/build/internal/src/middleware/chat.d.ts +12933 -0
  19. package/build/internal/src/middleware/checklist.d.ts +589 -70
  20. package/build/internal/src/middleware/command.d.ts +5433 -677
  21. package/build/internal/src/middleware/detailPreview.d.ts +12 -1
  22. package/build/internal/src/middleware/endUser.d.ts +132 -0
  23. package/build/internal/src/middleware/entityChanges.d.ts +17 -0
  24. package/build/internal/src/middleware/experienceTemplate.d.ts +59 -0
  25. package/build/internal/src/middleware/experiencesSearch.d.ts +3579 -0
  26. package/build/internal/src/middleware/flags.d.ts +20 -0
  27. package/build/internal/src/middleware/generics.d.ts +12 -11
  28. package/build/internal/src/middleware/helpDocsIntegration.d.ts +63 -8
  29. package/build/internal/src/middleware/helpDocsSearch.d.ts +2540 -0
  30. package/build/internal/src/middleware/helpHub.d.ts +26 -0
  31. package/build/internal/src/middleware/helpers/actions.d.ts +174 -16
  32. package/build/internal/src/middleware/helpers/commandTemplate.d.ts +144 -2
  33. package/build/internal/src/middleware/helpers/copilotPersonality.d.ts +12 -0
  34. package/build/internal/src/middleware/helpers/goals.d.ts +4 -2
  35. package/build/internal/src/middleware/helpers/pushTrigger.d.ts +28 -0
  36. package/build/internal/src/middleware/helpers/rules.d.ts +318 -50
  37. package/build/internal/src/middleware/network.d.ts +27 -3
  38. package/build/internal/src/middleware/nudge.d.ts +2220 -91
  39. package/build/internal/src/middleware/organization.d.ts +2289 -152
  40. package/build/internal/src/middleware/organizationSettings.d.ts +435 -20
  41. package/build/internal/src/middleware/profile.d.ts +2 -0
  42. package/build/internal/src/middleware/recommendationSet.d.ts +489 -1007
  43. package/build/internal/src/middleware/releases.d.ts +1 -1
  44. package/build/internal/src/middleware/theme.d.ts +425 -0
  45. package/build/internal/src/middleware/types.d.ts +88 -34
  46. package/build/internal/src/middleware/user.d.ts +1 -0
  47. package/build/internal/src/util/dispatchCustomEvent.d.ts +5 -3
  48. package/build/internal/src/util/operatingSystem.d.ts +11 -0
  49. package/build/internal/src/util/sentry.d.ts +23 -0
  50. package/package.json +3 -3
  51. package/src/index.ts +2 -2
  52. package/src/init.ts +11 -6
  53. package/src/snippet.ts +2 -2
  54. package/build/internal/src/client/AnalyticsEventTypes.d.ts +0 -1
  55. package/build/internal/src/client/SentryReporter.d.ts +0 -63
  56. package/build/internal/src/middleware/IResourceSettings.d.ts +0 -3
  57. package/build/internal/src/middleware/chatAnalytics.d.ts +0 -2601
  58. package/build/internal/src/middleware/dashboardFlags.d.ts +0 -9
  59. package/build/internal/src/middleware/helpers/endUser.d.ts +0 -11
  60. package/build/internal/src/middleware/qaPair.d.ts +0 -676
  61. package/build/internal/src/util/integrations.d.ts +0 -1
@@ -20,32 +20,62 @@ export declare const ChecklistItemV: t.IntersectionC<[t.TypeC<{
20
20
  expression: t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>;
21
21
  }>, t.TypeC<{
22
22
  type: t.LiteralC<"cta_clicked">;
23
- }>, t.TypeC<{
23
+ }>, t.IntersectionC<[t.TypeC<{
24
24
  type: t.LiteralC<"event_tracked">;
25
25
  event: t.StringC;
26
- }>]>;
27
- action: t.UnionC<[t.IntersectionC<[t.TypeC<{
26
+ }>, t.PartialC<{
27
+ condition_group: t.UnionC<[t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>, t.NullC, t.UndefinedC]>;
28
+ }>]>]>;
29
+ action: t.UnionC<[t.TypeC<{
30
+ type: t.LiteralC<"execute_command">;
31
+ meta: t.IntersectionC<[t.TypeC<{
32
+ command: t.StringC;
33
+ }>, t.PartialC<{
34
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
35
+ }>]>;
36
+ }>, t.TypeC<{
37
+ type: t.LiteralC<"no_action">;
38
+ }>, t.TypeC<{
39
+ type: t.LiteralC<"click">;
40
+ value: t.StringC;
41
+ }>, t.TypeC<{
42
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
43
+ value: t.ArrayC<t.StringC>;
44
+ }>, t.IntersectionC<[t.TypeC<{
28
45
  type: t.LiteralC<"link">;
29
46
  value: t.StringC;
30
47
  }>, t.PartialC<{
31
48
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
32
49
  }>]>, t.TypeC<{
33
- type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
34
- value: t.ArrayC<t.StringC>;
35
- }>, t.TypeC<{
36
- type: t.LiteralC<"execute_command">;
50
+ type: t.LiteralC<"open_chat">;
37
51
  meta: t.TypeC<{
38
- command: t.StringC;
52
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
39
53
  }>;
54
+ }>, t.TypeC<{
55
+ type: t.LiteralC<"dismiss">;
56
+ }>, t.TypeC<{
57
+ type: t.LiteralC<"snooze">;
58
+ }>, t.TypeC<{
59
+ type: t.LiteralC<"questlist">;
60
+ value: t.NumberC;
40
61
  }>, t.TypeC<{
41
62
  type: t.LiteralC<"nudge">;
42
63
  value: t.NumberC;
64
+ }>, t.TypeC<{
65
+ type: t.LiteralC<"go_to_step">;
66
+ value: t.NumberC;
67
+ }>, t.TypeC<{
68
+ type: t.LiteralC<"step_back">;
43
69
  }>, t.IntersectionC<[t.TypeC<{
44
70
  type: t.LiteralC<"open_bar">;
45
71
  }>, t.PartialC<{
46
72
  value: t.StringC;
47
73
  categoryFilter: t.NumberC;
48
- }>]>]>;
74
+ }>]>, t.TypeC<{
75
+ type: t.LiteralC<"open_helphub">;
76
+ }>, t.TypeC<{
77
+ type: t.LiteralC<"open_copilot">;
78
+ }>]>;
49
79
  celebrate: t.BooleanC;
50
80
  }>, t.PartialC<{
51
81
  description: t.StringC;
@@ -72,14 +102,33 @@ export declare const ChecklistBaseV: t.IntersectionC<[t.TypeC<{
72
102
  type: t.LiteralC<"on_event">;
73
103
  meta: t.TypeC<{
74
104
  event: t.StringC;
105
+ condition_group: t.UnionC<[t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>, t.NullC, t.UndefinedC]>;
75
106
  }>;
76
107
  }>, t.TypeC<{
77
108
  type: t.LiteralC<"when_element_appears">;
78
109
  meta: t.TypeC<{
79
110
  selector: t.StringC;
80
111
  }>;
112
+ }>, t.TypeC<{
113
+ type: t.LiteralC<"on_user_confusion">;
114
+ }>, t.TypeC<{
115
+ type: t.LiteralC<"on_rage_click">;
116
+ }>, t.TypeC<{
117
+ type: t.LiteralC<"smart_delay">;
118
+ }>, t.TypeC<{
119
+ type: t.LiteralC<"after_time">;
120
+ meta: t.TypeC<{
121
+ unit: t.UnionC<[t.LiteralC<"minute">, t.LiteralC<"second">]>;
122
+ value: t.NumberC;
123
+ }>;
81
124
  }>, t.TypeC<{
82
125
  type: t.LiteralC<"when_share_link_viewed">;
126
+ }>, t.TypeC<{
127
+ type: t.LiteralC<"scheduled">;
128
+ meta: t.TypeC<{
129
+ interval: t.UnionC<[t.LiteralC<"day">, t.LiteralC<"week">, t.LiteralC<"month">]>;
130
+ value: t.NumberC;
131
+ }>;
83
132
  }>]>;
84
133
  items: t.ArrayC<t.IntersectionC<[t.TypeC<{
85
134
  skippable: t.BooleanC;
@@ -102,32 +151,62 @@ export declare const ChecklistBaseV: t.IntersectionC<[t.TypeC<{
102
151
  expression: t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>;
103
152
  }>, t.TypeC<{
104
153
  type: t.LiteralC<"cta_clicked">;
105
- }>, t.TypeC<{
154
+ }>, t.IntersectionC<[t.TypeC<{
106
155
  type: t.LiteralC<"event_tracked">;
107
156
  event: t.StringC;
108
- }>]>;
109
- action: t.UnionC<[t.IntersectionC<[t.TypeC<{
157
+ }>, t.PartialC<{
158
+ condition_group: t.UnionC<[t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>, t.NullC, t.UndefinedC]>;
159
+ }>]>]>;
160
+ action: t.UnionC<[t.TypeC<{
161
+ type: t.LiteralC<"execute_command">;
162
+ meta: t.IntersectionC<[t.TypeC<{
163
+ command: t.StringC;
164
+ }>, t.PartialC<{
165
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
166
+ }>]>;
167
+ }>, t.TypeC<{
168
+ type: t.LiteralC<"no_action">;
169
+ }>, t.TypeC<{
170
+ type: t.LiteralC<"click">;
171
+ value: t.StringC;
172
+ }>, t.TypeC<{
173
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
174
+ value: t.ArrayC<t.StringC>;
175
+ }>, t.IntersectionC<[t.TypeC<{
110
176
  type: t.LiteralC<"link">;
111
177
  value: t.StringC;
112
178
  }>, t.PartialC<{
113
179
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
114
180
  }>]>, t.TypeC<{
115
- type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
116
- value: t.ArrayC<t.StringC>;
117
- }>, t.TypeC<{
118
- type: t.LiteralC<"execute_command">;
181
+ type: t.LiteralC<"open_chat">;
119
182
  meta: t.TypeC<{
120
- command: t.StringC;
183
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
121
184
  }>;
185
+ }>, t.TypeC<{
186
+ type: t.LiteralC<"dismiss">;
187
+ }>, t.TypeC<{
188
+ type: t.LiteralC<"snooze">;
189
+ }>, t.TypeC<{
190
+ type: t.LiteralC<"questlist">;
191
+ value: t.NumberC;
122
192
  }>, t.TypeC<{
123
193
  type: t.LiteralC<"nudge">;
124
194
  value: t.NumberC;
195
+ }>, t.TypeC<{
196
+ type: t.LiteralC<"go_to_step">;
197
+ value: t.NumberC;
198
+ }>, t.TypeC<{
199
+ type: t.LiteralC<"step_back">;
125
200
  }>, t.IntersectionC<[t.TypeC<{
126
201
  type: t.LiteralC<"open_bar">;
127
202
  }>, t.PartialC<{
128
203
  value: t.StringC;
129
204
  categoryFilter: t.NumberC;
130
- }>]>]>;
205
+ }>]>, t.TypeC<{
206
+ type: t.LiteralC<"open_helphub">;
207
+ }>, t.TypeC<{
208
+ type: t.LiteralC<"open_copilot">;
209
+ }>]>;
131
210
  celebrate: t.BooleanC;
132
211
  }>, t.PartialC<{
133
212
  description: t.StringC;
@@ -172,14 +251,33 @@ export declare const ChecklistV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
172
251
  type: t.LiteralC<"on_event">;
173
252
  meta: t.TypeC<{
174
253
  event: t.StringC;
254
+ condition_group: t.UnionC<[t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>, t.NullC, t.UndefinedC]>;
175
255
  }>;
176
256
  }>, t.TypeC<{
177
257
  type: t.LiteralC<"when_element_appears">;
178
258
  meta: t.TypeC<{
179
259
  selector: t.StringC;
180
260
  }>;
261
+ }>, t.TypeC<{
262
+ type: t.LiteralC<"on_user_confusion">;
263
+ }>, t.TypeC<{
264
+ type: t.LiteralC<"on_rage_click">;
265
+ }>, t.TypeC<{
266
+ type: t.LiteralC<"smart_delay">;
267
+ }>, t.TypeC<{
268
+ type: t.LiteralC<"after_time">;
269
+ meta: t.TypeC<{
270
+ unit: t.UnionC<[t.LiteralC<"minute">, t.LiteralC<"second">]>;
271
+ value: t.NumberC;
272
+ }>;
181
273
  }>, t.TypeC<{
182
274
  type: t.LiteralC<"when_share_link_viewed">;
275
+ }>, t.TypeC<{
276
+ type: t.LiteralC<"scheduled">;
277
+ meta: t.TypeC<{
278
+ interval: t.UnionC<[t.LiteralC<"day">, t.LiteralC<"week">, t.LiteralC<"month">]>;
279
+ value: t.NumberC;
280
+ }>;
183
281
  }>]>;
184
282
  items: t.ArrayC<t.IntersectionC<[t.TypeC<{
185
283
  skippable: t.BooleanC;
@@ -202,32 +300,62 @@ export declare const ChecklistV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
202
300
  expression: t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>;
203
301
  }>, t.TypeC<{
204
302
  type: t.LiteralC<"cta_clicked">;
205
- }>, t.TypeC<{
303
+ }>, t.IntersectionC<[t.TypeC<{
206
304
  type: t.LiteralC<"event_tracked">;
207
305
  event: t.StringC;
208
- }>]>;
209
- action: t.UnionC<[t.IntersectionC<[t.TypeC<{
306
+ }>, t.PartialC<{
307
+ condition_group: t.UnionC<[t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>, t.NullC, t.UndefinedC]>;
308
+ }>]>]>;
309
+ action: t.UnionC<[t.TypeC<{
310
+ type: t.LiteralC<"execute_command">;
311
+ meta: t.IntersectionC<[t.TypeC<{
312
+ command: t.StringC;
313
+ }>, t.PartialC<{
314
+ type: t.UnionC<[t.LiteralC<"action">, t.LiteralC<"link">, t.LiteralC<"helpdoc">, t.LiteralC<"video">]>;
315
+ }>]>;
316
+ }>, t.TypeC<{
317
+ type: t.LiteralC<"no_action">;
318
+ }>, t.TypeC<{
319
+ type: t.LiteralC<"click">;
320
+ value: t.StringC;
321
+ }>, t.TypeC<{
322
+ type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
323
+ value: t.ArrayC<t.StringC>;
324
+ }>, t.IntersectionC<[t.TypeC<{
210
325
  type: t.LiteralC<"link">;
211
326
  value: t.StringC;
212
327
  }>, t.PartialC<{
213
328
  operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
214
329
  }>]>, t.TypeC<{
215
- type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
216
- value: t.ArrayC<t.StringC>;
217
- }>, t.TypeC<{
218
- type: t.LiteralC<"execute_command">;
330
+ type: t.LiteralC<"open_chat">;
219
331
  meta: t.TypeC<{
220
- command: t.StringC;
332
+ type: t.UnionC<[t.LiteralC<"intercom">, t.LiteralC<"helpscout">, t.LiteralC<"freshdesk">, t.LiteralC<"crisp">, t.LiteralC<"zendesk">, t.LiteralC<"liveChat">, t.LiteralC<"gist">, t.LiteralC<"olark">, t.LiteralC<"hubspot">, t.LiteralC<"drift">, t.LiteralC<"">]>;
221
333
  }>;
334
+ }>, t.TypeC<{
335
+ type: t.LiteralC<"dismiss">;
336
+ }>, t.TypeC<{
337
+ type: t.LiteralC<"snooze">;
338
+ }>, t.TypeC<{
339
+ type: t.LiteralC<"questlist">;
340
+ value: t.NumberC;
222
341
  }>, t.TypeC<{
223
342
  type: t.LiteralC<"nudge">;
224
343
  value: t.NumberC;
344
+ }>, t.TypeC<{
345
+ type: t.LiteralC<"go_to_step">;
346
+ value: t.NumberC;
347
+ }>, t.TypeC<{
348
+ type: t.LiteralC<"step_back">;
225
349
  }>, t.IntersectionC<[t.TypeC<{
226
350
  type: t.LiteralC<"open_bar">;
227
351
  }>, t.PartialC<{
228
352
  value: t.StringC;
229
353
  categoryFilter: t.NumberC;
230
- }>]>]>;
354
+ }>]>, t.TypeC<{
355
+ type: t.LiteralC<"open_helphub">;
356
+ }>, t.TypeC<{
357
+ type: t.LiteralC<"open_copilot">;
358
+ }>]>;
231
359
  celebrate: t.BooleanC;
232
360
  }>, t.PartialC<{
233
361
  description: t.StringC;
@@ -257,7 +385,13 @@ export declare const ChecklistV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
257
385
  position: t.UnionC<[t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
258
386
  skippable: t.BooleanC;
259
387
  open_by_default: t.BooleanC;
260
- share_page_url: t.StringC;
388
+ share_page_url_or_path: t.StringC;
389
+ show_in_spotlight_search: t.BooleanC;
390
+ show_in_helphub_search: t.BooleanC;
391
+ copilot_suggest: t.BooleanC;
392
+ copilot_cta_label: t.StringC;
393
+ copilot_description: t.StringC;
394
+ editor_tags: t.ArrayC<t.StringC>;
261
395
  }>]>;
262
396
  export declare class Checklist {
263
397
  static decode: (data: any) => {
@@ -280,14 +414,33 @@ export declare class Checklist {
280
414
  type: "on_event";
281
415
  meta: {
282
416
  event: string;
417
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
283
418
  };
284
419
  } | {
285
420
  type: "when_element_appears";
286
421
  meta: {
287
422
  selector: string;
288
423
  };
424
+ } | {
425
+ type: "on_user_confusion";
426
+ } | {
427
+ type: "on_rage_click";
428
+ } | {
429
+ type: "smart_delay";
430
+ } | {
431
+ type: "after_time";
432
+ meta: {
433
+ unit: "minute" | "second";
434
+ value: number;
435
+ };
289
436
  } | {
290
437
  type: "when_share_link_viewed";
438
+ } | {
439
+ type: "scheduled";
440
+ meta: {
441
+ interval: "day" | "month" | "week";
442
+ value: number;
443
+ };
291
444
  };
292
445
  items: ({
293
446
  skippable: boolean;
@@ -310,32 +463,62 @@ export declare class Checklist {
310
463
  expression: import("./helpers/rules").RuleExpression;
311
464
  } | {
312
465
  type: "cta_clicked";
313
- } | {
466
+ } | ({
314
467
  type: "event_tracked";
315
468
  event: string;
316
- };
469
+ } & {
470
+ condition_group?: import("./helpers/rules").RuleExpression | null | undefined;
471
+ });
317
472
  action: {
318
473
  type: "execute_command";
319
474
  meta: {
320
475
  command: string;
476
+ } & {
477
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
321
478
  };
479
+ } | {
480
+ type: "click";
481
+ value: string;
482
+ } | {
483
+ type: "click" | "clickBySelector" | "clickByXpath";
484
+ value: string[];
322
485
  } | ({
323
486
  type: "link";
324
487
  value: string;
325
488
  } & {
326
489
  operation?: "self" | "router" | "blank" | undefined;
327
490
  }) | {
328
- type: "click" | "clickByXpath" | "clickBySelector";
329
- value: string[];
491
+ type: "open_chat";
492
+ meta: {
493
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
494
+ };
495
+ } | {
496
+ type: "dismiss";
497
+ } | {
498
+ type: "snooze";
499
+ } | {
500
+ type: "questlist";
501
+ value: number;
502
+ } | {
503
+ type: "step_back";
330
504
  } | {
331
505
  type: "nudge";
332
506
  value: number;
507
+ } | {
508
+ type: "go_to_step";
509
+ value: number;
333
510
  } | ({
334
511
  type: "open_bar";
335
512
  } & {
336
513
  value?: string | undefined;
337
514
  categoryFilter?: number | undefined;
338
- });
515
+ }) | {
516
+ type: "open_helphub";
517
+ } | {
518
+ type: "open_copilot";
519
+ } | {
520
+ type: "no_action";
521
+ };
339
522
  celebrate: boolean;
340
523
  } & {
341
524
  description?: string | undefined;
@@ -365,7 +548,13 @@ export declare class Checklist {
365
548
  position: "bottomRight" | "bottomLeft";
366
549
  skippable: boolean;
367
550
  open_by_default: boolean;
368
- share_page_url: string;
551
+ share_page_url_or_path: string;
552
+ show_in_spotlight_search: boolean;
553
+ show_in_helphub_search: boolean;
554
+ copilot_suggest: boolean;
555
+ copilot_cta_label: string;
556
+ copilot_description: string;
557
+ editor_tags: string[];
369
558
  };
370
559
  static create: (object: {
371
560
  id: number;
@@ -387,14 +576,33 @@ export declare class Checklist {
387
576
  type: "on_event";
388
577
  meta: {
389
578
  event: string;
579
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
390
580
  };
391
581
  } | {
392
582
  type: "when_element_appears";
393
583
  meta: {
394
584
  selector: string;
395
585
  };
586
+ } | {
587
+ type: "on_user_confusion";
588
+ } | {
589
+ type: "on_rage_click";
590
+ } | {
591
+ type: "smart_delay";
592
+ } | {
593
+ type: "after_time";
594
+ meta: {
595
+ unit: "minute" | "second";
596
+ value: number;
597
+ };
396
598
  } | {
397
599
  type: "when_share_link_viewed";
600
+ } | {
601
+ type: "scheduled";
602
+ meta: {
603
+ interval: "day" | "month" | "week";
604
+ value: number;
605
+ };
398
606
  };
399
607
  items: ({
400
608
  skippable: boolean;
@@ -417,32 +625,62 @@ export declare class Checklist {
417
625
  expression: import("./helpers/rules").RuleExpression;
418
626
  } | {
419
627
  type: "cta_clicked";
420
- } | {
628
+ } | ({
421
629
  type: "event_tracked";
422
630
  event: string;
423
- };
631
+ } & {
632
+ condition_group?: import("./helpers/rules").RuleExpression | null | undefined;
633
+ });
424
634
  action: {
425
635
  type: "execute_command";
426
636
  meta: {
427
637
  command: string;
638
+ } & {
639
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
428
640
  };
641
+ } | {
642
+ type: "click";
643
+ value: string;
644
+ } | {
645
+ type: "click" | "clickBySelector" | "clickByXpath";
646
+ value: string[];
429
647
  } | ({
430
648
  type: "link";
431
649
  value: string;
432
650
  } & {
433
651
  operation?: "self" | "router" | "blank" | undefined;
434
652
  }) | {
435
- type: "click" | "clickByXpath" | "clickBySelector";
436
- value: string[];
653
+ type: "open_chat";
654
+ meta: {
655
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
656
+ };
657
+ } | {
658
+ type: "dismiss";
659
+ } | {
660
+ type: "snooze";
661
+ } | {
662
+ type: "questlist";
663
+ value: number;
664
+ } | {
665
+ type: "step_back";
437
666
  } | {
438
667
  type: "nudge";
439
668
  value: number;
669
+ } | {
670
+ type: "go_to_step";
671
+ value: number;
440
672
  } | ({
441
673
  type: "open_bar";
442
674
  } & {
443
675
  value?: string | undefined;
444
676
  categoryFilter?: number | undefined;
445
- });
677
+ }) | {
678
+ type: "open_helphub";
679
+ } | {
680
+ type: "open_copilot";
681
+ } | {
682
+ type: "no_action";
683
+ };
446
684
  celebrate: boolean;
447
685
  } & {
448
686
  description?: string | undefined;
@@ -472,7 +710,13 @@ export declare class Checklist {
472
710
  position: "bottomRight" | "bottomLeft";
473
711
  skippable: boolean;
474
712
  open_by_default: boolean;
475
- share_page_url: string;
713
+ share_page_url_or_path: string;
714
+ show_in_spotlight_search: boolean;
715
+ show_in_helphub_search: boolean;
716
+ copilot_suggest: boolean;
717
+ copilot_cta_label: string;
718
+ copilot_description: string;
719
+ editor_tags: string[];
476
720
  }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
477
721
  id: number;
478
722
  title: string;
@@ -493,14 +737,33 @@ export declare class Checklist {
493
737
  type: "on_event";
494
738
  meta: {
495
739
  event: string;
740
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
496
741
  };
497
742
  } | {
498
743
  type: "when_element_appears";
499
744
  meta: {
500
745
  selector: string;
501
746
  };
747
+ } | {
748
+ type: "on_user_confusion";
749
+ } | {
750
+ type: "on_rage_click";
751
+ } | {
752
+ type: "smart_delay";
753
+ } | {
754
+ type: "after_time";
755
+ meta: {
756
+ unit: "minute" | "second";
757
+ value: number;
758
+ };
502
759
  } | {
503
760
  type: "when_share_link_viewed";
761
+ } | {
762
+ type: "scheduled";
763
+ meta: {
764
+ interval: "day" | "month" | "week";
765
+ value: number;
766
+ };
504
767
  };
505
768
  items: ({
506
769
  skippable: boolean;
@@ -523,32 +786,62 @@ export declare class Checklist {
523
786
  expression: import("./helpers/rules").RuleExpression;
524
787
  } | {
525
788
  type: "cta_clicked";
526
- } | {
789
+ } | ({
527
790
  type: "event_tracked";
528
791
  event: string;
529
- };
792
+ } & {
793
+ condition_group?: import("./helpers/rules").RuleExpression | null | undefined;
794
+ });
530
795
  action: {
531
796
  type: "execute_command";
532
797
  meta: {
533
798
  command: string;
799
+ } & {
800
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
534
801
  };
802
+ } | {
803
+ type: "click";
804
+ value: string;
805
+ } | {
806
+ type: "click" | "clickBySelector" | "clickByXpath";
807
+ value: string[];
535
808
  } | ({
536
809
  type: "link";
537
810
  value: string;
538
811
  } & {
539
812
  operation?: "self" | "router" | "blank" | undefined;
540
813
  }) | {
541
- type: "click" | "clickByXpath" | "clickBySelector";
542
- value: string[];
814
+ type: "open_chat";
815
+ meta: {
816
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
817
+ };
818
+ } | {
819
+ type: "dismiss";
820
+ } | {
821
+ type: "snooze";
822
+ } | {
823
+ type: "questlist";
824
+ value: number;
825
+ } | {
826
+ type: "step_back";
543
827
  } | {
544
828
  type: "nudge";
545
829
  value: number;
830
+ } | {
831
+ type: "go_to_step";
832
+ value: number;
546
833
  } | ({
547
834
  type: "open_bar";
548
835
  } & {
549
836
  value?: string | undefined;
550
837
  categoryFilter?: number | undefined;
551
- });
838
+ }) | {
839
+ type: "open_helphub";
840
+ } | {
841
+ type: "open_copilot";
842
+ } | {
843
+ type: "no_action";
844
+ };
552
845
  celebrate: boolean;
553
846
  } & {
554
847
  description?: string | undefined;
@@ -578,7 +871,13 @@ export declare class Checklist {
578
871
  position: "bottomRight" | "bottomLeft";
579
872
  skippable: boolean;
580
873
  open_by_default: boolean;
581
- share_page_url: string;
874
+ share_page_url_or_path: string;
875
+ show_in_spotlight_search: boolean;
876
+ show_in_helphub_search: boolean;
877
+ copilot_suggest: boolean;
878
+ copilot_cta_label: string;
879
+ copilot_description: string;
880
+ editor_tags: string[];
582
881
  }>;
583
882
  static update: (object: {
584
883
  id: number;
@@ -600,14 +899,33 @@ export declare class Checklist {
600
899
  type: "on_event";
601
900
  meta: {
602
901
  event: string;
902
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
603
903
  };
604
904
  } | {
605
905
  type: "when_element_appears";
606
906
  meta: {
607
907
  selector: string;
608
908
  };
909
+ } | {
910
+ type: "on_user_confusion";
911
+ } | {
912
+ type: "on_rage_click";
913
+ } | {
914
+ type: "smart_delay";
915
+ } | {
916
+ type: "after_time";
917
+ meta: {
918
+ unit: "minute" | "second";
919
+ value: number;
920
+ };
609
921
  } | {
610
922
  type: "when_share_link_viewed";
923
+ } | {
924
+ type: "scheduled";
925
+ meta: {
926
+ interval: "day" | "month" | "week";
927
+ value: number;
928
+ };
611
929
  };
612
930
  items: ({
613
931
  skippable: boolean;
@@ -630,32 +948,62 @@ export declare class Checklist {
630
948
  expression: import("./helpers/rules").RuleExpression;
631
949
  } | {
632
950
  type: "cta_clicked";
633
- } | {
951
+ } | ({
634
952
  type: "event_tracked";
635
953
  event: string;
636
- };
954
+ } & {
955
+ condition_group?: import("./helpers/rules").RuleExpression | null | undefined;
956
+ });
637
957
  action: {
638
958
  type: "execute_command";
639
959
  meta: {
640
960
  command: string;
961
+ } & {
962
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
641
963
  };
964
+ } | {
965
+ type: "click";
966
+ value: string;
967
+ } | {
968
+ type: "click" | "clickBySelector" | "clickByXpath";
969
+ value: string[];
642
970
  } | ({
643
971
  type: "link";
644
972
  value: string;
645
973
  } & {
646
974
  operation?: "self" | "router" | "blank" | undefined;
647
975
  }) | {
648
- type: "click" | "clickByXpath" | "clickBySelector";
649
- value: string[];
976
+ type: "open_chat";
977
+ meta: {
978
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
979
+ };
980
+ } | {
981
+ type: "dismiss";
982
+ } | {
983
+ type: "snooze";
984
+ } | {
985
+ type: "questlist";
986
+ value: number;
987
+ } | {
988
+ type: "step_back";
650
989
  } | {
651
990
  type: "nudge";
652
991
  value: number;
992
+ } | {
993
+ type: "go_to_step";
994
+ value: number;
653
995
  } | ({
654
996
  type: "open_bar";
655
997
  } & {
656
998
  value?: string | undefined;
657
999
  categoryFilter?: number | undefined;
658
- });
1000
+ }) | {
1001
+ type: "open_helphub";
1002
+ } | {
1003
+ type: "open_copilot";
1004
+ } | {
1005
+ type: "no_action";
1006
+ };
659
1007
  celebrate: boolean;
660
1008
  } & {
661
1009
  description?: string | undefined;
@@ -685,7 +1033,13 @@ export declare class Checklist {
685
1033
  position: "bottomRight" | "bottomLeft";
686
1034
  skippable: boolean;
687
1035
  open_by_default: boolean;
688
- share_page_url: string;
1036
+ share_page_url_or_path: string;
1037
+ show_in_spotlight_search: boolean;
1038
+ show_in_helphub_search: boolean;
1039
+ copilot_suggest: boolean;
1040
+ copilot_cta_label: string;
1041
+ copilot_description: string;
1042
+ editor_tags: string[];
689
1043
  }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
690
1044
  id: number;
691
1045
  title: string;
@@ -706,14 +1060,33 @@ export declare class Checklist {
706
1060
  type: "on_event";
707
1061
  meta: {
708
1062
  event: string;
1063
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
709
1064
  };
710
1065
  } | {
711
1066
  type: "when_element_appears";
712
1067
  meta: {
713
1068
  selector: string;
714
1069
  };
1070
+ } | {
1071
+ type: "on_user_confusion";
1072
+ } | {
1073
+ type: "on_rage_click";
1074
+ } | {
1075
+ type: "smart_delay";
1076
+ } | {
1077
+ type: "after_time";
1078
+ meta: {
1079
+ unit: "minute" | "second";
1080
+ value: number;
1081
+ };
715
1082
  } | {
716
1083
  type: "when_share_link_viewed";
1084
+ } | {
1085
+ type: "scheduled";
1086
+ meta: {
1087
+ interval: "day" | "month" | "week";
1088
+ value: number;
1089
+ };
717
1090
  };
718
1091
  items: ({
719
1092
  skippable: boolean;
@@ -736,32 +1109,62 @@ export declare class Checklist {
736
1109
  expression: import("./helpers/rules").RuleExpression;
737
1110
  } | {
738
1111
  type: "cta_clicked";
739
- } | {
1112
+ } | ({
740
1113
  type: "event_tracked";
741
1114
  event: string;
742
- };
1115
+ } & {
1116
+ condition_group?: import("./helpers/rules").RuleExpression | null | undefined;
1117
+ });
743
1118
  action: {
744
1119
  type: "execute_command";
745
1120
  meta: {
746
1121
  command: string;
1122
+ } & {
1123
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
747
1124
  };
1125
+ } | {
1126
+ type: "click";
1127
+ value: string;
1128
+ } | {
1129
+ type: "click" | "clickBySelector" | "clickByXpath";
1130
+ value: string[];
748
1131
  } | ({
749
1132
  type: "link";
750
1133
  value: string;
751
1134
  } & {
752
1135
  operation?: "self" | "router" | "blank" | undefined;
753
1136
  }) | {
754
- type: "click" | "clickByXpath" | "clickBySelector";
755
- value: string[];
1137
+ type: "open_chat";
1138
+ meta: {
1139
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1140
+ };
1141
+ } | {
1142
+ type: "dismiss";
1143
+ } | {
1144
+ type: "snooze";
1145
+ } | {
1146
+ type: "questlist";
1147
+ value: number;
1148
+ } | {
1149
+ type: "step_back";
756
1150
  } | {
757
1151
  type: "nudge";
758
1152
  value: number;
1153
+ } | {
1154
+ type: "go_to_step";
1155
+ value: number;
759
1156
  } | ({
760
1157
  type: "open_bar";
761
1158
  } & {
762
1159
  value?: string | undefined;
763
1160
  categoryFilter?: number | undefined;
764
- });
1161
+ }) | {
1162
+ type: "open_helphub";
1163
+ } | {
1164
+ type: "open_copilot";
1165
+ } | {
1166
+ type: "no_action";
1167
+ };
765
1168
  celebrate: boolean;
766
1169
  } & {
767
1170
  description?: string | undefined;
@@ -791,7 +1194,13 @@ export declare class Checklist {
791
1194
  position: "bottomRight" | "bottomLeft";
792
1195
  skippable: boolean;
793
1196
  open_by_default: boolean;
794
- share_page_url: string;
1197
+ share_page_url_or_path: string;
1198
+ show_in_spotlight_search: boolean;
1199
+ show_in_helphub_search: boolean;
1200
+ copilot_suggest: boolean;
1201
+ copilot_cta_label: string;
1202
+ copilot_description: string;
1203
+ editor_tags: string[];
795
1204
  }>;
796
1205
  static delete: (id: string | number, params?: Record<string, string> | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
797
1206
  static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
@@ -814,14 +1223,33 @@ export declare class Checklist {
814
1223
  type: "on_event";
815
1224
  meta: {
816
1225
  event: string;
1226
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
817
1227
  };
818
1228
  } | {
819
1229
  type: "when_element_appears";
820
1230
  meta: {
821
1231
  selector: string;
822
1232
  };
1233
+ } | {
1234
+ type: "on_user_confusion";
1235
+ } | {
1236
+ type: "on_rage_click";
1237
+ } | {
1238
+ type: "smart_delay";
1239
+ } | {
1240
+ type: "after_time";
1241
+ meta: {
1242
+ unit: "minute" | "second";
1243
+ value: number;
1244
+ };
823
1245
  } | {
824
1246
  type: "when_share_link_viewed";
1247
+ } | {
1248
+ type: "scheduled";
1249
+ meta: {
1250
+ interval: "day" | "month" | "week";
1251
+ value: number;
1252
+ };
825
1253
  };
826
1254
  items: ({
827
1255
  skippable: boolean;
@@ -844,32 +1272,62 @@ export declare class Checklist {
844
1272
  expression: import("./helpers/rules").RuleExpression;
845
1273
  } | {
846
1274
  type: "cta_clicked";
847
- } | {
1275
+ } | ({
848
1276
  type: "event_tracked";
849
1277
  event: string;
850
- };
1278
+ } & {
1279
+ condition_group?: import("./helpers/rules").RuleExpression | null | undefined;
1280
+ });
851
1281
  action: {
852
1282
  type: "execute_command";
853
1283
  meta: {
854
1284
  command: string;
1285
+ } & {
1286
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
855
1287
  };
1288
+ } | {
1289
+ type: "click";
1290
+ value: string;
1291
+ } | {
1292
+ type: "click" | "clickBySelector" | "clickByXpath";
1293
+ value: string[];
856
1294
  } | ({
857
1295
  type: "link";
858
1296
  value: string;
859
1297
  } & {
860
1298
  operation?: "self" | "router" | "blank" | undefined;
861
1299
  }) | {
862
- type: "click" | "clickByXpath" | "clickBySelector";
863
- value: string[];
1300
+ type: "open_chat";
1301
+ meta: {
1302
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1303
+ };
1304
+ } | {
1305
+ type: "dismiss";
1306
+ } | {
1307
+ type: "snooze";
1308
+ } | {
1309
+ type: "questlist";
1310
+ value: number;
1311
+ } | {
1312
+ type: "step_back";
864
1313
  } | {
865
1314
  type: "nudge";
866
1315
  value: number;
1316
+ } | {
1317
+ type: "go_to_step";
1318
+ value: number;
867
1319
  } | ({
868
1320
  type: "open_bar";
869
1321
  } & {
870
1322
  value?: string | undefined;
871
1323
  categoryFilter?: number | undefined;
872
- });
1324
+ }) | {
1325
+ type: "open_helphub";
1326
+ } | {
1327
+ type: "open_copilot";
1328
+ } | {
1329
+ type: "no_action";
1330
+ };
873
1331
  celebrate: boolean;
874
1332
  } & {
875
1333
  description?: string | undefined;
@@ -899,7 +1357,13 @@ export declare class Checklist {
899
1357
  position: "bottomRight" | "bottomLeft";
900
1358
  skippable: boolean;
901
1359
  open_by_default: boolean;
902
- share_page_url: string;
1360
+ share_page_url_or_path: string;
1361
+ show_in_spotlight_search: boolean;
1362
+ show_in_helphub_search: boolean;
1363
+ copilot_suggest: boolean;
1364
+ copilot_cta_label: string;
1365
+ copilot_description: string;
1366
+ editor_tags: string[];
903
1367
  })[]>;
904
1368
  static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
905
1369
  onSuccess?: (() => void) | undefined;
@@ -924,14 +1388,33 @@ export declare class Checklist {
924
1388
  type: "on_event";
925
1389
  meta: {
926
1390
  event: string;
1391
+ condition_group: import("./helpers/rules").RuleExpression | null | undefined;
927
1392
  };
928
1393
  } | {
929
1394
  type: "when_element_appears";
930
1395
  meta: {
931
1396
  selector: string;
932
1397
  };
1398
+ } | {
1399
+ type: "on_user_confusion";
1400
+ } | {
1401
+ type: "on_rage_click";
1402
+ } | {
1403
+ type: "smart_delay";
1404
+ } | {
1405
+ type: "after_time";
1406
+ meta: {
1407
+ unit: "minute" | "second";
1408
+ value: number;
1409
+ };
933
1410
  } | {
934
1411
  type: "when_share_link_viewed";
1412
+ } | {
1413
+ type: "scheduled";
1414
+ meta: {
1415
+ interval: "day" | "month" | "week";
1416
+ value: number;
1417
+ };
935
1418
  };
936
1419
  items: ({
937
1420
  skippable: boolean;
@@ -954,32 +1437,62 @@ export declare class Checklist {
954
1437
  expression: import("./helpers/rules").RuleExpression;
955
1438
  } | {
956
1439
  type: "cta_clicked";
957
- } | {
1440
+ } | ({
958
1441
  type: "event_tracked";
959
1442
  event: string;
960
- };
1443
+ } & {
1444
+ condition_group?: import("./helpers/rules").RuleExpression | null | undefined;
1445
+ });
961
1446
  action: {
962
1447
  type: "execute_command";
963
1448
  meta: {
964
1449
  command: string;
1450
+ } & {
1451
+ type?: "link" | "video" | "action" | "helpdoc" | undefined;
965
1452
  };
1453
+ } | {
1454
+ type: "click";
1455
+ value: string;
1456
+ } | {
1457
+ type: "click" | "clickBySelector" | "clickByXpath";
1458
+ value: string[];
966
1459
  } | ({
967
1460
  type: "link";
968
1461
  value: string;
969
1462
  } & {
970
1463
  operation?: "self" | "router" | "blank" | undefined;
971
1464
  }) | {
972
- type: "click" | "clickByXpath" | "clickBySelector";
973
- value: string[];
1465
+ type: "open_chat";
1466
+ meta: {
1467
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1468
+ };
1469
+ } | {
1470
+ type: "dismiss";
1471
+ } | {
1472
+ type: "snooze";
1473
+ } | {
1474
+ type: "questlist";
1475
+ value: number;
1476
+ } | {
1477
+ type: "step_back";
974
1478
  } | {
975
1479
  type: "nudge";
976
1480
  value: number;
1481
+ } | {
1482
+ type: "go_to_step";
1483
+ value: number;
977
1484
  } | ({
978
1485
  type: "open_bar";
979
1486
  } & {
980
1487
  value?: string | undefined;
981
1488
  categoryFilter?: number | undefined;
982
- });
1489
+ }) | {
1490
+ type: "open_helphub";
1491
+ } | {
1492
+ type: "open_copilot";
1493
+ } | {
1494
+ type: "no_action";
1495
+ };
983
1496
  celebrate: boolean;
984
1497
  } & {
985
1498
  description?: string | undefined;
@@ -1009,6 +1522,12 @@ export declare class Checklist {
1009
1522
  position: "bottomRight" | "bottomLeft";
1010
1523
  skippable: boolean;
1011
1524
  open_by_default: boolean;
1012
- share_page_url: string;
1525
+ share_page_url_or_path: string;
1526
+ show_in_spotlight_search: boolean;
1527
+ show_in_helphub_search: boolean;
1528
+ copilot_suggest: boolean;
1529
+ copilot_cta_label: string;
1530
+ copilot_description: string;
1531
+ editor_tags: string[];
1013
1532
  }>;
1014
1533
  }