commandbar 1.9.0 → 1.10.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{internal/src/client → commandbar/src/shared/services/analytics}/EventHandler.d.ts +32 -10
- package/build/commandbar/src/shared/services/analytics/types.d.ts +77 -0
- package/build/commandbar-js/src/index.d.ts +2 -2
- package/build/commandbar-js/src/index.js +1 -1
- package/build/internal/src/client/AddContextOptions.d.ts +4 -0
- package/build/internal/src/client/CommandBarClientSDK.d.ts +46 -13
- package/build/internal/src/client/CommandBarSDK.d.ts +17 -10
- package/build/internal/src/client/SDKConfig.d.ts +3 -2
- package/build/internal/src/client/symbols.d.ts +5 -1
- package/build/internal/src/middleware/CommandFromClientV.d.ts +22 -10
- package/build/internal/src/middleware/IRecordSettings.d.ts +3 -0
- package/build/internal/src/middleware/OrganizationV.d.ts +200 -6
- package/build/internal/src/middleware/{ResourceSettingsV.d.ts → RecordSettingsV.d.ts} +2 -2
- package/build/internal/src/middleware/additionalResource.d.ts +96 -15
- package/build/internal/src/middleware/billing.d.ts +0 -2
- package/build/internal/src/middleware/chat.d.ts +2196 -176
- package/build/internal/src/middleware/checklist.d.ts +504 -63
- package/build/internal/src/middleware/command.d.ts +1809 -385
- package/build/internal/src/middleware/endUser.d.ts +33 -5
- package/build/internal/src/middleware/entityChanges.d.ts +17 -0
- package/build/internal/src/middleware/experienceTemplate.d.ts +59 -0
- package/build/internal/src/middleware/experiencesSearch.d.ts +3579 -0
- package/build/internal/src/middleware/flags.d.ts +20 -0
- package/build/internal/src/middleware/helpDocsIntegration.d.ts +9 -0
- package/build/internal/src/middleware/helpDocsSearch.d.ts +371 -35
- package/build/internal/src/middleware/helpers/actions.d.ts +66 -16
- package/build/internal/src/middleware/helpers/commandTemplate.d.ts +70 -8
- package/build/internal/src/middleware/helpers/copilotPersonality.d.ts +12 -0
- package/build/internal/src/middleware/helpers/goals.d.ts +4 -2
- package/build/internal/src/middleware/helpers/pushTrigger.d.ts +22 -0
- package/build/internal/src/middleware/helpers/rules.d.ts +45 -36
- package/build/internal/src/middleware/network.d.ts +15 -0
- package/build/internal/src/middleware/nudge.d.ts +1103 -124
- package/build/internal/src/middleware/organization.d.ts +1288 -61
- package/build/internal/src/middleware/organizationSettings.d.ts +320 -12
- package/build/internal/src/middleware/profile.d.ts +2 -0
- package/build/internal/src/middleware/recommendationSet.d.ts +96 -15
- package/build/internal/src/middleware/releases.d.ts +1 -1
- package/build/internal/src/middleware/theme.d.ts +431 -0
- package/build/internal/src/middleware/types.d.ts +52 -15
- package/build/internal/src/middleware/user.d.ts +1 -0
- package/build/internal/src/util/dispatchCustomEvent.d.ts +3 -3
- package/build/internal/src/util/operatingSystem.d.ts +2 -4
- package/package.json +1 -1
- package/src/index.ts +2 -2
- package/src/init.ts +12 -6
- package/src/snippet.ts +2 -2
- package/build/internal/src/client/AnalyticsEventTypes.d.ts +0 -1
- package/build/internal/src/middleware/IResourceSettings.d.ts +0 -3
- package/build/internal/src/middleware/dashboardFlags.d.ts +0 -9
|
@@ -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
|
-
|
|
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.
|
|
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
|
-
|
|
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,6 +102,7 @@ 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">;
|
|
@@ -84,8 +115,20 @@ export declare const ChecklistBaseV: t.IntersectionC<[t.TypeC<{
|
|
|
84
115
|
type: t.LiteralC<"on_rage_click">;
|
|
85
116
|
}>, t.TypeC<{
|
|
86
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
|
+
}>;
|
|
87
124
|
}>, t.TypeC<{
|
|
88
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
|
+
}>;
|
|
89
132
|
}>]>;
|
|
90
133
|
items: t.ArrayC<t.IntersectionC<[t.TypeC<{
|
|
91
134
|
skippable: t.BooleanC;
|
|
@@ -108,32 +151,62 @@ export declare const ChecklistBaseV: t.IntersectionC<[t.TypeC<{
|
|
|
108
151
|
expression: t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>;
|
|
109
152
|
}>, t.TypeC<{
|
|
110
153
|
type: t.LiteralC<"cta_clicked">;
|
|
111
|
-
}>, t.TypeC<{
|
|
154
|
+
}>, t.IntersectionC<[t.TypeC<{
|
|
112
155
|
type: t.LiteralC<"event_tracked">;
|
|
113
156
|
event: t.StringC;
|
|
114
|
-
}
|
|
115
|
-
|
|
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<{
|
|
116
176
|
type: t.LiteralC<"link">;
|
|
117
177
|
value: t.StringC;
|
|
118
178
|
}>, t.PartialC<{
|
|
119
179
|
operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
|
|
120
180
|
}>]>, t.TypeC<{
|
|
121
|
-
type: t.
|
|
122
|
-
value: t.ArrayC<t.StringC>;
|
|
123
|
-
}>, t.TypeC<{
|
|
124
|
-
type: t.LiteralC<"execute_command">;
|
|
181
|
+
type: t.LiteralC<"open_chat">;
|
|
125
182
|
meta: t.TypeC<{
|
|
126
|
-
|
|
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<"">]>;
|
|
127
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;
|
|
128
192
|
}>, t.TypeC<{
|
|
129
193
|
type: t.LiteralC<"nudge">;
|
|
130
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">;
|
|
131
200
|
}>, t.IntersectionC<[t.TypeC<{
|
|
132
201
|
type: t.LiteralC<"open_bar">;
|
|
133
202
|
}>, t.PartialC<{
|
|
134
203
|
value: t.StringC;
|
|
135
204
|
categoryFilter: t.NumberC;
|
|
136
|
-
}>]
|
|
205
|
+
}>]>, t.TypeC<{
|
|
206
|
+
type: t.LiteralC<"open_helphub">;
|
|
207
|
+
}>, t.TypeC<{
|
|
208
|
+
type: t.LiteralC<"open_copilot">;
|
|
209
|
+
}>]>;
|
|
137
210
|
celebrate: t.BooleanC;
|
|
138
211
|
}>, t.PartialC<{
|
|
139
212
|
description: t.StringC;
|
|
@@ -178,6 +251,7 @@ export declare const ChecklistV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
|
|
|
178
251
|
type: t.LiteralC<"on_event">;
|
|
179
252
|
meta: t.TypeC<{
|
|
180
253
|
event: t.StringC;
|
|
254
|
+
condition_group: t.UnionC<[t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>, t.NullC, t.UndefinedC]>;
|
|
181
255
|
}>;
|
|
182
256
|
}>, t.TypeC<{
|
|
183
257
|
type: t.LiteralC<"when_element_appears">;
|
|
@@ -190,8 +264,20 @@ export declare const ChecklistV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
|
|
|
190
264
|
type: t.LiteralC<"on_rage_click">;
|
|
191
265
|
}>, t.TypeC<{
|
|
192
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
|
+
}>;
|
|
193
273
|
}>, t.TypeC<{
|
|
194
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
|
+
}>;
|
|
195
281
|
}>]>;
|
|
196
282
|
items: t.ArrayC<t.IntersectionC<[t.TypeC<{
|
|
197
283
|
skippable: t.BooleanC;
|
|
@@ -214,32 +300,62 @@ export declare const ChecklistV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
|
|
|
214
300
|
expression: t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>;
|
|
215
301
|
}>, t.TypeC<{
|
|
216
302
|
type: t.LiteralC<"cta_clicked">;
|
|
217
|
-
}>, t.TypeC<{
|
|
303
|
+
}>, t.IntersectionC<[t.TypeC<{
|
|
218
304
|
type: t.LiteralC<"event_tracked">;
|
|
219
305
|
event: t.StringC;
|
|
220
|
-
}
|
|
221
|
-
|
|
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<{
|
|
222
325
|
type: t.LiteralC<"link">;
|
|
223
326
|
value: t.StringC;
|
|
224
327
|
}>, t.PartialC<{
|
|
225
328
|
operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
|
|
226
329
|
}>]>, t.TypeC<{
|
|
227
|
-
type: t.
|
|
228
|
-
value: t.ArrayC<t.StringC>;
|
|
229
|
-
}>, t.TypeC<{
|
|
230
|
-
type: t.LiteralC<"execute_command">;
|
|
330
|
+
type: t.LiteralC<"open_chat">;
|
|
231
331
|
meta: t.TypeC<{
|
|
232
|
-
|
|
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<"">]>;
|
|
233
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;
|
|
234
341
|
}>, t.TypeC<{
|
|
235
342
|
type: t.LiteralC<"nudge">;
|
|
236
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">;
|
|
237
349
|
}>, t.IntersectionC<[t.TypeC<{
|
|
238
350
|
type: t.LiteralC<"open_bar">;
|
|
239
351
|
}>, t.PartialC<{
|
|
240
352
|
value: t.StringC;
|
|
241
353
|
categoryFilter: t.NumberC;
|
|
242
|
-
}>]
|
|
354
|
+
}>]>, t.TypeC<{
|
|
355
|
+
type: t.LiteralC<"open_helphub">;
|
|
356
|
+
}>, t.TypeC<{
|
|
357
|
+
type: t.LiteralC<"open_copilot">;
|
|
358
|
+
}>]>;
|
|
243
359
|
celebrate: t.BooleanC;
|
|
244
360
|
}>, t.PartialC<{
|
|
245
361
|
description: t.StringC;
|
|
@@ -269,10 +385,13 @@ export declare const ChecklistV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
|
|
|
269
385
|
position: t.UnionC<[t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
|
|
270
386
|
skippable: t.BooleanC;
|
|
271
387
|
open_by_default: t.BooleanC;
|
|
272
|
-
|
|
388
|
+
share_page_url_or_path: t.StringC;
|
|
389
|
+
show_in_spotlight_search: t.BooleanC;
|
|
390
|
+
show_in_helphub_search: t.BooleanC;
|
|
273
391
|
copilot_suggest: t.BooleanC;
|
|
274
392
|
copilot_cta_label: t.StringC;
|
|
275
393
|
copilot_description: t.StringC;
|
|
394
|
+
editor_tags: t.ArrayC<t.StringC>;
|
|
276
395
|
}>]>;
|
|
277
396
|
export declare class Checklist {
|
|
278
397
|
static decode: (data: any) => {
|
|
@@ -295,6 +414,7 @@ export declare class Checklist {
|
|
|
295
414
|
type: "on_event";
|
|
296
415
|
meta: {
|
|
297
416
|
event: string;
|
|
417
|
+
condition_group: import("./helpers/rules").RuleExpression | null | undefined;
|
|
298
418
|
};
|
|
299
419
|
} | {
|
|
300
420
|
type: "when_element_appears";
|
|
@@ -307,8 +427,20 @@ export declare class Checklist {
|
|
|
307
427
|
type: "on_rage_click";
|
|
308
428
|
} | {
|
|
309
429
|
type: "smart_delay";
|
|
430
|
+
} | {
|
|
431
|
+
type: "after_time";
|
|
432
|
+
meta: {
|
|
433
|
+
unit: "minute" | "second";
|
|
434
|
+
value: number;
|
|
435
|
+
};
|
|
310
436
|
} | {
|
|
311
437
|
type: "when_share_link_viewed";
|
|
438
|
+
} | {
|
|
439
|
+
type: "scheduled";
|
|
440
|
+
meta: {
|
|
441
|
+
interval: "day" | "month" | "week";
|
|
442
|
+
value: number;
|
|
443
|
+
};
|
|
312
444
|
};
|
|
313
445
|
items: ({
|
|
314
446
|
skippable: boolean;
|
|
@@ -331,31 +463,61 @@ export declare class Checklist {
|
|
|
331
463
|
expression: import("./helpers/rules").RuleExpression;
|
|
332
464
|
} | {
|
|
333
465
|
type: "cta_clicked";
|
|
334
|
-
} | {
|
|
466
|
+
} | ({
|
|
335
467
|
type: "event_tracked";
|
|
336
468
|
event: string;
|
|
337
|
-
}
|
|
469
|
+
} & {
|
|
470
|
+
condition_group?: import("./helpers/rules").RuleExpression | null | undefined;
|
|
471
|
+
});
|
|
338
472
|
action: {
|
|
339
473
|
type: "execute_command";
|
|
340
474
|
meta: {
|
|
341
475
|
command: string;
|
|
476
|
+
} & {
|
|
477
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
|
342
478
|
};
|
|
479
|
+
} | {
|
|
480
|
+
type: "click";
|
|
481
|
+
value: string;
|
|
482
|
+
} | {
|
|
483
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
484
|
+
value: string[];
|
|
343
485
|
} | ({
|
|
344
486
|
type: "link";
|
|
345
487
|
value: string;
|
|
346
488
|
} & {
|
|
347
489
|
operation?: "self" | "router" | "blank" | undefined;
|
|
348
490
|
}) | {
|
|
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";
|
|
504
|
+
} | {
|
|
349
505
|
type: "nudge";
|
|
350
506
|
value: number;
|
|
507
|
+
} | {
|
|
508
|
+
type: "go_to_step";
|
|
509
|
+
value: number;
|
|
351
510
|
} | ({
|
|
352
511
|
type: "open_bar";
|
|
353
512
|
} & {
|
|
354
513
|
value?: string | undefined;
|
|
355
514
|
categoryFilter?: number | undefined;
|
|
356
515
|
}) | {
|
|
357
|
-
type: "
|
|
358
|
-
|
|
516
|
+
type: "open_helphub";
|
|
517
|
+
} | {
|
|
518
|
+
type: "open_copilot";
|
|
519
|
+
} | {
|
|
520
|
+
type: "no_action";
|
|
359
521
|
};
|
|
360
522
|
celebrate: boolean;
|
|
361
523
|
} & {
|
|
@@ -386,10 +548,13 @@ export declare class Checklist {
|
|
|
386
548
|
position: "bottomRight" | "bottomLeft";
|
|
387
549
|
skippable: boolean;
|
|
388
550
|
open_by_default: boolean;
|
|
389
|
-
|
|
551
|
+
share_page_url_or_path: string;
|
|
552
|
+
show_in_spotlight_search: boolean;
|
|
553
|
+
show_in_helphub_search: boolean;
|
|
390
554
|
copilot_suggest: boolean;
|
|
391
555
|
copilot_cta_label: string;
|
|
392
556
|
copilot_description: string;
|
|
557
|
+
editor_tags: string[];
|
|
393
558
|
};
|
|
394
559
|
static create: (object: {
|
|
395
560
|
id: number;
|
|
@@ -411,6 +576,7 @@ export declare class Checklist {
|
|
|
411
576
|
type: "on_event";
|
|
412
577
|
meta: {
|
|
413
578
|
event: string;
|
|
579
|
+
condition_group: import("./helpers/rules").RuleExpression | null | undefined;
|
|
414
580
|
};
|
|
415
581
|
} | {
|
|
416
582
|
type: "when_element_appears";
|
|
@@ -423,8 +589,20 @@ export declare class Checklist {
|
|
|
423
589
|
type: "on_rage_click";
|
|
424
590
|
} | {
|
|
425
591
|
type: "smart_delay";
|
|
592
|
+
} | {
|
|
593
|
+
type: "after_time";
|
|
594
|
+
meta: {
|
|
595
|
+
unit: "minute" | "second";
|
|
596
|
+
value: number;
|
|
597
|
+
};
|
|
426
598
|
} | {
|
|
427
599
|
type: "when_share_link_viewed";
|
|
600
|
+
} | {
|
|
601
|
+
type: "scheduled";
|
|
602
|
+
meta: {
|
|
603
|
+
interval: "day" | "month" | "week";
|
|
604
|
+
value: number;
|
|
605
|
+
};
|
|
428
606
|
};
|
|
429
607
|
items: ({
|
|
430
608
|
skippable: boolean;
|
|
@@ -447,31 +625,61 @@ export declare class Checklist {
|
|
|
447
625
|
expression: import("./helpers/rules").RuleExpression;
|
|
448
626
|
} | {
|
|
449
627
|
type: "cta_clicked";
|
|
450
|
-
} | {
|
|
628
|
+
} | ({
|
|
451
629
|
type: "event_tracked";
|
|
452
630
|
event: string;
|
|
453
|
-
}
|
|
631
|
+
} & {
|
|
632
|
+
condition_group?: import("./helpers/rules").RuleExpression | null | undefined;
|
|
633
|
+
});
|
|
454
634
|
action: {
|
|
455
635
|
type: "execute_command";
|
|
456
636
|
meta: {
|
|
457
637
|
command: string;
|
|
638
|
+
} & {
|
|
639
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
|
458
640
|
};
|
|
641
|
+
} | {
|
|
642
|
+
type: "click";
|
|
643
|
+
value: string;
|
|
644
|
+
} | {
|
|
645
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
646
|
+
value: string[];
|
|
459
647
|
} | ({
|
|
460
648
|
type: "link";
|
|
461
649
|
value: string;
|
|
462
650
|
} & {
|
|
463
651
|
operation?: "self" | "router" | "blank" | undefined;
|
|
464
652
|
}) | {
|
|
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";
|
|
666
|
+
} | {
|
|
465
667
|
type: "nudge";
|
|
466
668
|
value: number;
|
|
669
|
+
} | {
|
|
670
|
+
type: "go_to_step";
|
|
671
|
+
value: number;
|
|
467
672
|
} | ({
|
|
468
673
|
type: "open_bar";
|
|
469
674
|
} & {
|
|
470
675
|
value?: string | undefined;
|
|
471
676
|
categoryFilter?: number | undefined;
|
|
472
677
|
}) | {
|
|
473
|
-
type: "
|
|
474
|
-
|
|
678
|
+
type: "open_helphub";
|
|
679
|
+
} | {
|
|
680
|
+
type: "open_copilot";
|
|
681
|
+
} | {
|
|
682
|
+
type: "no_action";
|
|
475
683
|
};
|
|
476
684
|
celebrate: boolean;
|
|
477
685
|
} & {
|
|
@@ -502,10 +710,13 @@ export declare class Checklist {
|
|
|
502
710
|
position: "bottomRight" | "bottomLeft";
|
|
503
711
|
skippable: boolean;
|
|
504
712
|
open_by_default: boolean;
|
|
505
|
-
|
|
713
|
+
share_page_url_or_path: string;
|
|
714
|
+
show_in_spotlight_search: boolean;
|
|
715
|
+
show_in_helphub_search: boolean;
|
|
506
716
|
copilot_suggest: boolean;
|
|
507
717
|
copilot_cta_label: string;
|
|
508
718
|
copilot_description: string;
|
|
719
|
+
editor_tags: string[];
|
|
509
720
|
}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
|
510
721
|
id: number;
|
|
511
722
|
title: string;
|
|
@@ -526,6 +737,7 @@ export declare class Checklist {
|
|
|
526
737
|
type: "on_event";
|
|
527
738
|
meta: {
|
|
528
739
|
event: string;
|
|
740
|
+
condition_group: import("./helpers/rules").RuleExpression | null | undefined;
|
|
529
741
|
};
|
|
530
742
|
} | {
|
|
531
743
|
type: "when_element_appears";
|
|
@@ -538,8 +750,20 @@ export declare class Checklist {
|
|
|
538
750
|
type: "on_rage_click";
|
|
539
751
|
} | {
|
|
540
752
|
type: "smart_delay";
|
|
753
|
+
} | {
|
|
754
|
+
type: "after_time";
|
|
755
|
+
meta: {
|
|
756
|
+
unit: "minute" | "second";
|
|
757
|
+
value: number;
|
|
758
|
+
};
|
|
541
759
|
} | {
|
|
542
760
|
type: "when_share_link_viewed";
|
|
761
|
+
} | {
|
|
762
|
+
type: "scheduled";
|
|
763
|
+
meta: {
|
|
764
|
+
interval: "day" | "month" | "week";
|
|
765
|
+
value: number;
|
|
766
|
+
};
|
|
543
767
|
};
|
|
544
768
|
items: ({
|
|
545
769
|
skippable: boolean;
|
|
@@ -562,31 +786,61 @@ export declare class Checklist {
|
|
|
562
786
|
expression: import("./helpers/rules").RuleExpression;
|
|
563
787
|
} | {
|
|
564
788
|
type: "cta_clicked";
|
|
565
|
-
} | {
|
|
789
|
+
} | ({
|
|
566
790
|
type: "event_tracked";
|
|
567
791
|
event: string;
|
|
568
|
-
}
|
|
792
|
+
} & {
|
|
793
|
+
condition_group?: import("./helpers/rules").RuleExpression | null | undefined;
|
|
794
|
+
});
|
|
569
795
|
action: {
|
|
570
796
|
type: "execute_command";
|
|
571
797
|
meta: {
|
|
572
798
|
command: string;
|
|
799
|
+
} & {
|
|
800
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
|
573
801
|
};
|
|
802
|
+
} | {
|
|
803
|
+
type: "click";
|
|
804
|
+
value: string;
|
|
805
|
+
} | {
|
|
806
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
807
|
+
value: string[];
|
|
574
808
|
} | ({
|
|
575
809
|
type: "link";
|
|
576
810
|
value: string;
|
|
577
811
|
} & {
|
|
578
812
|
operation?: "self" | "router" | "blank" | undefined;
|
|
579
813
|
}) | {
|
|
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";
|
|
827
|
+
} | {
|
|
580
828
|
type: "nudge";
|
|
581
829
|
value: number;
|
|
830
|
+
} | {
|
|
831
|
+
type: "go_to_step";
|
|
832
|
+
value: number;
|
|
582
833
|
} | ({
|
|
583
834
|
type: "open_bar";
|
|
584
835
|
} & {
|
|
585
836
|
value?: string | undefined;
|
|
586
837
|
categoryFilter?: number | undefined;
|
|
587
838
|
}) | {
|
|
588
|
-
type: "
|
|
589
|
-
|
|
839
|
+
type: "open_helphub";
|
|
840
|
+
} | {
|
|
841
|
+
type: "open_copilot";
|
|
842
|
+
} | {
|
|
843
|
+
type: "no_action";
|
|
590
844
|
};
|
|
591
845
|
celebrate: boolean;
|
|
592
846
|
} & {
|
|
@@ -617,10 +871,13 @@ export declare class Checklist {
|
|
|
617
871
|
position: "bottomRight" | "bottomLeft";
|
|
618
872
|
skippable: boolean;
|
|
619
873
|
open_by_default: boolean;
|
|
620
|
-
|
|
874
|
+
share_page_url_or_path: string;
|
|
875
|
+
show_in_spotlight_search: boolean;
|
|
876
|
+
show_in_helphub_search: boolean;
|
|
621
877
|
copilot_suggest: boolean;
|
|
622
878
|
copilot_cta_label: string;
|
|
623
879
|
copilot_description: string;
|
|
880
|
+
editor_tags: string[];
|
|
624
881
|
}>;
|
|
625
882
|
static update: (object: {
|
|
626
883
|
id: number;
|
|
@@ -642,6 +899,7 @@ export declare class Checklist {
|
|
|
642
899
|
type: "on_event";
|
|
643
900
|
meta: {
|
|
644
901
|
event: string;
|
|
902
|
+
condition_group: import("./helpers/rules").RuleExpression | null | undefined;
|
|
645
903
|
};
|
|
646
904
|
} | {
|
|
647
905
|
type: "when_element_appears";
|
|
@@ -654,8 +912,20 @@ export declare class Checklist {
|
|
|
654
912
|
type: "on_rage_click";
|
|
655
913
|
} | {
|
|
656
914
|
type: "smart_delay";
|
|
915
|
+
} | {
|
|
916
|
+
type: "after_time";
|
|
917
|
+
meta: {
|
|
918
|
+
unit: "minute" | "second";
|
|
919
|
+
value: number;
|
|
920
|
+
};
|
|
657
921
|
} | {
|
|
658
922
|
type: "when_share_link_viewed";
|
|
923
|
+
} | {
|
|
924
|
+
type: "scheduled";
|
|
925
|
+
meta: {
|
|
926
|
+
interval: "day" | "month" | "week";
|
|
927
|
+
value: number;
|
|
928
|
+
};
|
|
659
929
|
};
|
|
660
930
|
items: ({
|
|
661
931
|
skippable: boolean;
|
|
@@ -678,31 +948,61 @@ export declare class Checklist {
|
|
|
678
948
|
expression: import("./helpers/rules").RuleExpression;
|
|
679
949
|
} | {
|
|
680
950
|
type: "cta_clicked";
|
|
681
|
-
} | {
|
|
951
|
+
} | ({
|
|
682
952
|
type: "event_tracked";
|
|
683
953
|
event: string;
|
|
684
|
-
}
|
|
954
|
+
} & {
|
|
955
|
+
condition_group?: import("./helpers/rules").RuleExpression | null | undefined;
|
|
956
|
+
});
|
|
685
957
|
action: {
|
|
686
958
|
type: "execute_command";
|
|
687
959
|
meta: {
|
|
688
960
|
command: string;
|
|
961
|
+
} & {
|
|
962
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
|
689
963
|
};
|
|
964
|
+
} | {
|
|
965
|
+
type: "click";
|
|
966
|
+
value: string;
|
|
967
|
+
} | {
|
|
968
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
969
|
+
value: string[];
|
|
690
970
|
} | ({
|
|
691
971
|
type: "link";
|
|
692
972
|
value: string;
|
|
693
973
|
} & {
|
|
694
974
|
operation?: "self" | "router" | "blank" | undefined;
|
|
695
975
|
}) | {
|
|
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";
|
|
989
|
+
} | {
|
|
696
990
|
type: "nudge";
|
|
697
991
|
value: number;
|
|
992
|
+
} | {
|
|
993
|
+
type: "go_to_step";
|
|
994
|
+
value: number;
|
|
698
995
|
} | ({
|
|
699
996
|
type: "open_bar";
|
|
700
997
|
} & {
|
|
701
998
|
value?: string | undefined;
|
|
702
999
|
categoryFilter?: number | undefined;
|
|
703
1000
|
}) | {
|
|
704
|
-
type: "
|
|
705
|
-
|
|
1001
|
+
type: "open_helphub";
|
|
1002
|
+
} | {
|
|
1003
|
+
type: "open_copilot";
|
|
1004
|
+
} | {
|
|
1005
|
+
type: "no_action";
|
|
706
1006
|
};
|
|
707
1007
|
celebrate: boolean;
|
|
708
1008
|
} & {
|
|
@@ -733,10 +1033,13 @@ export declare class Checklist {
|
|
|
733
1033
|
position: "bottomRight" | "bottomLeft";
|
|
734
1034
|
skippable: boolean;
|
|
735
1035
|
open_by_default: boolean;
|
|
736
|
-
|
|
1036
|
+
share_page_url_or_path: string;
|
|
1037
|
+
show_in_spotlight_search: boolean;
|
|
1038
|
+
show_in_helphub_search: boolean;
|
|
737
1039
|
copilot_suggest: boolean;
|
|
738
1040
|
copilot_cta_label: string;
|
|
739
1041
|
copilot_description: string;
|
|
1042
|
+
editor_tags: string[];
|
|
740
1043
|
}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
|
741
1044
|
id: number;
|
|
742
1045
|
title: string;
|
|
@@ -757,6 +1060,7 @@ export declare class Checklist {
|
|
|
757
1060
|
type: "on_event";
|
|
758
1061
|
meta: {
|
|
759
1062
|
event: string;
|
|
1063
|
+
condition_group: import("./helpers/rules").RuleExpression | null | undefined;
|
|
760
1064
|
};
|
|
761
1065
|
} | {
|
|
762
1066
|
type: "when_element_appears";
|
|
@@ -769,8 +1073,20 @@ export declare class Checklist {
|
|
|
769
1073
|
type: "on_rage_click";
|
|
770
1074
|
} | {
|
|
771
1075
|
type: "smart_delay";
|
|
1076
|
+
} | {
|
|
1077
|
+
type: "after_time";
|
|
1078
|
+
meta: {
|
|
1079
|
+
unit: "minute" | "second";
|
|
1080
|
+
value: number;
|
|
1081
|
+
};
|
|
772
1082
|
} | {
|
|
773
1083
|
type: "when_share_link_viewed";
|
|
1084
|
+
} | {
|
|
1085
|
+
type: "scheduled";
|
|
1086
|
+
meta: {
|
|
1087
|
+
interval: "day" | "month" | "week";
|
|
1088
|
+
value: number;
|
|
1089
|
+
};
|
|
774
1090
|
};
|
|
775
1091
|
items: ({
|
|
776
1092
|
skippable: boolean;
|
|
@@ -793,31 +1109,61 @@ export declare class Checklist {
|
|
|
793
1109
|
expression: import("./helpers/rules").RuleExpression;
|
|
794
1110
|
} | {
|
|
795
1111
|
type: "cta_clicked";
|
|
796
|
-
} | {
|
|
1112
|
+
} | ({
|
|
797
1113
|
type: "event_tracked";
|
|
798
1114
|
event: string;
|
|
799
|
-
}
|
|
1115
|
+
} & {
|
|
1116
|
+
condition_group?: import("./helpers/rules").RuleExpression | null | undefined;
|
|
1117
|
+
});
|
|
800
1118
|
action: {
|
|
801
1119
|
type: "execute_command";
|
|
802
1120
|
meta: {
|
|
803
1121
|
command: string;
|
|
1122
|
+
} & {
|
|
1123
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
|
804
1124
|
};
|
|
1125
|
+
} | {
|
|
1126
|
+
type: "click";
|
|
1127
|
+
value: string;
|
|
1128
|
+
} | {
|
|
1129
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
1130
|
+
value: string[];
|
|
805
1131
|
} | ({
|
|
806
1132
|
type: "link";
|
|
807
1133
|
value: string;
|
|
808
1134
|
} & {
|
|
809
1135
|
operation?: "self" | "router" | "blank" | undefined;
|
|
810
1136
|
}) | {
|
|
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";
|
|
1150
|
+
} | {
|
|
811
1151
|
type: "nudge";
|
|
812
1152
|
value: number;
|
|
1153
|
+
} | {
|
|
1154
|
+
type: "go_to_step";
|
|
1155
|
+
value: number;
|
|
813
1156
|
} | ({
|
|
814
1157
|
type: "open_bar";
|
|
815
1158
|
} & {
|
|
816
1159
|
value?: string | undefined;
|
|
817
1160
|
categoryFilter?: number | undefined;
|
|
818
1161
|
}) | {
|
|
819
|
-
type: "
|
|
820
|
-
|
|
1162
|
+
type: "open_helphub";
|
|
1163
|
+
} | {
|
|
1164
|
+
type: "open_copilot";
|
|
1165
|
+
} | {
|
|
1166
|
+
type: "no_action";
|
|
821
1167
|
};
|
|
822
1168
|
celebrate: boolean;
|
|
823
1169
|
} & {
|
|
@@ -848,10 +1194,13 @@ export declare class Checklist {
|
|
|
848
1194
|
position: "bottomRight" | "bottomLeft";
|
|
849
1195
|
skippable: boolean;
|
|
850
1196
|
open_by_default: boolean;
|
|
851
|
-
|
|
1197
|
+
share_page_url_or_path: string;
|
|
1198
|
+
show_in_spotlight_search: boolean;
|
|
1199
|
+
show_in_helphub_search: boolean;
|
|
852
1200
|
copilot_suggest: boolean;
|
|
853
1201
|
copilot_cta_label: string;
|
|
854
1202
|
copilot_description: string;
|
|
1203
|
+
editor_tags: string[];
|
|
855
1204
|
}>;
|
|
856
1205
|
static delete: (id: string | number, params?: Record<string, string> | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
|
|
857
1206
|
static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
|
|
@@ -874,6 +1223,7 @@ export declare class Checklist {
|
|
|
874
1223
|
type: "on_event";
|
|
875
1224
|
meta: {
|
|
876
1225
|
event: string;
|
|
1226
|
+
condition_group: import("./helpers/rules").RuleExpression | null | undefined;
|
|
877
1227
|
};
|
|
878
1228
|
} | {
|
|
879
1229
|
type: "when_element_appears";
|
|
@@ -886,8 +1236,20 @@ export declare class Checklist {
|
|
|
886
1236
|
type: "on_rage_click";
|
|
887
1237
|
} | {
|
|
888
1238
|
type: "smart_delay";
|
|
1239
|
+
} | {
|
|
1240
|
+
type: "after_time";
|
|
1241
|
+
meta: {
|
|
1242
|
+
unit: "minute" | "second";
|
|
1243
|
+
value: number;
|
|
1244
|
+
};
|
|
889
1245
|
} | {
|
|
890
1246
|
type: "when_share_link_viewed";
|
|
1247
|
+
} | {
|
|
1248
|
+
type: "scheduled";
|
|
1249
|
+
meta: {
|
|
1250
|
+
interval: "day" | "month" | "week";
|
|
1251
|
+
value: number;
|
|
1252
|
+
};
|
|
891
1253
|
};
|
|
892
1254
|
items: ({
|
|
893
1255
|
skippable: boolean;
|
|
@@ -910,31 +1272,61 @@ export declare class Checklist {
|
|
|
910
1272
|
expression: import("./helpers/rules").RuleExpression;
|
|
911
1273
|
} | {
|
|
912
1274
|
type: "cta_clicked";
|
|
913
|
-
} | {
|
|
1275
|
+
} | ({
|
|
914
1276
|
type: "event_tracked";
|
|
915
1277
|
event: string;
|
|
916
|
-
}
|
|
1278
|
+
} & {
|
|
1279
|
+
condition_group?: import("./helpers/rules").RuleExpression | null | undefined;
|
|
1280
|
+
});
|
|
917
1281
|
action: {
|
|
918
1282
|
type: "execute_command";
|
|
919
1283
|
meta: {
|
|
920
1284
|
command: string;
|
|
1285
|
+
} & {
|
|
1286
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
|
921
1287
|
};
|
|
1288
|
+
} | {
|
|
1289
|
+
type: "click";
|
|
1290
|
+
value: string;
|
|
1291
|
+
} | {
|
|
1292
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
1293
|
+
value: string[];
|
|
922
1294
|
} | ({
|
|
923
1295
|
type: "link";
|
|
924
1296
|
value: string;
|
|
925
1297
|
} & {
|
|
926
1298
|
operation?: "self" | "router" | "blank" | undefined;
|
|
927
1299
|
}) | {
|
|
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";
|
|
1313
|
+
} | {
|
|
928
1314
|
type: "nudge";
|
|
929
1315
|
value: number;
|
|
1316
|
+
} | {
|
|
1317
|
+
type: "go_to_step";
|
|
1318
|
+
value: number;
|
|
930
1319
|
} | ({
|
|
931
1320
|
type: "open_bar";
|
|
932
1321
|
} & {
|
|
933
1322
|
value?: string | undefined;
|
|
934
1323
|
categoryFilter?: number | undefined;
|
|
935
1324
|
}) | {
|
|
936
|
-
type: "
|
|
937
|
-
|
|
1325
|
+
type: "open_helphub";
|
|
1326
|
+
} | {
|
|
1327
|
+
type: "open_copilot";
|
|
1328
|
+
} | {
|
|
1329
|
+
type: "no_action";
|
|
938
1330
|
};
|
|
939
1331
|
celebrate: boolean;
|
|
940
1332
|
} & {
|
|
@@ -965,10 +1357,13 @@ export declare class Checklist {
|
|
|
965
1357
|
position: "bottomRight" | "bottomLeft";
|
|
966
1358
|
skippable: boolean;
|
|
967
1359
|
open_by_default: boolean;
|
|
968
|
-
|
|
1360
|
+
share_page_url_or_path: string;
|
|
1361
|
+
show_in_spotlight_search: boolean;
|
|
1362
|
+
show_in_helphub_search: boolean;
|
|
969
1363
|
copilot_suggest: boolean;
|
|
970
1364
|
copilot_cta_label: string;
|
|
971
1365
|
copilot_description: string;
|
|
1366
|
+
editor_tags: string[];
|
|
972
1367
|
})[]>;
|
|
973
1368
|
static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
|
|
974
1369
|
onSuccess?: (() => void) | undefined;
|
|
@@ -993,6 +1388,7 @@ export declare class Checklist {
|
|
|
993
1388
|
type: "on_event";
|
|
994
1389
|
meta: {
|
|
995
1390
|
event: string;
|
|
1391
|
+
condition_group: import("./helpers/rules").RuleExpression | null | undefined;
|
|
996
1392
|
};
|
|
997
1393
|
} | {
|
|
998
1394
|
type: "when_element_appears";
|
|
@@ -1005,8 +1401,20 @@ export declare class Checklist {
|
|
|
1005
1401
|
type: "on_rage_click";
|
|
1006
1402
|
} | {
|
|
1007
1403
|
type: "smart_delay";
|
|
1404
|
+
} | {
|
|
1405
|
+
type: "after_time";
|
|
1406
|
+
meta: {
|
|
1407
|
+
unit: "minute" | "second";
|
|
1408
|
+
value: number;
|
|
1409
|
+
};
|
|
1008
1410
|
} | {
|
|
1009
1411
|
type: "when_share_link_viewed";
|
|
1412
|
+
} | {
|
|
1413
|
+
type: "scheduled";
|
|
1414
|
+
meta: {
|
|
1415
|
+
interval: "day" | "month" | "week";
|
|
1416
|
+
value: number;
|
|
1417
|
+
};
|
|
1010
1418
|
};
|
|
1011
1419
|
items: ({
|
|
1012
1420
|
skippable: boolean;
|
|
@@ -1029,31 +1437,61 @@ export declare class Checklist {
|
|
|
1029
1437
|
expression: import("./helpers/rules").RuleExpression;
|
|
1030
1438
|
} | {
|
|
1031
1439
|
type: "cta_clicked";
|
|
1032
|
-
} | {
|
|
1440
|
+
} | ({
|
|
1033
1441
|
type: "event_tracked";
|
|
1034
1442
|
event: string;
|
|
1035
|
-
}
|
|
1443
|
+
} & {
|
|
1444
|
+
condition_group?: import("./helpers/rules").RuleExpression | null | undefined;
|
|
1445
|
+
});
|
|
1036
1446
|
action: {
|
|
1037
1447
|
type: "execute_command";
|
|
1038
1448
|
meta: {
|
|
1039
1449
|
command: string;
|
|
1450
|
+
} & {
|
|
1451
|
+
type?: "link" | "video" | "action" | "helpdoc" | undefined;
|
|
1040
1452
|
};
|
|
1453
|
+
} | {
|
|
1454
|
+
type: "click";
|
|
1455
|
+
value: string;
|
|
1456
|
+
} | {
|
|
1457
|
+
type: "click" | "clickBySelector" | "clickByXpath";
|
|
1458
|
+
value: string[];
|
|
1041
1459
|
} | ({
|
|
1042
1460
|
type: "link";
|
|
1043
1461
|
value: string;
|
|
1044
1462
|
} & {
|
|
1045
1463
|
operation?: "self" | "router" | "blank" | undefined;
|
|
1046
1464
|
}) | {
|
|
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";
|
|
1478
|
+
} | {
|
|
1047
1479
|
type: "nudge";
|
|
1048
1480
|
value: number;
|
|
1481
|
+
} | {
|
|
1482
|
+
type: "go_to_step";
|
|
1483
|
+
value: number;
|
|
1049
1484
|
} | ({
|
|
1050
1485
|
type: "open_bar";
|
|
1051
1486
|
} & {
|
|
1052
1487
|
value?: string | undefined;
|
|
1053
1488
|
categoryFilter?: number | undefined;
|
|
1054
1489
|
}) | {
|
|
1055
|
-
type: "
|
|
1056
|
-
|
|
1490
|
+
type: "open_helphub";
|
|
1491
|
+
} | {
|
|
1492
|
+
type: "open_copilot";
|
|
1493
|
+
} | {
|
|
1494
|
+
type: "no_action";
|
|
1057
1495
|
};
|
|
1058
1496
|
celebrate: boolean;
|
|
1059
1497
|
} & {
|
|
@@ -1084,9 +1522,12 @@ export declare class Checklist {
|
|
|
1084
1522
|
position: "bottomRight" | "bottomLeft";
|
|
1085
1523
|
skippable: boolean;
|
|
1086
1524
|
open_by_default: boolean;
|
|
1087
|
-
|
|
1525
|
+
share_page_url_or_path: string;
|
|
1526
|
+
show_in_spotlight_search: boolean;
|
|
1527
|
+
show_in_helphub_search: boolean;
|
|
1088
1528
|
copilot_suggest: boolean;
|
|
1089
1529
|
copilot_cta_label: string;
|
|
1090
1530
|
copilot_description: string;
|
|
1531
|
+
editor_tags: string[];
|
|
1091
1532
|
}>;
|
|
1092
1533
|
}
|