@wix/auto_sdk_automations_activations 1.0.54 → 1.0.56

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.
Files changed (37) hide show
  1. package/build/cjs/index.d.ts +1 -1
  2. package/build/cjs/index.js +4 -0
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +42 -11
  5. package/build/cjs/index.typings.js +4 -0
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +2321 -19
  8. package/build/cjs/meta.js +201 -0
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +1 -1
  11. package/build/es/index.mjs +4 -0
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +42 -11
  14. package/build/es/index.typings.mjs +4 -0
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +2321 -19
  17. package/build/es/meta.mjs +180 -0
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/internal/cjs/index.d.ts +1 -1
  20. package/build/internal/cjs/index.js +4 -0
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +42 -11
  23. package/build/internal/cjs/index.typings.js +4 -0
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +2321 -19
  26. package/build/internal/cjs/meta.js +201 -0
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/internal/es/index.d.mts +1 -1
  29. package/build/internal/es/index.mjs +4 -0
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +42 -11
  32. package/build/internal/es/index.typings.mjs +4 -0
  33. package/build/internal/es/index.typings.mjs.map +1 -1
  34. package/build/internal/es/meta.d.mts +2321 -19
  35. package/build/internal/es/meta.mjs +180 -0
  36. package/build/internal/es/meta.mjs.map +1 -1
  37. package/package.json +3 -3
@@ -1,35 +1,1719 @@
1
1
  import { ReportEventRequest as ReportEventRequest$1, ReportEventResponse as ReportEventResponse$1, BulkReportEventRequest as BulkReportEventRequest$1, BulkReportEventResponse as BulkReportEventResponse$1, BulkCancelEventRequest as BulkCancelEventRequest$1, BulkCancelEventResponse as BulkCancelEventResponse$1, CancelEventRequest as CancelEventRequest$1, CancelEventResponse as CancelEventResponse$1 } from './index.typings.mjs';
2
2
  import '@wix/sdk-types';
3
3
 
4
+ interface Activation {
5
+ /**
6
+ * Activation ID
7
+ * @format GUID
8
+ */
9
+ id?: string;
10
+ /** Activation automation */
11
+ automation?: Automation;
12
+ }
13
+ interface Automation extends AutomationOriginInfoOneOf {
14
+ /** When the origin of the automation is `APPLICATION`, the details of the app that created it. */
15
+ applicationInfo?: ApplicationOrigin;
16
+ /** When the origin of the automation is `PREINSTALLED`, the details of the preinstalled automation. */
17
+ preinstalledInfo?: PreinstalledOrigin;
18
+ /**
19
+ * Automation ID.
20
+ * @format GUID
21
+ * @readonly
22
+ */
23
+ id?: string | null;
24
+ /**
25
+ * Revision number. This increments by 1 whenever the automation is updated. Specify the current revision number whenever updating an existing automation.
26
+ * @readonly
27
+ */
28
+ revision?: string | null;
29
+ /**
30
+ * Who created the automation.
31
+ * @immutable
32
+ * @readonly
33
+ */
34
+ createdBy?: AuditInfo;
35
+ /**
36
+ * When the automation was created.
37
+ * @readonly
38
+ */
39
+ createdDate?: Date | null;
40
+ /**
41
+ * Who last updated the automation.
42
+ * @readonly
43
+ */
44
+ updatedBy?: AuditInfo;
45
+ /**
46
+ * When the automation was last updated.
47
+ * @readonly
48
+ */
49
+ updatedDate?: Date | null;
50
+ /**
51
+ * Automation name as displayed on the user's site.
52
+ * @minLength 1
53
+ * @maxLength 500
54
+ */
55
+ name?: string;
56
+ /**
57
+ * Automation description.
58
+ * @maxLength 2000
59
+ */
60
+ description?: string | null;
61
+ /** Automation configuration. */
62
+ configuration?: AutomationConfiguration;
63
+ /**
64
+ * How the automation was added to the user's site.
65
+ * @immutable
66
+ */
67
+ origin?: OriginWithLiterals;
68
+ /** Automation settings. */
69
+ settings?: AutomationSettings;
70
+ /**
71
+ * When the automation is a draft, the draft details.
72
+ * @readonly
73
+ */
74
+ draftInfo?: DraftInfo;
75
+ /**
76
+ * Whether the automation is archived.
77
+ *
78
+ * To archive an automation, set this to `true`. To restore an archived automation, set this to `false`.
79
+ */
80
+ archived?: boolean;
81
+ /** Auto archive policy */
82
+ autoArchivePolicy?: AutoArchivePolicy;
83
+ }
84
+ /** @oneof */
85
+ interface AutomationOriginInfoOneOf {
86
+ /** When the origin of the automation is `APPLICATION`, the details of the app that created it. */
87
+ applicationInfo?: ApplicationOrigin;
88
+ /** When the origin of the automation is `PREINSTALLED`, the details of the preinstalled automation. */
89
+ preinstalledInfo?: PreinstalledOrigin;
90
+ }
91
+ interface AIMetadata {
92
+ }
93
+ interface ActionSettings {
94
+ /**
95
+ * Permanent actions. PermanentAction's skipActionExpression cannot be modified.
96
+ *
97
+ * When empty, all actions can be set as skipped
98
+ * @maxSize 30
99
+ * @format GUID
100
+ */
101
+ permanentActionIds?: string[];
102
+ /**
103
+ * Read-only actions. Read-only actions cannot be edited.
104
+ *
105
+ * When empty, all actions are editable.
106
+ * @maxSize 30
107
+ * @format GUID
108
+ */
109
+ readonlyActionIds?: string[];
110
+ /**
111
+ * Whether to disable the ability to add a delay to the automation.
112
+ *
113
+ * Default: `false`.
114
+ */
115
+ disableDelayAddition?: boolean;
116
+ /**
117
+ * Whether to disable the ability to add a condition to the automation.
118
+ *
119
+ * Default: `false`.
120
+ */
121
+ disableConditionAddition?: boolean;
122
+ }
123
+ declare enum Domain {
124
+ /** User domain (default). */
125
+ USER = "USER",
126
+ /** Wix domain. */
127
+ WIX = "WIX",
128
+ /** Wix account-level domain. */
129
+ WIX_ACCOUNT = "WIX_ACCOUNT"
130
+ }
131
+ /** @enumType */
132
+ type DomainWithLiterals = Domain | 'USER' | 'WIX' | 'WIX_ACCOUNT';
133
+ interface Enrichment {
134
+ /**
135
+ * Enrichment input mappings.
136
+ * @maxSize 2
137
+ */
138
+ inputMappings?: Record<string, any>[] | null;
139
+ }
140
+ interface AuditInfo extends AuditInfoIdOneOf {
141
+ /**
142
+ * [User ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#user-id).
143
+ * @format GUID
144
+ */
145
+ userId?: string;
146
+ /**
147
+ * [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
148
+ *
149
+ * You can find the app ID on the [Home page](https://manage.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%home) in the app's dashboard.
150
+ * @format GUID
151
+ */
152
+ appId?: string;
153
+ }
154
+ /** @oneof */
155
+ interface AuditInfoIdOneOf {
156
+ /**
157
+ * [User ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#user-id).
158
+ * @format GUID
159
+ */
160
+ userId?: string;
161
+ /**
162
+ * [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
163
+ *
164
+ * You can find the app ID on the [Home page](https://manage.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%home) in the app's dashboard.
165
+ * @format GUID
166
+ */
167
+ appId?: string;
168
+ }
169
+ interface AutomationConfiguration {
170
+ /** Status of the automation on the site. */
171
+ status?: AutomationConfigurationStatusWithLiterals;
172
+ /** Trigger configuration. */
173
+ trigger?: Trigger;
174
+ /**
175
+ * Root action IDs. A root action is the first action that runs after the trigger occurs. Root actions run in parallel.
176
+ *
177
+ * > **Note**: You can currently only specify 1 root action.
178
+ * @maxSize 20
179
+ * @format GUID
180
+ */
181
+ rootActionIds?: string[];
182
+ /** Actions the automation can execute, as `key:value` pairs. For the key, specify the action ID. The value must be an object structured as described below. */
183
+ actions?: Record<string, AutomationConfigurationAction>;
184
+ }
185
+ declare enum TimeUnit {
186
+ UNKNOWN_TIME_UNIT = "UNKNOWN_TIME_UNIT",
187
+ /** Minutes. */
188
+ MINUTES = "MINUTES",
189
+ /** Hours. */
190
+ HOURS = "HOURS",
191
+ /** Days. */
192
+ DAYS = "DAYS",
193
+ /** Weeks. */
194
+ WEEKS = "WEEKS",
195
+ /** Months. */
196
+ MONTHS = "MONTHS"
197
+ }
198
+ /** @enumType */
199
+ type TimeUnitWithLiterals = TimeUnit | 'UNKNOWN_TIME_UNIT' | 'MINUTES' | 'HOURS' | 'DAYS' | 'WEEKS' | 'MONTHS';
200
+ interface Filter {
201
+ /**
202
+ * Filter ID.
203
+ * @format GUID
204
+ */
205
+ id?: string;
206
+ /**
207
+ * Field key.
208
+ *
209
+ * You can find the field key in [the trigger payload schema](https://dev.wix.com/docs/rest/business-management/automations/triggers/the-trigger-payload-schema).
210
+ * @minLength 1
211
+ * @maxLength 110
212
+ */
213
+ fieldKey?: string;
214
+ /**
215
+ * Filter expression.
216
+ *
217
+ * For the automation to run, the expression must evaluate to `true`.
218
+ * @maxLength 2500
219
+ */
220
+ filterExpression?: string;
221
+ }
222
+ interface FutureDateActivationOffset {
223
+ /**
224
+ * Amount of time before the trigger to run the automation.
225
+ *
226
+ * > **Note**: To delay an automation after the trigger event occurs, use a [delay action](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/configure-your-automation#delay-action).
227
+ * @maxLength 1000
228
+ */
229
+ preScheduledEventOffsetExpression?: string;
230
+ /** Unit in which to set the action offset. */
231
+ scheduledEventOffsetTimeUnit?: TimeUnitWithLiterals;
232
+ }
233
+ interface RateLimit {
234
+ /**
235
+ * Maximum number of times the trigger can be activated.
236
+ * @maxLength 1000
237
+ */
238
+ maxActivationsExpression?: string;
239
+ /**
240
+ * Duration of the rate limit. The rate limit applies for the specified duration and then expires.
241
+ *
242
+ * When empty, the rate limit does not expire.
243
+ * @maxLength 1000
244
+ */
245
+ durationExpression?: string | null;
246
+ /** Unit in which to set the duration of the rate limit. */
247
+ durationTimeUnit?: TimeUnitWithLiterals;
248
+ /**
249
+ * Activation identifier used to count the number of activations.
250
+ * @minLength 1
251
+ * @maxLength 400
252
+ */
253
+ uniqueIdentifierExpression?: string | null;
254
+ }
255
+ interface FilterValueSelection {
256
+ /**
257
+ * Values that can help the user filter certain automations. Specify values in the following format: `<filter_id>__<selected_value>`.
258
+ * @maxLength 80
259
+ * @maxSize 50
260
+ */
261
+ selectedFilterValues?: string[];
262
+ }
263
+ interface ConditionExpressionGroup {
264
+ /** Logical operator used to evaluate the condition expressions. */
265
+ operator?: OperatorWithLiterals;
266
+ /**
267
+ * Expressions evaluated using the selected operator.
268
+ * @minSize 1
269
+ * @maxSize 20
270
+ * @maxLength 2500
271
+ */
272
+ booleanExpressions?: string[];
273
+ }
274
+ declare enum Operator {
275
+ /** Unknown. */
276
+ UNKNOWN_OPERATOR = "UNKNOWN_OPERATOR",
277
+ /** `OR` operator. */
278
+ OR = "OR",
279
+ /** `AND` operator. */
280
+ AND = "AND"
281
+ }
282
+ /** @enumType */
283
+ type OperatorWithLiterals = Operator | 'UNKNOWN_OPERATOR' | 'OR' | 'AND';
284
+ interface ActionCodeSnippet {
285
+ /** Logical operator used to evaluate the condition expressions. */
286
+ language?: CodeSnippetLanguageWithLiterals;
287
+ /**
288
+ * Expressions evaluated using the selected operator. this code should comply the language syntax. and format
289
+ * @maxLength 1000
290
+ */
291
+ code?: string;
292
+ }
293
+ declare enum CodeSnippetLanguage {
294
+ /** Unknown. */
295
+ UNKNOWN_LANGUAGE = "UNKNOWN_LANGUAGE",
296
+ /** JavaScript. */
297
+ JAVASCRIPT = "JAVASCRIPT"
298
+ }
299
+ /** @enumType */
300
+ type CodeSnippetLanguageWithLiterals = CodeSnippetLanguage | 'UNKNOWN_LANGUAGE' | 'JAVASCRIPT';
301
+ /** Path definition */
302
+ interface SplitActionPath {
303
+ /**
304
+ * Unique path ID.
305
+ * @format GUID
306
+ */
307
+ id?: string;
308
+ /**
309
+ * Path display name.
310
+ * @minLength 1
311
+ * @maxLength 100
312
+ */
313
+ name?: string;
314
+ /**
315
+ * ID of the action to run when this path is taken.
316
+ * @format GUID
317
+ */
318
+ postActionId?: string | null;
319
+ }
320
+ declare enum Type {
321
+ /** Based on the trigger. */
322
+ UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
323
+ /** Defined by a [Wix app](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/configure-your-automation#app-defined-action). This action type is available in the site dashboard. */
324
+ APP_DEFINED = "APP_DEFINED",
325
+ /** Condition. This determines which action runs next. */
326
+ CONDITION = "CONDITION",
327
+ /** Delay. The automation must wait before executing the next step. */
328
+ DELAY = "DELAY",
329
+ /** Rate-limiter. This stops the automation flow if the subsequent action has reached its maximum allowed executions. */
330
+ RATE_LIMIT = "RATE_LIMIT"
331
+ }
332
+ /** @enumType */
333
+ type TypeWithLiterals = Type | 'UNKNOWN_ACTION_TYPE' | 'APP_DEFINED' | 'CONDITION' | 'DELAY' | 'RATE_LIMIT';
334
+ interface AppDefinedAction {
335
+ /**
336
+ * ID of the app that defines the action.
337
+ * @format GUID
338
+ */
339
+ appId?: string;
340
+ /**
341
+ * Action key.
342
+ * @minLength 1
343
+ * @maxLength 100
344
+ */
345
+ actionKey?: string;
346
+ /**
347
+ * Action input mapping as defined in the action's [input schema](https://dev.wix.com/docs/rest/business-management/automations/actions/the-action-input-schema).
348
+ *
349
+ * The input mapping must include all parameters specified in the action's input schema's `required` array, and can include any other parameters from the schema.
350
+ */
351
+ inputMapping?: Record<string, any> | null;
352
+ /**
353
+ * Action skip conditions. An action is skipped if any of the specified conditions evaluates to `true`.
354
+ *
355
+ * > **Note**: Actions that follow a skipped action still run.
356
+ * @maxSize 10
357
+ * @deprecated Action skip conditions. An action is skipped if any of the specified conditions evaluates to `true`.
358
+ *
359
+ * > **Note**: Actions that follow a skipped action still run.
360
+ * @replacedBy skip_expression
361
+ * @targetRemovalDate 2026-02-01
362
+ */
363
+ skipConditionOrExpressionGroups?: ConditionExpressionGroup[];
364
+ /**
365
+ * IDs of actions that run in parallel after the action completes.
366
+ * @maxSize 1
367
+ * @format GUID
368
+ */
369
+ postActionIds?: string[];
370
+ /** Action output schema. When specified, this replaces the action schema. */
371
+ overrideOutputSchema?: Record<string, any> | null;
372
+ }
373
+ interface ConditionAction {
374
+ /**
375
+ * Condition is `true` if one or more of the expression groups evaluates to `true`.
376
+ * @minSize 1
377
+ * @maxSize 10
378
+ */
379
+ orExpressionGroups?: ConditionExpressionGroup[];
380
+ /**
381
+ * IDs of actions to run when the condition evaluates to `true`.
382
+ * @maxSize 1
383
+ * @format GUID
384
+ */
385
+ truePostActionIds?: string[];
386
+ /**
387
+ * IDs of actions to run when the condition evaluates to `false`.
388
+ * @maxSize 1
389
+ * @format GUID
390
+ */
391
+ falsePostActionIds?: string[];
392
+ }
393
+ interface CodeConditionAction {
394
+ /** condition code. This is a code that can be used to identify the condition in the automation. code should return a boolean value. otherwise the value will be tried to be casted to boolean. */
395
+ snippet?: ActionCodeSnippet;
396
+ /**
397
+ * IDs of actions to run when the condition evaluates to `true`.
398
+ * @maxSize 1
399
+ * @format GUID
400
+ */
401
+ truePostActionIds?: string[];
402
+ /**
403
+ * IDs of actions to run when the condition evaluates to `false`.
404
+ * @maxSize 1
405
+ * @format GUID
406
+ */
407
+ falsePostActionIds?: string[];
408
+ }
409
+ interface DelayAction {
410
+ /**
411
+ * Time to wait before running the action. The wait time starts from when the current action completes.
412
+ *
413
+ * > **Note**: To define the wait time from a specific moment in time, use `dueDateExpression`.
414
+ * @maxLength 1000
415
+ */
416
+ offsetExpression?: string | null;
417
+ /** Unit in which to set the wait time to wait before the action runs. */
418
+ offsetTimeUnit?: TimeUnitWithLiterals;
419
+ /**
420
+ * Action run date in milliseconds elapsed since January 1, 1970 UTC.
421
+ *
422
+ * > **Note**: If an `offsetExpression` is defined, the delay is calculated from the time of the offset.
423
+ * @maxLength 1000
424
+ * @deprecated Action run date in milliseconds elapsed since January 1, 1970 UTC.
425
+ *
426
+ * > **Note**: If an `offsetExpression` is defined, the delay is calculated from the time of the offset.
427
+ * @replacedBy due_date_expression
428
+ * @targetRemovalDate 2026-02-01
429
+ */
430
+ dueDateEpochExpression?: string | null;
431
+ /**
432
+ * Action run date as a timestamp or DateTime expression using bracket notation.
433
+ *
434
+ * > **Note**: If an `offsetExpression` is defined, the delay is calculated from the time of the offset.
435
+ * @maxLength 1000
436
+ */
437
+ dueDateExpression?: string | null;
438
+ /**
439
+ * IDs of actions to run in parallel after the time delay.
440
+ * @maxSize 1
441
+ * @format GUID
442
+ */
443
+ postActionIds?: string[];
444
+ }
445
+ interface RateLimitAction {
446
+ /**
447
+ * Maximum number of times the action can run.
448
+ * @maxLength 1000
449
+ */
450
+ maxActivationsExpression?: string;
451
+ /**
452
+ * Rate limit duration.
453
+ *
454
+ * When empty, the rate limit does not expire.
455
+ * @maxLength 1000
456
+ */
457
+ rateLimitDurationExpression?: string | null;
458
+ /** Unit in which to set the duration of the rate limit. */
459
+ rateLimitDurationTimeUnit?: TimeUnitWithLiterals;
460
+ /**
461
+ * Unique identifier of each activation by which rate limiter counts activations.
462
+ * @minLength 1
463
+ * @maxLength 400
464
+ */
465
+ uniqueIdentifierExpression?: string | null;
466
+ /**
467
+ * IDs of actions to run in parallel after the action completes.
468
+ * @maxSize 1
469
+ * @format GUID
470
+ */
471
+ postActionIds?: string[];
472
+ }
473
+ interface SetVariablesAction {
474
+ /** Output mapping. For example: `{"someField": "{{10}}", "someOtherField": "{{multiply( var('account.points.balance') ;2 )}}" }`. */
475
+ outputMapping?: Record<string, any> | null;
476
+ /**
477
+ * Output JSON schema representation.
478
+ *
479
+ * > **Note**: To minimize request size, you can also specify a string.
480
+ */
481
+ outputSchema?: Record<string, any> | null;
482
+ /**
483
+ * IDs of actions to run in parallel after variable initialization.
484
+ * @maxSize 1
485
+ * @format GUID
486
+ */
487
+ postActionIds?: string[];
488
+ }
489
+ interface OutputAction {
490
+ /** Output action output mapping. */
491
+ outputMapping?: Record<string, any> | null;
492
+ }
493
+ interface ActionSplitAction {
494
+ /**
495
+ * List of paths to split execution into.
496
+ * @minSize 2
497
+ * @maxSize 10
498
+ */
499
+ paths?: SplitActionPath[];
500
+ }
501
+ declare enum AutomationConfigurationStatus {
502
+ /** Unknown. */
503
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
504
+ /** Active. Active automations can be triggered. */
505
+ ACTIVE = "ACTIVE",
506
+ /** Inactive. Inactive automations cannot be triggered. */
507
+ INACTIVE = "INACTIVE"
508
+ }
509
+ /** @enumType */
510
+ type AutomationConfigurationStatusWithLiterals = AutomationConfigurationStatus | 'UNKNOWN_STATUS' | 'ACTIVE' | 'INACTIVE';
511
+ interface Trigger {
512
+ /**
513
+ * ID of the app that defines the trigger.
514
+ * @format GUID
515
+ */
516
+ appId?: string;
517
+ /**
518
+ * Trigger key.
519
+ *
520
+ * Learn about [setting up a trigger](https://dev.wix.com/docs/rest/business-management/automations/triggers/add-a-trigger-to-your-app#step-1--set-up-the-trigger).
521
+ * @minLength 1
522
+ * @maxLength 100
523
+ */
524
+ triggerKey?: string;
525
+ /**
526
+ * Schema field filters. All filter conditions must be met for the automation to run.
527
+ *
528
+ * Learn more about setting up [automation filters](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/configure-your-automation#filters).
529
+ * @maxSize 5
530
+ */
531
+ filters?: Filter[];
532
+ /**
533
+ * Automation offset. You can schedule automations to run before the trigger occurs.
534
+ *
535
+ * Learn more about [scheduled events](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/configure-your-automation#scheduled-events).
536
+ */
537
+ scheduledEventOffset?: FutureDateActivationOffset;
538
+ /** Limit on the number of times an automation can be triggered. */
539
+ rateLimit?: RateLimit;
540
+ /** Trigger schema override. When specified, this replaces the trigger schema. */
541
+ overrideSchema?: Record<string, any> | null;
542
+ }
543
+ interface AutomationConfigurationAction extends AutomationConfigurationActionInfoOneOf {
544
+ /** Details of the action when its `type` is `APP_DEFINED`. */
545
+ appDefinedInfo?: AppDefinedAction;
546
+ /** Details of the action when its `type` is `CONDITION`. */
547
+ conditionInfo?: ConditionAction;
548
+ /** Details of the action when its `type` is `CODE_CONDITION`. */
549
+ codeConditionInfo?: CodeConditionAction;
550
+ /** Details of the action when its `type` is `DELAY`. */
551
+ delayInfo?: DelayAction;
552
+ /** Details of the action when its `type` is `RATE_LIMIT`. */
553
+ rateLimitInfo?: RateLimitAction;
554
+ /**
555
+ * Action ID.
556
+ *
557
+ * Unique identifier for the action instance in the current automation. Use this to refer to this action in the automation flow.
558
+ *
559
+ * If not specified, automatically generated by Wix.
560
+ * @format GUID
561
+ */
562
+ id?: string | null;
563
+ /** [Action type](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/configure-your-automation#action-type). */
564
+ type?: TypeWithLiterals;
565
+ /**
566
+ * [Action namespace](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/configure-your-automation#namespace). This differentiates it from other actions of the same type.
567
+ *
568
+ * If the action outputs any data, the data appears under the namespace in the payload sent to the subsequent steps in the automation. If the user has multiple actions with the same `appId` and `actionKey`, the output of the previous action is overwritten.
569
+ * @minLength 1
570
+ * @maxLength 100
571
+ */
572
+ namespace?: string | null;
573
+ /**
574
+ * Evaluated to boolean to decide whether the action is skipped.
575
+ * For ConditionAction: if skipped, true_post_action_ids execute; false_post_action_ids are skipped
576
+ * SplitAction and OutputAction do not support skip_action_expression
577
+ * @maxLength 1000
578
+ */
579
+ skipActionExpression?: string | null;
580
+ }
581
+ /** @oneof */
582
+ interface AutomationConfigurationActionInfoOneOf {
583
+ /** Details of the action when its `type` is `APP_DEFINED`. */
584
+ appDefinedInfo?: AppDefinedAction;
585
+ /** Details of the action when its `type` is `CONDITION`. */
586
+ conditionInfo?: ConditionAction;
587
+ /** Details of the action when its `type` is `CODE_CONDITION`. */
588
+ codeConditionInfo?: CodeConditionAction;
589
+ /** Details of the action when its `type` is `DELAY`. */
590
+ delayInfo?: DelayAction;
591
+ /** Details of the action when its `type` is `RATE_LIMIT`. */
592
+ rateLimitInfo?: RateLimitAction;
593
+ }
594
+ interface FilterableAppDefinedActions {
595
+ /**
596
+ * App-defined action identifiers. Identifiers have the following format: `${appId}_${actionKey}`.
597
+ * @minSize 1
598
+ * @maxSize 100
599
+ * @minLength 1
600
+ * @maxLength 150
601
+ */
602
+ actionIdentifiers?: string[];
603
+ }
604
+ declare enum Origin {
605
+ /** Default value. */
606
+ UNKNOWN_ORIGIN = "UNKNOWN_ORIGIN",
607
+ /** Created by a [Wix user](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#wix-user). */
608
+ USER = "USER",
609
+ /** Created by a [Wix app](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#wix-app) for a particular site. */
610
+ APPLICATION = "APPLICATION",
611
+ /** [Preinstalled automation](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/pre-installed-automations/about-pre-installed-automations). */
612
+ PREINSTALLED = "PREINSTALLED"
613
+ }
614
+ /** @enumType */
615
+ type OriginWithLiterals = Origin | 'UNKNOWN_ORIGIN' | 'USER' | 'APPLICATION' | 'PREINSTALLED';
616
+ interface ApplicationOrigin {
617
+ /**
618
+ * [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
619
+ *
620
+ * You can find the app ID on the [Home page](https://manage.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%home) in the app's dashboard.
621
+ * @format GUID
622
+ */
623
+ appId?: string;
624
+ }
625
+ interface PreinstalledOrigin {
626
+ /**
627
+ * ID of the app that added the [preinstalled automation](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/pre-installed-automations/about-pre-installed-automations).
628
+ * @format GUID
629
+ */
630
+ appId?: string;
631
+ /**
632
+ * Whether the automation is an override.
633
+ *
634
+ * When a user modifies the preinstalled automation installed on their site, a site-specific version of the automation is created that overrides the automation that was originally installed. This override automation has the same automation ID as the original preinstalled automation.
635
+ *
636
+ * > **Note**: An override automation can no longer be updated by the app that originally installed it.
637
+ * >
638
+ * > To revert to the original preinstalled version, the user must delete the override by calling the Delete Automation method. Calling Delete Automation on an override automation removes the override method and restores the preinstalled automation that was previously installed.
639
+ *
640
+ * Default: `false`.
641
+ * @immutable
642
+ * @readonly
643
+ */
644
+ override?: boolean | null;
645
+ }
646
+ interface AutomationSettings {
647
+ /**
648
+ * Whether the automation is hidden from users.
649
+ *
650
+ * Default: `false`
651
+ */
652
+ hidden?: boolean;
653
+ /**
654
+ * Whether the automation is read-only.
655
+ *
656
+ * Default: `false`
657
+ */
658
+ readonly?: boolean;
659
+ /**
660
+ * Whether to disable the option to delete the automation from the site.
661
+ *
662
+ * Default: `false`.
663
+ */
664
+ disableDelete?: boolean;
665
+ /**
666
+ * Whether to disable the option to change the automation's `configuration.status`, for example from `ACTIVE` to `INACTIVE`.
667
+ *
668
+ * Default: `false`.
669
+ */
670
+ disableStatusChange?: boolean;
671
+ /** Automation action settings. */
672
+ actionSettings?: ActionSettings;
673
+ }
674
+ interface DraftInfo {
675
+ /**
676
+ * ID of the original automation.
677
+ * @format GUID
678
+ * @readonly
679
+ */
680
+ originalAutomationId?: string | null;
681
+ }
682
+ interface Enrichments {
683
+ /** Whether the studio site enrichment is wanted. */
684
+ studioSite?: Enrichment;
685
+ }
686
+ interface ExtendedFields {
687
+ /**
688
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
689
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
690
+ *
691
+ * You can only access fields for which you have the appropriate permissions.
692
+ *
693
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
694
+ */
695
+ namespaces?: Record<string, Record<string, any>>;
696
+ }
697
+ interface AutoArchivePolicy {
698
+ /**
699
+ * Date when to archive the automation
700
+ * If this date in the past, nothing will happen (automation will not go into archived state)
701
+ * If this date in the future, on this date the automation will be updated with archived = true and configuration.status = INACTIVE
702
+ * After this date the automation may be unarchived and archived again, this date will have no influence
703
+ */
704
+ archiveDate?: Date | null;
705
+ }
706
+ interface Notes {
707
+ }
708
+ interface Note {
709
+ }
710
+ interface Position {
711
+ }
712
+ interface Offset {
713
+ }
714
+ interface Dimensions {
715
+ }
716
+ interface ActivationStatusChanged extends ActivationStatusChangedStatusInfoOneOf {
717
+ /** Initiated status information */
718
+ initiatedInfo?: InitiatedStatusInfo;
719
+ /** Started status information */
720
+ startedInfo?: ActivationStatusChangedStartedStatusInfo;
721
+ /** Scheduled status information */
722
+ scheduledInfo?: ScheduledStatusInfo;
723
+ /** Cancelled status information */
724
+ cancelledInfo?: CancelledStatusInfo;
725
+ /** Failed status information */
726
+ failedInfo?: ActivationStatusChangedFailedStatusInfo;
727
+ /** Skipped status information */
728
+ skippedInfo?: SkippedStatusInfo;
729
+ /** Activation */
730
+ activation?: Activation;
731
+ /** Activation status */
732
+ status?: ActivationStatusChangedStatusWithLiterals;
733
+ /** Change event created date */
734
+ statusChangedDate?: Date | null;
735
+ }
736
+ /** @oneof */
737
+ interface ActivationStatusChangedStatusInfoOneOf {
738
+ /** Initiated status information */
739
+ initiatedInfo?: InitiatedStatusInfo;
740
+ /** Started status information */
741
+ startedInfo?: ActivationStatusChangedStartedStatusInfo;
742
+ /** Scheduled status information */
743
+ scheduledInfo?: ScheduledStatusInfo;
744
+ /** Cancelled status information */
745
+ cancelledInfo?: CancelledStatusInfo;
746
+ /** Failed status information */
747
+ failedInfo?: ActivationStatusChangedFailedStatusInfo;
748
+ /** Skipped status information */
749
+ skippedInfo?: SkippedStatusInfo;
750
+ }
751
+ declare enum Target {
752
+ UNKNOWN_TARGET = "UNKNOWN_TARGET",
753
+ SCHEDULE = "SCHEDULE",
754
+ IMMEDIATE = "IMMEDIATE"
755
+ }
756
+ /** @enumType */
757
+ type TargetWithLiterals = Target | 'UNKNOWN_TARGET' | 'SCHEDULE' | 'IMMEDIATE';
758
+ declare enum CancellationReason {
759
+ UNKNOWN_CANCELLATION_REASON = "UNKNOWN_CANCELLATION_REASON",
760
+ /** Indicates that the activation was cancelled directly. */
761
+ EVENT_CANCELLED = "EVENT_CANCELLED",
762
+ /** Indicates that the activation was cancelled because the automation was deactivated. */
763
+ AUTOMATION_DEACTIVATED = "AUTOMATION_DEACTIVATED",
764
+ /** Indicates that the activation was cancelled because the automation was deleted. */
765
+ AUTOMATION_DELETED = "AUTOMATION_DELETED",
766
+ /** Indicates that the activation was cancelled after the automation schedule time was reached. */
767
+ CANCELLED_BY_REFRESH_PAYLOAD = "CANCELLED_BY_REFRESH_PAYLOAD",
768
+ /** Indicates that the activation was cancelled due to a UoU GDPR "Right to be Forgotten" request. */
769
+ CANCELLED_BY_GDPR_REQUEST = "CANCELLED_BY_GDPR_REQUEST"
770
+ }
771
+ /** @enumType */
772
+ type CancellationReasonWithLiterals = CancellationReason | 'UNKNOWN_CANCELLATION_REASON' | 'EVENT_CANCELLED' | 'AUTOMATION_DEACTIVATED' | 'AUTOMATION_DELETED' | 'CANCELLED_BY_REFRESH_PAYLOAD' | 'CANCELLED_BY_GDPR_REQUEST';
773
+ interface Identity {
774
+ /**
775
+ * User ID
776
+ * @format GUID
777
+ */
778
+ userId?: string | null;
779
+ /**
780
+ * App ID
781
+ * @format GUID
782
+ */
783
+ appId?: string | null;
784
+ }
785
+ declare enum ErrorReason {
786
+ /** Unexpected error reason */
787
+ UNEXPECTED_ERROR_REASON = "UNEXPECTED_ERROR_REASON",
788
+ /** Failed to evaluate the schedule date expression */
789
+ SCHEDULE_DATE_EVALUATION_FAILED = "SCHEDULE_DATE_EVALUATION_FAILED"
790
+ }
791
+ /** @enumType */
792
+ type ErrorReasonWithLiterals = ErrorReason | 'UNEXPECTED_ERROR_REASON' | 'SCHEDULE_DATE_EVALUATION_FAILED';
793
+ declare enum SkipReason {
794
+ UNKNOWN_SKIP_REASON = "UNKNOWN_SKIP_REASON",
795
+ /** Activation was skipped because the scheduled execution time had already passed at the time of execution. */
796
+ SCHEDULE_DATE_EXPIRED = "SCHEDULE_DATE_EXPIRED",
797
+ /** Activation was skipped because the trigger filters defined in the automation did not match the payload. */
798
+ TRIGGER_FILTERS_NOT_PASSED = "TRIGGER_FILTERS_NOT_PASSED",
799
+ /** Activation was skipped because it exceeded the configured rate limit (maximum number of executions allowed in a time period). */
800
+ RATE_LIMIT_EXCEEDED = "RATE_LIMIT_EXCEEDED",
801
+ /** Activation was skipped because an event with the same idempotency key was already processed. */
802
+ EVENT_ALREADY_PROCESSED = "EVENT_ALREADY_PROCESSED"
803
+ }
804
+ /** @enumType */
805
+ type SkipReasonWithLiterals = SkipReason | 'UNKNOWN_SKIP_REASON' | 'SCHEDULE_DATE_EXPIRED' | 'TRIGGER_FILTERS_NOT_PASSED' | 'RATE_LIMIT_EXCEEDED' | 'EVENT_ALREADY_PROCESSED';
806
+ declare enum ActivationStatusChangedStatus {
807
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
808
+ /** Indicates that activation has not started yet and no actions have been executed. */
809
+ INITIATED = "INITIATED",
810
+ /** Activation is in scheduled status when the automation has a future date or debounce defined and we're in the waiting stage and no actions have been executed. */
811
+ SCHEDULED = "SCHEDULED",
812
+ /** Indicates the automation activation has started and is currently in progress. */
813
+ STARTED = "STARTED",
814
+ /** Indicates all the automation actions were handled either by invoking them, skipping them, etc. */
815
+ ENDED = "ENDED",
816
+ /** Indicates the activation was cancelled. */
817
+ CANCELLED = "CANCELLED",
818
+ /**
819
+ * Indicates the activation failed to start.
820
+ * Note that failure in the activation of a single action will not result in a failure in activation of the entire automation.
821
+ */
822
+ FAILED = "FAILED",
823
+ /**
824
+ * Indicates that the automation activation was skipped without executing any actions.
825
+ * Note that an activation will either be skipped immediately or move to INITIATED state.
826
+ */
827
+ SKIPPED = "SKIPPED"
828
+ }
829
+ /** @enumType */
830
+ type ActivationStatusChangedStatusWithLiterals = ActivationStatusChangedStatus | 'UNKNOWN_STATUS' | 'INITIATED' | 'SCHEDULED' | 'STARTED' | 'ENDED' | 'CANCELLED' | 'FAILED' | 'SKIPPED';
831
+ interface Metadata {
832
+ /**
833
+ * Identity field keys that are collected from the trigger payload schema, including contact and member ids
834
+ * @maxSize 100
835
+ * @maxLength 100
836
+ */
837
+ identityFieldKeys?: string[];
838
+ }
839
+ interface InitiatedStatusInfo {
840
+ /** Activation target */
841
+ target?: TargetWithLiterals;
842
+ /** Event payload */
843
+ payload?: Record<string, any> | null;
844
+ /**
845
+ * External entity ID
846
+ * @maxLength 40
847
+ */
848
+ externalEntityId?: string | null;
849
+ /**
850
+ * Unique identifier for the request that initiated the automation
851
+ * @maxLength 100
852
+ */
853
+ requestId?: string;
854
+ }
855
+ interface ActivationStatusChangedStartedStatusInfo {
856
+ /** Enriched and refreshed payload */
857
+ payload?: Record<string, any> | null;
858
+ }
859
+ interface ScheduledStatusInfo {
860
+ /**
861
+ * Schedule identifier
862
+ * @format GUID
863
+ */
864
+ scheduleId?: string;
865
+ /** Indicates when the activation should start */
866
+ date?: Date | null;
867
+ }
868
+ interface CancelledStatusInfo {
869
+ /** Cancellation reason */
870
+ reason?: CancellationReasonWithLiterals;
871
+ /** Identity (such as user, app, etc.) that caused the cancellation. */
872
+ initiator?: Identity;
873
+ }
874
+ interface ActivationStatusChangedFailedStatusInfo {
875
+ /**
876
+ * Error description
877
+ * @maxLength 1000
878
+ * @readonly
879
+ */
880
+ errorDescription?: string;
881
+ /**
882
+ * Error code
883
+ * @maxLength 20
884
+ * @readonly
885
+ */
886
+ errorCode?: string | null;
887
+ /** Error reason */
888
+ errorReason?: ErrorReasonWithLiterals;
889
+ /** Event payload */
890
+ payload?: Record<string, any> | null;
891
+ /**
892
+ * External entity ID
893
+ * @maxLength 40
894
+ */
895
+ externalEntityId?: string | null;
896
+ /**
897
+ * Unique identifier for the request that initiated the automation
898
+ * @maxLength 100
899
+ */
900
+ requestId?: string | null;
901
+ }
902
+ interface SkippedStatusInfo {
903
+ /** The reason why the automation activation was skipped */
904
+ reason?: SkipReasonWithLiterals;
905
+ /** Event payload */
906
+ payload?: Record<string, any> | null;
907
+ /**
908
+ * External entity ID
909
+ * @maxLength 40
910
+ */
911
+ externalEntityId?: string | null;
912
+ /**
913
+ * Unique identifier for the request that initiated the automation
914
+ * @maxLength 100
915
+ */
916
+ requestId?: string;
917
+ }
918
+ interface ScheduleRequest {
919
+ schedule?: Schedule;
920
+ }
921
+ interface Schedule {
922
+ /**
923
+ * @format GUID
924
+ * @readonly
925
+ */
926
+ id?: string | null;
927
+ /**
928
+ * doesn't have to be unique. example: triggerName+entityId
929
+ * @maxLength 300
930
+ */
931
+ identifier?: string;
932
+ /** @format GUID */
933
+ configurationCorrelationId?: string;
934
+ /** @format GUID */
935
+ activationId?: string;
936
+ scheduledAction?: ScheduledAction;
937
+ /** Raw domain event, not enriched */
938
+ eventPayload?: string;
939
+ scheduleStatus?: ScheduleStatusWithLiterals;
940
+ /** @readonly */
941
+ scheduleDate?: Date | null;
942
+ /** @readonly */
943
+ createdDate?: Date | null;
944
+ /** @readonly */
945
+ updatedDate?: Date | null;
946
+ overrideable?: boolean | null;
947
+ triggerInfo?: TriggerInfo;
948
+ automation?: Automation;
949
+ }
950
+ interface ScheduledAction {
951
+ /**
952
+ * Action's id.
953
+ * @format GUID
954
+ */
955
+ id?: string;
956
+ /** decide how long we should wait */
957
+ delay?: Delay;
958
+ }
959
+ interface Delay extends DelayOfOneOf {
960
+ simple?: SimpleDelay;
961
+ /**
962
+ * jsonata expression - sleep until the given date
963
+ * for example: $toMillis(MyObject.Date) + 2*1000*60*60*24) -> will schedule 2 days after MyObject.Date
964
+ * @maxLength 300
965
+ */
966
+ dateExpression?: string;
967
+ }
968
+ /** @oneof */
969
+ interface DelayOfOneOf {
970
+ simple?: SimpleDelay;
971
+ /**
972
+ * jsonata expression - sleep until the given date
973
+ * for example: $toMillis(MyObject.Date) + 2*1000*60*60*24) -> will schedule 2 days after MyObject.Date
974
+ * @maxLength 300
975
+ */
976
+ dateExpression?: string;
977
+ }
978
+ interface SimpleDelay {
979
+ value?: number;
980
+ units?: UnitsWithLiterals;
981
+ /**
982
+ * Optional, used if provided: Jsonata expression that evaluates to a number of milliseconds to wait
983
+ * @maxLength 300
984
+ */
985
+ delayExpression?: string | null;
986
+ }
987
+ declare enum Units {
988
+ UNKNOWN = "UNKNOWN",
989
+ MINUTES = "MINUTES",
990
+ HOURS = "HOURS",
991
+ DAYS = "DAYS"
992
+ }
993
+ /** @enumType */
994
+ type UnitsWithLiterals = Units | 'UNKNOWN' | 'MINUTES' | 'HOURS' | 'DAYS';
995
+ declare enum ScheduleStatus {
996
+ UNKNOWN_SCHEDULE_STATUS = "UNKNOWN_SCHEDULE_STATUS",
997
+ PENDING = "PENDING",
998
+ CANCELLED = "CANCELLED",
999
+ DONE = "DONE",
1000
+ MIGRATED = "MIGRATED",
1001
+ /** esb configuration was deleted after the schedule was created */
1002
+ ESB_CONFIGURATION_NOT_FOUND = "ESB_CONFIGURATION_NOT_FOUND",
1003
+ /** automation v3 was deleted after the schedule was created */
1004
+ AUTOMATION_NOT_FOUND = "AUTOMATION_NOT_FOUND",
1005
+ METASITE_DELETED = "METASITE_DELETED"
1006
+ }
1007
+ /** @enumType */
1008
+ type ScheduleStatusWithLiterals = ScheduleStatus | 'UNKNOWN_SCHEDULE_STATUS' | 'PENDING' | 'CANCELLED' | 'DONE' | 'MIGRATED' | 'ESB_CONFIGURATION_NOT_FOUND' | 'AUTOMATION_NOT_FOUND' | 'METASITE_DELETED';
1009
+ interface TriggerInfo {
1010
+ /**
1011
+ * App id of the initial trigger.
1012
+ * @format GUID
1013
+ */
1014
+ appId?: string;
1015
+ /** Trigger key of the initial trigger. */
1016
+ triggerKey?: string;
1017
+ }
1018
+ interface ScheduleResponse {
1019
+ /** @format GUID */
1020
+ id?: string;
1021
+ }
1022
+ interface CancelPendingScheduleRequest extends CancelPendingScheduleRequestByOneOf {
1023
+ /** @format GUID */
1024
+ id?: string;
1025
+ identifier?: string;
1026
+ /** @format GUID */
1027
+ configurationCorrelationId?: string;
1028
+ /** @format GUID */
1029
+ activationId?: string;
1030
+ /**
1031
+ * @minLength 1
1032
+ * @maxLength 500
1033
+ */
1034
+ identifierPattern?: string;
1035
+ }
1036
+ /** @oneof */
1037
+ interface CancelPendingScheduleRequestByOneOf {
1038
+ /** @format GUID */
1039
+ id?: string;
1040
+ identifier?: string;
1041
+ /** @format GUID */
1042
+ configurationCorrelationId?: string;
1043
+ /** @format GUID */
1044
+ activationId?: string;
1045
+ /**
1046
+ * @minLength 1
1047
+ * @maxLength 500
1048
+ */
1049
+ identifierPattern?: string;
1050
+ }
1051
+ interface CancelPendingScheduleResponse {
1052
+ }
1053
+ interface UpdatePendingSchedulesPayloadRequest {
1054
+ identifier?: string;
1055
+ eventPayload?: string;
1056
+ }
1057
+ interface UpdatePendingSchedulesPayloadResponse {
1058
+ }
1059
+ interface GetScheduleRequest {
1060
+ /** @format GUID */
1061
+ id?: string;
1062
+ }
1063
+ interface GetScheduleResponse {
1064
+ schedule?: Schedule;
1065
+ }
1066
+ interface UpdateScheduleStatusRequest {
1067
+ /** @format GUID */
1068
+ id?: string;
1069
+ status?: ScheduleStatusWithLiterals;
1070
+ }
1071
+ interface UpdateScheduleStatusResponse {
1072
+ }
1073
+ interface DomainEvent extends DomainEventBodyOneOf {
1074
+ createdEvent?: EntityCreatedEvent;
1075
+ updatedEvent?: EntityUpdatedEvent;
1076
+ deletedEvent?: EntityDeletedEvent;
1077
+ actionEvent?: ActionEvent;
1078
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1079
+ id?: string;
1080
+ /**
1081
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1082
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1083
+ */
1084
+ entityFqdn?: string;
1085
+ /**
1086
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
1087
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1088
+ */
1089
+ slug?: string;
1090
+ /** ID of the entity associated with the event. */
1091
+ entityId?: string;
1092
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1093
+ eventTime?: Date | null;
1094
+ /**
1095
+ * Whether the event was triggered as a result of a privacy regulation application
1096
+ * (for example, GDPR).
1097
+ */
1098
+ triggeredByAnonymizeRequest?: boolean | null;
1099
+ /** If present, indicates the action that triggered the event. */
1100
+ originatedFrom?: string | null;
1101
+ /**
1102
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
1103
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
1104
+ */
1105
+ entityEventSequence?: string | null;
1106
+ }
1107
+ /** @oneof */
1108
+ interface DomainEventBodyOneOf {
1109
+ createdEvent?: EntityCreatedEvent;
1110
+ updatedEvent?: EntityUpdatedEvent;
1111
+ deletedEvent?: EntityDeletedEvent;
1112
+ actionEvent?: ActionEvent;
1113
+ }
1114
+ interface EntityCreatedEvent {
1115
+ entityAsJson?: string;
1116
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
1117
+ restoreInfo?: RestoreInfo;
1118
+ }
1119
+ interface RestoreInfo {
1120
+ deletedDate?: Date | null;
1121
+ }
1122
+ interface EntityUpdatedEvent {
1123
+ /**
1124
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1125
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1126
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1127
+ */
1128
+ currentEntityAsJson?: string;
1129
+ }
1130
+ interface EntityDeletedEvent {
1131
+ /** Entity that was deleted. */
1132
+ deletedEntityAsJson?: string | null;
1133
+ }
1134
+ interface ActionEvent {
1135
+ bodyAsJson?: string;
1136
+ }
1137
+ interface MessageEnvelope {
1138
+ /**
1139
+ * App instance ID.
1140
+ * @format GUID
1141
+ */
1142
+ instanceId?: string | null;
1143
+ /**
1144
+ * Event type.
1145
+ * @maxLength 150
1146
+ */
1147
+ eventType?: string;
1148
+ /** The identification type and identity data. */
1149
+ identity?: IdentificationData;
1150
+ /** Stringify payload. */
1151
+ data?: string;
1152
+ }
1153
+ interface IdentificationData extends IdentificationDataIdOneOf {
1154
+ /**
1155
+ * ID of a site visitor that has not logged in to the site.
1156
+ * @format GUID
1157
+ */
1158
+ anonymousVisitorId?: string;
1159
+ /**
1160
+ * ID of a site visitor that has logged in to the site.
1161
+ * @format GUID
1162
+ */
1163
+ memberId?: string;
1164
+ /**
1165
+ * ID of a Wix user (site owner, contributor, etc.).
1166
+ * @format GUID
1167
+ */
1168
+ wixUserId?: string;
1169
+ /**
1170
+ * ID of an app.
1171
+ * @format GUID
1172
+ */
1173
+ appId?: string;
1174
+ /** @readonly */
1175
+ identityType?: WebhookIdentityTypeWithLiterals;
1176
+ }
1177
+ /** @oneof */
1178
+ interface IdentificationDataIdOneOf {
1179
+ /**
1180
+ * ID of a site visitor that has not logged in to the site.
1181
+ * @format GUID
1182
+ */
1183
+ anonymousVisitorId?: string;
1184
+ /**
1185
+ * ID of a site visitor that has logged in to the site.
1186
+ * @format GUID
1187
+ */
1188
+ memberId?: string;
1189
+ /**
1190
+ * ID of a Wix user (site owner, contributor, etc.).
1191
+ * @format GUID
1192
+ */
1193
+ wixUserId?: string;
1194
+ /**
1195
+ * ID of an app.
1196
+ * @format GUID
1197
+ */
1198
+ appId?: string;
1199
+ }
1200
+ declare enum WebhookIdentityType {
1201
+ UNKNOWN = "UNKNOWN",
1202
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1203
+ MEMBER = "MEMBER",
1204
+ WIX_USER = "WIX_USER",
1205
+ APP = "APP"
1206
+ }
1207
+ /** @enumType */
1208
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1209
+ interface ConsumeReportEventRequest {
1210
+ /**
1211
+ * Repeated list of event details for bulk reporting.
1212
+ * @minSize 1
1213
+ * @maxSize 100
1214
+ */
1215
+ eventsInfo?: EventInfo[];
1216
+ /**
1217
+ * trigger app id
1218
+ * @format GUID
1219
+ */
1220
+ triggerAppId?: string;
1221
+ /**
1222
+ * trigger key
1223
+ * @minLength 1
1224
+ * @maxLength 100
1225
+ */
1226
+ triggerKey?: string;
1227
+ }
4
1228
  interface EventInfo {
5
1229
  /**
6
- * Event payload, formatted as key:value pairs.
7
- * Must comply with the payload schema
8
- * if you provided one when configuring your trigger.
1230
+ * Event payload, formatted as key:value pairs.
1231
+ * Must comply with the payload schema
1232
+ * if you provided one when configuring your trigger.
1233
+ */
1234
+ payload?: Record<string, any> | null;
1235
+ /**
1236
+ * ID of the related resource in GUID format.
1237
+ * @format GUID
1238
+ */
1239
+ externalEntityId?: string | null;
1240
+ /** Idempotency information for the event. */
1241
+ idempotency?: Idempotency;
1242
+ }
1243
+ interface Idempotency {
1244
+ /**
1245
+ * A unique identifier for the event.
1246
+ * If you send the same idempotency key in multiple report event requests, for the same trigger key and app id,
1247
+ * consecutive requests will be ignored after the first one. Note that the idempotency key is kept for a week before it expires.
1248
+ * @minLength 1
1249
+ * @maxLength 80
1250
+ */
1251
+ key?: string;
1252
+ /**
1253
+ * Optional. The time to live (TTL) in milliseconds before the key will expire. Default is a week.
1254
+ * @min 1
1255
+ */
1256
+ ttlInMilliseconds?: string | null;
1257
+ }
1258
+ interface BatchActivationRequest {
1259
+ /** List of Activation-Request. */
1260
+ activationRequests?: ActivationRequest[];
1261
+ }
1262
+ interface ActivationRequest {
1263
+ /**
1264
+ * Activation's ID.
1265
+ * @format GUID
1266
+ */
1267
+ activationId?: string;
1268
+ /**
1269
+ * Configuration's ID.
1270
+ * @format GUID
1271
+ */
1272
+ configurationId?: string;
1273
+ /** @format GUID */
1274
+ configurationCorrelationId?: string;
1275
+ /**
1276
+ * Received event name.
1277
+ * @maxLength 80
1278
+ */
1279
+ eventName?: string;
1280
+ /**
1281
+ * Received event slug.
1282
+ * @maxLength 50
1283
+ */
1284
+ eventSlug?: string | null;
1285
+ /** Received event payload. */
1286
+ eventPayload?: string | null;
1287
+ /** List of action data. */
1288
+ actions?: ActionData[];
1289
+ /**
1290
+ * External ID.
1291
+ * @format GUID
1292
+ */
1293
+ externalId?: string;
1294
+ /** The source of this activation */
1295
+ source?: ActivationSource;
1296
+ /** Actions tree */
1297
+ actionsMap?: ActionsData;
1298
+ /** Automation V2. Used for reporting domain event until activation request will be deprecated. */
1299
+ automation?: Automation;
1300
+ /** Trigger entity for the activation, available for v2 and v3 automations only */
1301
+ triggerSchema?: Record<string, any> | null;
1302
+ }
1303
+ interface Runtime {
1304
+ }
1305
+ interface Scheduler {
1306
+ scheduleId?: string | null;
1307
+ }
1308
+ interface AsyncAction {
1309
+ }
1310
+ interface ActionData {
1311
+ /**
1312
+ * Action's id.
1313
+ * @format GUID
1314
+ * @readonly
1315
+ */
1316
+ id?: string | null;
1317
+ /** Action's data. */
1318
+ action?: Action;
1319
+ }
1320
+ interface Action extends ActionActionOneOf {
1321
+ service?: Service;
1322
+ systemHelper?: SystemHelper;
1323
+ spiAction?: SpiAction;
1324
+ }
1325
+ /** @oneof */
1326
+ interface ActionActionOneOf {
1327
+ service?: Service;
1328
+ systemHelper?: SystemHelper;
1329
+ spiAction?: SpiAction;
1330
+ }
1331
+ interface ServiceMapping {
1332
+ /** Sevice name. */
1333
+ name?: string;
1334
+ /** Method name. */
1335
+ method?: string;
1336
+ }
1337
+ interface IfFilter {
1338
+ /** If filter's condition. */
1339
+ condition?: string;
1340
+ /** If's true post actions. */
1341
+ truePostActions?: ActionData[];
1342
+ /** If's false post actions. */
1343
+ falsePostActions?: ActionData[];
1344
+ /**
1345
+ * If's true post actions ids.
1346
+ * @maxSize 20
1347
+ */
1348
+ truePostActionsIds?: string[];
1349
+ /**
1350
+ * If's false post actions ids.
1351
+ * @maxSize 20
1352
+ */
1353
+ falsePostActionsIds?: string[];
1354
+ }
1355
+ interface SwitchFilter {
1356
+ /** Switch's filter cases. */
1357
+ cases?: Case[];
1358
+ }
1359
+ interface Case {
1360
+ /** Case's condition. */
1361
+ condition?: any;
1362
+ /** Case's post actions. */
1363
+ postActions?: ActionData[];
1364
+ /**
1365
+ * Case's post actions ids.
1366
+ * @maxSize 20
1367
+ */
1368
+ postActionsIds?: string[];
1369
+ }
1370
+ interface DelayHelper {
1371
+ /** jsonata expression, for example: triggerName + eventId */
1372
+ scheduleIdentifier?: string;
1373
+ /** decide how long we should wait */
1374
+ delay?: Delay;
1375
+ /** Delay's post actions. */
1376
+ postActions?: ActionData[];
1377
+ /**
1378
+ * Optional: if true, any new schedule with the same schedule identifier will override the existing one.
1379
+ * If false, the new schedule will be ignored.
1380
+ */
1381
+ overrideable?: boolean | null;
1382
+ /**
1383
+ * Delay's post actions ids.
1384
+ * @maxSize 20
1385
+ */
1386
+ postActionsIds?: string[];
1387
+ /**
1388
+ * Optional expression to determine whether the action should be skipped
1389
+ * @maxLength 1000
1390
+ */
1391
+ skipConditionExpression?: string | null;
1392
+ }
1393
+ interface RateLimiting {
1394
+ /** The maximum number of activations allowed in the given time frame */
1395
+ maxNumOfActivations?: number;
1396
+ /**
1397
+ * Optional, used if provided: A jsonata expression that evaluates to the maximum number of activations allowed in the given time frame
1398
+ * @maxLength 300
1399
+ */
1400
+ maxNumOfActivationsExpression?: string | null;
1401
+ /** If given - the time frame in minutes, otherwise, for life */
1402
+ timeFrameInMinutes?: number | null;
1403
+ /**
1404
+ * Optional, used if provided - A jsonata expression that evaluates to the time frame in minutes, otherwise, for life
1405
+ * @maxLength 300
1406
+ */
1407
+ timeFrameInMinutesExpression?: string | null;
1408
+ /**
1409
+ * The jsonata to use to extract the entity/resource key from the enriched event payload
1410
+ * @maxLength 1000
1411
+ */
1412
+ keyJsonata?: string;
1413
+ /**
1414
+ * The actions to perform if this rate limiting action succeeded - meaning we are still in the allowed number of activations in the given time frame
1415
+ * @maxSize 9999
1416
+ */
1417
+ postActions?: ActionData[];
1418
+ /**
1419
+ * The ids of actions to perform if this rate limiting action succeeded - meaning we are still in the allowed number of activations in the given time frame
1420
+ * @maxSize 20
1421
+ */
1422
+ postActionsIds?: string[];
1423
+ /**
1424
+ * Optional expression to determine whether the action should be skipped
1425
+ * @maxLength 1000
1426
+ */
1427
+ skipConditionExpression?: string | null;
1428
+ }
1429
+ interface ConditionFilter {
1430
+ /**
1431
+ * condition evaluates to `true` if either of the blocks evaluate to `true` (aka OR between all).
1432
+ * @minSize 1
1433
+ * @maxSize 10
1434
+ */
1435
+ conditionBlocks?: ConditionBlock[];
1436
+ /** Actions to perform when condition_blocks evaluates to `true`. */
1437
+ postActions?: ActionData[];
1438
+ /**
1439
+ * Action's post actions ids.
1440
+ * @maxSize 20
1441
+ */
1442
+ postActionsIds?: string[];
1443
+ /**
1444
+ * Actions to perform when condition_blocks evaluates to `false`.
1445
+ * @maxSize 2000
1446
+ */
1447
+ elsePostActions?: ActionData[];
1448
+ /**
1449
+ * Optional expression to determine whether the action should be skipped
1450
+ * @maxLength 1000
1451
+ */
1452
+ skipConditionExpression?: string | null;
1453
+ }
1454
+ declare enum BlockType {
1455
+ UNKNOWN = "UNKNOWN",
1456
+ OR = "OR",
1457
+ AND = "AND"
1458
+ }
1459
+ /** @enumType */
1460
+ type BlockTypeWithLiterals = BlockType | 'UNKNOWN' | 'OR' | 'AND';
1461
+ interface ConditionBlock {
1462
+ type?: BlockTypeWithLiterals;
1463
+ /**
1464
+ * @minSize 1
1465
+ * @maxSize 20
1466
+ */
1467
+ lineExpressions?: string[];
1468
+ }
1469
+ interface CodeConditionFilter {
1470
+ /** Code Snippet */
1471
+ snippet?: CodeSnippet;
1472
+ /**
1473
+ * Actions to perform when condition_blocks evaluates to `true`.
1474
+ * @maxSize 2000
1475
+ */
1476
+ postActions?: ActionData[];
1477
+ /**
1478
+ * Action's post actions ids.
1479
+ * @format GUID
1480
+ * @maxSize 20
1481
+ */
1482
+ postActionsIds?: string[];
1483
+ /**
1484
+ * Actions to perform when condition_blocks evaluates to `false`.
1485
+ * @maxSize 2000
1486
+ */
1487
+ elsePostActions?: ActionData[];
1488
+ /**
1489
+ * Optional expression to determine whether the action should be skipped
1490
+ * @maxLength 1000
1491
+ */
1492
+ skipConditionExpression?: string | null;
1493
+ }
1494
+ interface CodeSnippet {
1495
+ /** Logical operator used to evaluate the condition expressions. */
1496
+ language?: LanguageWithLiterals;
1497
+ /**
1498
+ * Expressions evaluated using the selected operator.
1499
+ * @maxLength 1000
1500
+ */
1501
+ code?: string;
1502
+ }
1503
+ declare enum Language {
1504
+ /** Unknown. */
1505
+ UNKNOWN_LANGUAGE = "UNKNOWN_LANGUAGE",
1506
+ /** `JAVASCRIPT` language. */
1507
+ JAVASCRIPT = "JAVASCRIPT"
1508
+ }
1509
+ /** @enumType */
1510
+ type LanguageWithLiterals = Language | 'UNKNOWN_LANGUAGE' | 'JAVASCRIPT';
1511
+ interface Output {
1512
+ /**
1513
+ * The jsonata to use to produce the output
1514
+ * @minLength 1
1515
+ * @maxLength 5000
1516
+ */
1517
+ outputMapping?: string;
1518
+ }
1519
+ interface SetVariables {
1520
+ /**
1521
+ * Action's output mapping.
1522
+ * Jsonata expressions to set variables
1523
+ * for example: { "var1": "$average([10,20])", "var2": "$number($lookup($, $decodeUrlComponent(\"var1\"))) >= $number(8)"" }
1524
+ * @minLength 1
1525
+ * @maxLength 5000
1526
+ */
1527
+ outputMapping?: string;
1528
+ /**
1529
+ * Action's post actions.
1530
+ * @maxSize 20
1531
+ */
1532
+ postActions?: ActionData[];
1533
+ /**
1534
+ * Action's post actions ids.
1535
+ * @format GUID
1536
+ * @maxSize 20
1537
+ */
1538
+ postActionsIds?: string[];
1539
+ /**
1540
+ * The namespace of the action
1541
+ * @minLength 1
1542
+ * @maxLength 100
1543
+ */
1544
+ namespace?: string | null;
1545
+ /** Json Schema for the output mapping */
1546
+ outputSchema?: Record<string, any> | null;
1547
+ /**
1548
+ * Optional expression to determine whether the action should be skipped
1549
+ * @maxLength 1000
1550
+ */
1551
+ skipConditionExpression?: string | null;
1552
+ }
1553
+ interface SplitAction {
1554
+ /**
1555
+ * Sequence of paths for parallel execution
1556
+ * @minSize 2
1557
+ * @maxSize 10
1558
+ */
1559
+ paths?: Path[];
1560
+ }
1561
+ interface Path {
1562
+ /**
1563
+ * Path ID
1564
+ * @format GUID
1565
+ */
1566
+ id?: string;
1567
+ /**
1568
+ * Path name
1569
+ * @minLength 1
1570
+ * @maxLength 100
1571
+ */
1572
+ name?: string | null;
1573
+ /**
1574
+ * Post action to execute in this path (optional)
1575
+ * @format GUID
1576
+ */
1577
+ postActionId?: string | null;
1578
+ /** post action to execute in this path */
1579
+ postAction?: ActionData;
1580
+ }
1581
+ interface Service {
1582
+ /** Action's service mapping. */
1583
+ serviceMapping?: ServiceMapping;
1584
+ /**
1585
+ * Action's input mapping.
1586
+ * Jsonata description of the input this service gets.
1587
+ */
1588
+ inputMapping?: string | null;
1589
+ /**
1590
+ * Action's output mapping.
1591
+ * Jsonata description of the output this service returns.
1592
+ */
1593
+ outputMapping?: string | null;
1594
+ /** Action's post actions. */
1595
+ postActions?: ActionData[];
1596
+ /**
1597
+ * Action's post actions ids.
1598
+ * @maxSize 20
1599
+ */
1600
+ postActionsIds?: string[];
1601
+ /**
1602
+ * The namespace of the action
1603
+ * @minLength 1
1604
+ * @maxLength 100
1605
+ */
1606
+ namespace?: string | null;
1607
+ }
1608
+ interface SystemHelper extends SystemHelperHelperOneOf {
1609
+ ifFilter?: IfFilter;
1610
+ switchFilter?: SwitchFilter;
1611
+ delay?: DelayHelper;
1612
+ rateLimiting?: RateLimiting;
1613
+ conditionFilter?: ConditionFilter;
1614
+ codeConditionFilter?: CodeConditionFilter;
1615
+ output?: Output;
1616
+ setVariables?: SetVariables;
1617
+ split?: SplitAction;
1618
+ }
1619
+ /** @oneof */
1620
+ interface SystemHelperHelperOneOf {
1621
+ ifFilter?: IfFilter;
1622
+ switchFilter?: SwitchFilter;
1623
+ delay?: DelayHelper;
1624
+ rateLimiting?: RateLimiting;
1625
+ conditionFilter?: ConditionFilter;
1626
+ codeConditionFilter?: CodeConditionFilter;
1627
+ output?: Output;
1628
+ setVariables?: SetVariables;
1629
+ split?: SplitAction;
1630
+ }
1631
+ interface SpiAction {
1632
+ /** The App Def Id of the action provider */
1633
+ appDefId?: string;
1634
+ /** Identifier for this action - human readable action key - unique per app def id */
1635
+ actionKey?: string;
1636
+ /** The configuration of the user for this action, can include params that are taken from the trigger event payload */
1637
+ userActionConfig?: string | null;
1638
+ /** The post action to execute after this action */
1639
+ postActions?: ActionData[];
1640
+ /** The output configuration of the user for this action, can include params that are taken from the trigger event payload */
1641
+ userOutputActionConfig?: string | null;
1642
+ /**
1643
+ * optional skip condition expression for current action
1644
+ * decides whether to skip the action before executing it's post actions
1645
+ * @maxLength 1000
1646
+ */
1647
+ skipConditionExpression?: string | null;
1648
+ /**
1649
+ * Action's post actions ids.
1650
+ * @maxSize 20
1651
+ */
1652
+ postActionsIds?: string[];
1653
+ /**
1654
+ * The namespace of the action
1655
+ * @minLength 1
1656
+ * @maxLength 100
9
1657
  */
10
- payload?: Record<string, any> | null;
1658
+ namespace?: string | null;
1659
+ }
1660
+ interface ActivationSource extends ActivationSourceOfOneOf {
1661
+ runtime?: Runtime;
1662
+ scheduler?: Scheduler;
1663
+ asyncAction?: AsyncAction;
1664
+ }
1665
+ /** @oneof */
1666
+ interface ActivationSourceOfOneOf {
1667
+ runtime?: Runtime;
1668
+ scheduler?: Scheduler;
1669
+ asyncAction?: AsyncAction;
1670
+ }
1671
+ interface ActionsData {
11
1672
  /**
12
- * ID of the related resource in GUID format.
1673
+ * Ids of the first level actions.
1674
+ * @maxSize 20
1675
+ */
1676
+ rootActionIds?: string[];
1677
+ /** Map of action id to action data. */
1678
+ actions?: Record<string, Action>;
1679
+ }
1680
+ interface ScheduleActivationRequested {
1681
+ /**
1682
+ * Activation identifier
1683
+ * @format GUID
1684
+ * @immutable
1685
+ */
1686
+ id?: string;
1687
+ /**
1688
+ * Optional - external entity id that this activation is related to
13
1689
  * @format GUID
1690
+ * @immutable
14
1691
  */
15
1692
  externalEntityId?: string | null;
16
- /** Idempotency information for the event. */
17
- idempotency?: Idempotency;
18
- }
19
- interface Idempotency {
20
1693
  /**
21
- * A unique identifier for the event.
22
- * If you send the same idempotency key in multiple report event requests, for the same trigger key and app id,
23
- * consecutive requests will be ignored after the first one. Note that the idempotency key is kept for a week before it expires.
24
- * @minLength 1
25
- * @maxLength 80
1694
+ * Activation payload
1695
+ * @immutable
26
1696
  */
27
- key?: string;
1697
+ payload?: Record<string, any> | null;
28
1698
  /**
29
- * Optional. The time to live (TTL) in milliseconds before the key will expire. Default is a week.
30
- * @min 1
1699
+ * Activation Automation
1700
+ * @immutable
31
1701
  */
32
- ttlInMilliseconds?: string | null;
1702
+ automation?: Automation;
1703
+ /**
1704
+ * Activation schedule date
1705
+ * @immutable
1706
+ */
1707
+ scheduleDate?: Date | null;
1708
+ }
1709
+ interface ActivationContinuedAfterSchedule {
1710
+ /**
1711
+ * Activation identifier
1712
+ * @format GUID
1713
+ */
1714
+ id?: string;
1715
+ /** Activation Automation */
1716
+ automation?: Automation;
33
1717
  }
34
1718
  interface ReportEventRequest {
35
1719
  /**
@@ -210,6 +1894,624 @@ interface CancelEventRequest {
210
1894
  }
211
1895
  interface CancelEventResponse {
212
1896
  }
1897
+ interface V1RunAutomationRequest extends V1RunAutomationRequestIdentifierOneOf {
1898
+ /** a preinstalled automation identifier */
1899
+ preinstalledIdentifier?: PreinstalledIdentifier;
1900
+ /** a automation of any type identifier that will be available in future */
1901
+ automationIdentifier?: AutomationIdentifier;
1902
+ /**
1903
+ * identifier MUST be either AUTOMATION or PREINSTALLED
1904
+ * @immutable
1905
+ */
1906
+ identifierType?: IdentifierTypeWithLiterals;
1907
+ /**
1908
+ * Event payload, formatted as key:value pairs.
1909
+ * Must comply with the payload schema
1910
+ * if you provided one when configuring your trigger.
1911
+ *
1912
+ * Key names can include only alphanumeric characters or underscores
1913
+ * (`A-Z`, `a-z`, `0-9`, `_`).
1914
+ * They cannot start with an underscore.
1915
+ *
1916
+ * Values can be strings, numbers, integers, booleans, or arrays.
1917
+ * If a value is an array, the array items must be objects,
1918
+ * and nested object properties must be
1919
+ * strings, numbers, integers, or booleans only.
1920
+ */
1921
+ payload?: Record<string, any> | null;
1922
+ /**
1923
+ * When true, indicates this is a migration flow and should bypass
1924
+ * the check for future dates that have already passed.
1925
+ */
1926
+ migrationFlow?: boolean;
1927
+ }
1928
+ /** @oneof */
1929
+ interface V1RunAutomationRequestIdentifierOneOf {
1930
+ /** a preinstalled automation identifier */
1931
+ preinstalledIdentifier?: PreinstalledIdentifier;
1932
+ /** a automation of any type identifier that will be available in future */
1933
+ automationIdentifier?: AutomationIdentifier;
1934
+ }
1935
+ declare enum IdentifierType {
1936
+ UNKNOWN_IDENTIFIER = "UNKNOWN_IDENTIFIER",
1937
+ PREINSTALLED = "PREINSTALLED",
1938
+ AUTOMATION = "AUTOMATION"
1939
+ }
1940
+ /** @enumType */
1941
+ type IdentifierTypeWithLiterals = IdentifierType | 'UNKNOWN_IDENTIFIER' | 'PREINSTALLED' | 'AUTOMATION';
1942
+ interface PreinstalledIdentifier {
1943
+ /**
1944
+ * identifier for the application of the preinstalled
1945
+ * @format GUID
1946
+ */
1947
+ appId?: string;
1948
+ /**
1949
+ * application component id
1950
+ * @format GUID
1951
+ */
1952
+ componentId?: string;
1953
+ }
1954
+ interface AutomationIdentifier {
1955
+ /**
1956
+ * automation id
1957
+ * @format GUID
1958
+ */
1959
+ automationId?: string;
1960
+ }
1961
+ interface V1RunAutomationResponse {
1962
+ }
1963
+ interface ReportDomainEventRequest {
1964
+ /**
1965
+ * trigger app id
1966
+ * @format GUID
1967
+ */
1968
+ triggerAppId?: string;
1969
+ /** report event request */
1970
+ reportEventRequest?: ReportEventRequest;
1971
+ }
1972
+ interface ReportDomainEventResponse {
1973
+ }
1974
+ interface ExecuteFromActionRequest {
1975
+ /**
1976
+ * Requested action id
1977
+ * @format GUID
1978
+ */
1979
+ actionId?: string;
1980
+ /**
1981
+ * Optional: an activation id to link this action to
1982
+ * @format GUID
1983
+ */
1984
+ activationId?: string | null;
1985
+ /** Activation payload */
1986
+ payload?: Record<string, any> | null;
1987
+ /**
1988
+ * Configuration correlation id to run this action from
1989
+ * @format GUID
1990
+ */
1991
+ configurationCorrelationId?: string;
1992
+ /**
1993
+ * Optional - schedule id that this action was scheduled from
1994
+ * @format GUID
1995
+ */
1996
+ scheduleId?: string | null;
1997
+ /**
1998
+ * Optional - an external entity id that this execution is related to
1999
+ * @format GUID
2000
+ */
2001
+ externalEntityId?: string | null;
2002
+ /** Optional - Activation automation */
2003
+ automation?: Automation;
2004
+ }
2005
+ interface ExecuteFromActionResponse {
2006
+ }
2007
+ interface Empty {
2008
+ }
2009
+ interface ActivationScheduleCompleted {
2010
+ /**
2011
+ * Activation identifier
2012
+ * @format GUID
2013
+ */
2014
+ id?: string;
2015
+ /**
2016
+ * Activation schedule identifier
2017
+ * @format GUID
2018
+ */
2019
+ scheduleId?: string;
2020
+ /** Activation schedule due date */
2021
+ scheduleDate?: Date | null;
2022
+ /** Activation payload */
2023
+ payload?: Record<string, any> | null;
2024
+ /** Activation Automation */
2025
+ automation?: Automation;
2026
+ /**
2027
+ * Optional - external entity id that this activation is related to
2028
+ * @format GUID
2029
+ */
2030
+ externalEntityId?: string | null;
2031
+ }
2032
+ interface ActionRetryRequest {
2033
+ /** The activation context */
2034
+ activationContext?: ActivationContext;
2035
+ /** The action to retry */
2036
+ actionToRetryData?: ActionData;
2037
+ }
2038
+ interface ActivationContext {
2039
+ /**
2040
+ * Activation ID
2041
+ * @format GUID
2042
+ */
2043
+ activationId?: string;
2044
+ /**
2045
+ * Action ID
2046
+ * @format GUID
2047
+ */
2048
+ actionId?: string;
2049
+ /**
2050
+ * Configuration ID
2051
+ * @format GUID
2052
+ */
2053
+ configurationId?: string;
2054
+ /**
2055
+ * Configuration Correlation ID
2056
+ * @format GUID
2057
+ */
2058
+ configurationCorrelationId?: string;
2059
+ /** name of the event. intended to keep backwards compatibility, probably not in use. */
2060
+ eventName?: string;
2061
+ /** Event slug, also probably not in use */
2062
+ eventSlug?: string | null;
2063
+ /** Enriched event payload */
2064
+ enrichedEventPayload?: string;
2065
+ /** Raw event payload */
2066
+ rawEventPayload?: string;
2067
+ /** Actions */
2068
+ actions?: ActionData[];
2069
+ /** Activation status */
2070
+ activationStatus?: RuntimeStatusWithLiterals;
2071
+ /** External ID */
2072
+ externalId?: string;
2073
+ /** Automation */
2074
+ automationV2?: Automation;
2075
+ /** Output */
2076
+ output?: string | null;
2077
+ /** trigger schema */
2078
+ triggerSchema?: Record<string, any> | null;
2079
+ }
2080
+ declare enum RuntimeStatus {
2081
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
2082
+ STARTED = "STARTED",
2083
+ ENDED = "ENDED",
2084
+ ERROR = "ERROR",
2085
+ SCHEDULED = "SCHEDULED",
2086
+ FROM_SCHEDULER = "FROM_SCHEDULER",
2087
+ RETRY = "RETRY",
2088
+ RESUMED = "RESUMED",
2089
+ PAUSED = "PAUSED",
2090
+ ACTION_SKIPPED = "ACTION_SKIPPED"
2091
+ }
2092
+ /** @enumType */
2093
+ type RuntimeStatusWithLiterals = RuntimeStatus | 'UNKNOWN_STATUS' | 'STARTED' | 'ENDED' | 'ERROR' | 'SCHEDULED' | 'FROM_SCHEDULER' | 'RETRY' | 'RESUMED' | 'PAUSED' | 'ACTION_SKIPPED';
2094
+ interface ResumeAfterAsyncActionCompleted extends ResumeAfterAsyncActionCompletedStatusInfoOneOf {
2095
+ /** Success info */
2096
+ successInfo?: SuccessInfo;
2097
+ /** Fail info */
2098
+ failureInfo?: FailureInfo;
2099
+ /**
2100
+ * External ID
2101
+ * @format GUID
2102
+ */
2103
+ externalId?: string | null;
2104
+ /** Payload */
2105
+ payload?: Record<string, any> | null;
2106
+ /** Automation */
2107
+ automation?: Automation;
2108
+ /**
2109
+ * Activation ID
2110
+ * @format GUID
2111
+ */
2112
+ activationId?: string;
2113
+ /**
2114
+ * Action ID
2115
+ * @format GUID
2116
+ */
2117
+ actionId?: string;
2118
+ /** Result status */
2119
+ status?: StatusWithLiterals;
2120
+ }
2121
+ /** @oneof */
2122
+ interface ResumeAfterAsyncActionCompletedStatusInfoOneOf {
2123
+ /** Success info */
2124
+ successInfo?: SuccessInfo;
2125
+ /** Fail info */
2126
+ failureInfo?: FailureInfo;
2127
+ }
2128
+ declare enum Status {
2129
+ /** Unknown action completion status. */
2130
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
2131
+ /** Action completed successfully. */
2132
+ SUCCESS = "SUCCESS",
2133
+ /** Action failed to complete. */
2134
+ FAILURE = "FAILURE"
2135
+ }
2136
+ /** @enumType */
2137
+ type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'SUCCESS' | 'FAILURE';
2138
+ interface SuccessInfo {
2139
+ /** Result object that correlates to the output schema. */
2140
+ result?: Record<string, any> | null;
2141
+ }
2142
+ interface FailureInfo {
2143
+ /**
2144
+ * Description of the error that caused the action to fail.
2145
+ * @maxLength 1000
2146
+ */
2147
+ errorDescription?: string;
2148
+ }
2149
+ interface ActivationActionStatusChanged extends ActivationActionStatusChangedInfoOneOf, ActivationActionStatusChangedStatusInfoOneOf {
2150
+ /** App defined action info */
2151
+ appDefinedInfo?: AppDefinedActionInfo;
2152
+ /** Started status information */
2153
+ startedInfo?: StartedStatusInfo;
2154
+ /** Invoked status information */
2155
+ invokedAsyncInfo?: InvokedAsyncStatusInfo;
2156
+ /** Ended status information */
2157
+ endedInfo?: EndedStatusInfo;
2158
+ /** Failed status information */
2159
+ failedInfo?: FailedStatusInfo;
2160
+ /**
2161
+ * Action ID
2162
+ * @format GUID
2163
+ */
2164
+ id?: string;
2165
+ /**
2166
+ * Activation ID
2167
+ * @format GUID
2168
+ */
2169
+ activationId?: string;
2170
+ /**
2171
+ * Automation info
2172
+ * @deprecated Automation info
2173
+ * @replacedBy automation
2174
+ * @targetRemovalDate 2025-12-01
2175
+ */
2176
+ automationInfo?: AutomationInfo;
2177
+ /** Action type */
2178
+ type?: TypeWithLiterals;
2179
+ /** Action attributes */
2180
+ attributes?: ActionAttributes;
2181
+ /** Activation automation */
2182
+ automation?: Automation;
2183
+ /**
2184
+ * External entity ID
2185
+ * @maxLength 40
2186
+ */
2187
+ externalEntityId?: string | null;
2188
+ /** Event date */
2189
+ statusChangedDate?: Date | null;
2190
+ /** Action activation status */
2191
+ status?: ActivationActionStatusChangedStatusWithLiterals;
2192
+ }
2193
+ /** @oneof */
2194
+ interface ActivationActionStatusChangedInfoOneOf {
2195
+ /** App defined action info */
2196
+ appDefinedInfo?: AppDefinedActionInfo;
2197
+ }
2198
+ /** @oneof */
2199
+ interface ActivationActionStatusChangedStatusInfoOneOf {
2200
+ /** Started status information */
2201
+ startedInfo?: StartedStatusInfo;
2202
+ /** Invoked status information */
2203
+ invokedAsyncInfo?: InvokedAsyncStatusInfo;
2204
+ /** Ended status information */
2205
+ endedInfo?: EndedStatusInfo;
2206
+ /** Failed status information */
2207
+ failedInfo?: FailedStatusInfo;
2208
+ }
2209
+ interface RetryInfo {
2210
+ }
2211
+ interface StartedStatusInfoAppDefinedActionInfo {
2212
+ /** Action input */
2213
+ input?: Record<string, any> | null;
2214
+ }
2215
+ interface StartedStatusInfoDelayActionInfo {
2216
+ /** Indicates when this action becomes completed and the activation will move to the post actions */
2217
+ date?: Date | null;
2218
+ }
2219
+ interface InvokedAsyncStatusInfoAppDefinedActionInfo {
2220
+ /** Default action output, in case we reach the timeout before provider called complete action activation method */
2221
+ output?: Record<string, any> | null;
2222
+ /** Timeout date */
2223
+ timeoutDate?: Date | null;
2224
+ }
2225
+ interface ExpressionEvaluationResult {
2226
+ /** Indicates if the expression was evaluated to true or false */
2227
+ passed?: boolean;
2228
+ /** Indicates if there was an error in the evaluation process */
2229
+ error?: boolean;
2230
+ }
2231
+ interface EndedStatusInfoAppDefinedActionInfo {
2232
+ /** Output returned by the action implementer. */
2233
+ output?: Record<string, any> | null;
2234
+ }
2235
+ interface ConditionActionInfo {
2236
+ /** Indicates that the condition `if` clause evaluated to `true`. */
2237
+ passed?: boolean;
2238
+ /** Collects results per each expression evaluation that took place */
2239
+ expressionResults?: Record<string, ExpressionEvaluationResult>;
2240
+ }
2241
+ interface CodeConditionActionInfo {
2242
+ /** Indicates that the code condition `if` clause evaluated to `true`. */
2243
+ passed?: boolean;
2244
+ }
2245
+ interface RateLimitActionInfo {
2246
+ /** Indicates if the rate limiter passed (not reached the quota) */
2247
+ passed?: boolean;
2248
+ }
2249
+ interface DelayActionInfo {
2250
+ /** Enriched and refreshed payload */
2251
+ payload?: Record<string, any> | null;
2252
+ }
2253
+ interface SetVariablesActionInfo {
2254
+ /** Output returned after jsonata expression evaluation */
2255
+ output?: Record<string, any> | null;
2256
+ }
2257
+ interface AutomationInfo extends AutomationInfoOriginInfoOneOf {
2258
+ /** Application info */
2259
+ applicationInfo?: ApplicationOrigin;
2260
+ /** Preinstalled info */
2261
+ preinstalledInfo?: PreinstalledOrigin;
2262
+ /**
2263
+ * Automation ID
2264
+ * @format GUID
2265
+ */
2266
+ id?: string;
2267
+ /** Origin type */
2268
+ origin?: OriginWithLiterals;
2269
+ /** Trigger info */
2270
+ triggerInfo?: AutomationInfoTriggerInfo;
2271
+ }
2272
+ /** @oneof */
2273
+ interface AutomationInfoOriginInfoOneOf {
2274
+ /** Application info */
2275
+ applicationInfo?: ApplicationOrigin;
2276
+ /** Preinstalled info */
2277
+ preinstalledInfo?: PreinstalledOrigin;
2278
+ }
2279
+ interface AutomationInfoTriggerInfo {
2280
+ /**
2281
+ * Trigger app ID
2282
+ * @format GUID
2283
+ */
2284
+ appId?: string;
2285
+ /**
2286
+ * Trigger key
2287
+ * @minLength 1
2288
+ * @maxLength 100
2289
+ */
2290
+ triggerKey?: string;
2291
+ }
2292
+ interface ActionAttributes {
2293
+ /**
2294
+ * Indicates if this action run is part of a retry attempt
2295
+ * If it's not null, it's a retry action run
2296
+ */
2297
+ retry?: RetryInfo;
2298
+ }
2299
+ interface AppDefinedActionInfo {
2300
+ /**
2301
+ * Action app ID
2302
+ * @format GUID
2303
+ */
2304
+ appId?: string;
2305
+ /**
2306
+ * Action key
2307
+ * @minLength 1
2308
+ * @maxLength 100
2309
+ */
2310
+ actionKey?: string;
2311
+ }
2312
+ declare enum ActivationActionStatusChangedStatus {
2313
+ UNKNOWN_ACTION_ACTIVATION_STATUS = "UNKNOWN_ACTION_ACTIVATION_STATUS",
2314
+ /**
2315
+ * Indicates that action activation has started and is in progress.
2316
+ * Relevant to action types: APP_DEFINED, DELAY.
2317
+ */
2318
+ STARTED = "STARTED",
2319
+ /** Indicates that async action was invoked and now waiting to be completed */
2320
+ INVOKED_ASYNC = "INVOKED_ASYNC",
2321
+ /**
2322
+ * Indicates that the action activation was completed without errors.
2323
+ * Relevant to action types: APP_DEFINED, DELAY, CONDITION, RATE_LIMIT.
2324
+ */
2325
+ ENDED = "ENDED",
2326
+ /**
2327
+ * Indicates that the action was skipped and post actions won't start.
2328
+ * Relevant to action types: APP_DEFINED.
2329
+ */
2330
+ SKIPPED = "SKIPPED",
2331
+ /**
2332
+ * Indicates that the action failed.
2333
+ * Relevant to action types: APP_DEFINED, DELAY, RATE_LIMIT.
2334
+ */
2335
+ FAILED = "FAILED"
2336
+ }
2337
+ /** @enumType */
2338
+ type ActivationActionStatusChangedStatusWithLiterals = ActivationActionStatusChangedStatus | 'UNKNOWN_ACTION_ACTIVATION_STATUS' | 'STARTED' | 'INVOKED_ASYNC' | 'ENDED' | 'SKIPPED' | 'FAILED';
2339
+ interface StartedStatusInfo extends StartedStatusInfoTypeInfoOneOf {
2340
+ /** APP DEFINED action additional info */
2341
+ appDefinedActionInfo?: StartedStatusInfoAppDefinedActionInfo;
2342
+ /** Delay action additional info */
2343
+ delayActionInfo?: StartedStatusInfoDelayActionInfo;
2344
+ }
2345
+ /** @oneof */
2346
+ interface StartedStatusInfoTypeInfoOneOf {
2347
+ /** APP DEFINED action additional info */
2348
+ appDefinedActionInfo?: StartedStatusInfoAppDefinedActionInfo;
2349
+ /** Delay action additional info */
2350
+ delayActionInfo?: StartedStatusInfoDelayActionInfo;
2351
+ }
2352
+ interface InvokedAsyncStatusInfo extends InvokedAsyncStatusInfoTypeInfoOneOf {
2353
+ /** APP DEFINED action additional info */
2354
+ appDefinedActionInfo?: InvokedAsyncStatusInfoAppDefinedActionInfo;
2355
+ }
2356
+ /** @oneof */
2357
+ interface InvokedAsyncStatusInfoTypeInfoOneOf {
2358
+ /** APP DEFINED action additional info */
2359
+ appDefinedActionInfo?: InvokedAsyncStatusInfoAppDefinedActionInfo;
2360
+ }
2361
+ interface EndedStatusInfo extends EndedStatusInfoTypeInfoOneOf {
2362
+ /** APP DEFINED action additional info */
2363
+ appDefinedActionInfo?: EndedStatusInfoAppDefinedActionInfo;
2364
+ /** Condition action additional info */
2365
+ conditionActionInfo?: ConditionActionInfo;
2366
+ /** Code Condition action additional info */
2367
+ codeConditionActionInfo?: CodeConditionActionInfo;
2368
+ /** Rate limit action additional info */
2369
+ rateLimitActionInfo?: RateLimitActionInfo;
2370
+ /** Delay action additional info */
2371
+ delayActionInfo?: DelayActionInfo;
2372
+ /** Set Variables action additional info */
2373
+ setVariablesActionInfo?: SetVariablesActionInfo;
2374
+ }
2375
+ /** @oneof */
2376
+ interface EndedStatusInfoTypeInfoOneOf {
2377
+ /** APP DEFINED action additional info */
2378
+ appDefinedActionInfo?: EndedStatusInfoAppDefinedActionInfo;
2379
+ /** Condition action additional info */
2380
+ conditionActionInfo?: ConditionActionInfo;
2381
+ /** Code Condition action additional info */
2382
+ codeConditionActionInfo?: CodeConditionActionInfo;
2383
+ /** Rate limit action additional info */
2384
+ rateLimitActionInfo?: RateLimitActionInfo;
2385
+ /** Delay action additional info */
2386
+ delayActionInfo?: DelayActionInfo;
2387
+ /** Set Variables action additional info */
2388
+ setVariablesActionInfo?: SetVariablesActionInfo;
2389
+ }
2390
+ interface FailedStatusInfo {
2391
+ /**
2392
+ * Error description
2393
+ * @maxLength 1000
2394
+ */
2395
+ errorDescription?: string;
2396
+ /**
2397
+ * Error code
2398
+ * @maxLength 20
2399
+ */
2400
+ errorCode?: string | null;
2401
+ }
2402
+ interface ActivationResumeAfterDelay {
2403
+ /**
2404
+ * Activation identifier
2405
+ * @format GUID
2406
+ */
2407
+ id?: string;
2408
+ /**
2409
+ * Activation schedule identifier
2410
+ * @format GUID
2411
+ */
2412
+ scheduleId?: string;
2413
+ /** Activation schedule due date */
2414
+ scheduleDate?: Date | null;
2415
+ /** Activation payload */
2416
+ payload?: Record<string, any> | null;
2417
+ /** Activation Automation */
2418
+ automation?: Automation;
2419
+ /**
2420
+ * Scheduled action identifier - with the intent to execute that action's post actions
2421
+ * @format GUID
2422
+ */
2423
+ scheduledActionId?: string;
2424
+ /**
2425
+ * Optional - external entity id that this activation is related to
2426
+ * @format GUID
2427
+ */
2428
+ externalEntityId?: string | null;
2429
+ }
2430
+ interface ActionCompletedRequest {
2431
+ /** The execution identifier that was given to the spi provider when we invoked the action */
2432
+ executionIdentifier?: string;
2433
+ /** The result of invoking the action. Must conform to the output schema configured by the action provider. */
2434
+ result?: Record<string, any> | null;
2435
+ }
2436
+ interface RefreshPayloadRequest {
2437
+ /**
2438
+ * Application definition ID.
2439
+ * @format GUID
2440
+ */
2441
+ appDefId?: string;
2442
+ /** Trigger key. */
2443
+ triggerKey?: string;
2444
+ /** Payload to refresh. */
2445
+ payload?: Record<string, any> | null;
2446
+ /** External entity ID. */
2447
+ externalEntityId?: string | null;
2448
+ }
2449
+ interface RefreshPayloadResponse {
2450
+ /** Updated payload. */
2451
+ payload?: Record<string, any> | null;
2452
+ /** If the automation activation should be canceled (default is false) */
2453
+ cancelActivation?: boolean | null;
2454
+ }
2455
+ interface RunAutomationRequest {
2456
+ /**
2457
+ * App of the automation trigger
2458
+ * @format GUID
2459
+ */
2460
+ appId?: string;
2461
+ /**
2462
+ * Trigger key of the action
2463
+ * @minLength 1
2464
+ * @maxLength 100
2465
+ */
2466
+ triggerKey?: string;
2467
+ /** Payload of the triggered event */
2468
+ triggerPayload?: Record<string, any> | null;
2469
+ /**
2470
+ * Specific automation id to run
2471
+ * @format GUID
2472
+ */
2473
+ automationId?: string;
2474
+ /** Schema of the trigger */
2475
+ triggerSchema?: Record<string, any> | null;
2476
+ /** Skip retry mechanism. If set to true, we will not retry the automations actions in case of a retryable error. */
2477
+ skipRetry?: boolean | null;
2478
+ }
2479
+ interface RunAutomationResponse {
2480
+ /** Automation activation output payload */
2481
+ output?: Record<string, any> | null;
2482
+ }
2483
+ interface ReportActionInvocationCompletedRequest extends ReportActionInvocationCompletedRequestStatusInfoOneOf {
2484
+ /** Action output data as defined in your action [output schema](https://dev.wix.com/docs/rest/business-management/automations/actions/about-actions#the-output-schema). */
2485
+ successInfo?: SuccessInfo;
2486
+ /** Information about the action's failure to complete. */
2487
+ failureInfo?: FailureInfo;
2488
+ /** Action completion status. */
2489
+ status?: StatusWithLiterals;
2490
+ /**
2491
+ * Invocation token.
2492
+ * @maxLength 500
2493
+ */
2494
+ invocationToken?: string;
2495
+ }
2496
+ /** @oneof */
2497
+ interface ReportActionInvocationCompletedRequestStatusInfoOneOf {
2498
+ /** Action output data as defined in your action [output schema](https://dev.wix.com/docs/rest/business-management/automations/actions/about-actions#the-output-schema). */
2499
+ successInfo?: SuccessInfo;
2500
+ /** Information about the action's failure to complete. */
2501
+ failureInfo?: FailureInfo;
2502
+ }
2503
+ interface ReportActionInvocationCompletedResponse {
2504
+ }
2505
+ /** @docsIgnore */
2506
+ type ReportEventApplicationErrors = {
2507
+ code?: 'REQUIRED_PROPERTY';
2508
+ description?: string;
2509
+ data?: Record<string, any>;
2510
+ } | {
2511
+ code?: 'SCHEMA_VALIDATION_FAILED';
2512
+ description?: string;
2513
+ data?: Record<string, any>;
2514
+ };
213
2515
 
214
2516
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
215
2517
  getUrl: (context: any) => string;
@@ -226,4 +2528,4 @@ declare function bulkReportEvent(): __PublicMethodMetaInfo<'POST', {}, BulkRepor
226
2528
  declare function bulkCancelEvent(): __PublicMethodMetaInfo<'POST', {}, BulkCancelEventRequest$1, BulkCancelEventRequest, BulkCancelEventResponse$1, BulkCancelEventResponse>;
227
2529
  declare function cancelEvent(): __PublicMethodMetaInfo<'POST', {}, CancelEventRequest$1, CancelEventRequest, CancelEventResponse$1, CancelEventResponse>;
228
2530
 
229
- export { type __PublicMethodMetaInfo, bulkCancelEvent, bulkReportEvent, cancelEvent, reportEvent };
2531
+ export { type AIMetadata as AIMetadataOriginal, type ActionActionOneOf as ActionActionOneOfOriginal, type ActionAttributes as ActionAttributesOriginal, type ActionCodeSnippet as ActionCodeSnippetOriginal, type ActionCompletedRequest as ActionCompletedRequestOriginal, type ActionData as ActionDataOriginal, type ActionEvent as ActionEventOriginal, type Action as ActionOriginal, type ActionRetryRequest as ActionRetryRequestOriginal, type ActionSettings as ActionSettingsOriginal, type ActionSplitAction as ActionSplitActionOriginal, type ActionsData as ActionsDataOriginal, type ActivationActionStatusChangedInfoOneOf as ActivationActionStatusChangedInfoOneOfOriginal, type ActivationActionStatusChanged as ActivationActionStatusChangedOriginal, type ActivationActionStatusChangedStatusInfoOneOf as ActivationActionStatusChangedStatusInfoOneOfOriginal, ActivationActionStatusChangedStatus as ActivationActionStatusChangedStatusOriginal, type ActivationActionStatusChangedStatusWithLiterals as ActivationActionStatusChangedStatusWithLiteralsOriginal, type ActivationContext as ActivationContextOriginal, type ActivationContinuedAfterSchedule as ActivationContinuedAfterScheduleOriginal, type Activation as ActivationOriginal, type ActivationRequest as ActivationRequestOriginal, type ActivationResumeAfterDelay as ActivationResumeAfterDelayOriginal, type ActivationScheduleCompleted as ActivationScheduleCompletedOriginal, type ActivationSourceOfOneOf as ActivationSourceOfOneOfOriginal, type ActivationSource as ActivationSourceOriginal, type ActivationStatusChangedFailedStatusInfo as ActivationStatusChangedFailedStatusInfoOriginal, type ActivationStatusChanged as ActivationStatusChangedOriginal, type ActivationStatusChangedStartedStatusInfo as ActivationStatusChangedStartedStatusInfoOriginal, type ActivationStatusChangedStatusInfoOneOf as ActivationStatusChangedStatusInfoOneOfOriginal, ActivationStatusChangedStatus as ActivationStatusChangedStatusOriginal, type ActivationStatusChangedStatusWithLiterals as ActivationStatusChangedStatusWithLiteralsOriginal, type AppDefinedActionInfo as AppDefinedActionInfoOriginal, type AppDefinedAction as AppDefinedActionOriginal, type ApplicationError as ApplicationErrorOriginal, type ApplicationOrigin as ApplicationOriginOriginal, type AsyncAction as AsyncActionOriginal, type AuditInfoIdOneOf as AuditInfoIdOneOfOriginal, type AuditInfo as AuditInfoOriginal, type AutoArchivePolicy as AutoArchivePolicyOriginal, type AutomationConfigurationActionInfoOneOf as AutomationConfigurationActionInfoOneOfOriginal, type AutomationConfigurationAction as AutomationConfigurationActionOriginal, type AutomationConfiguration as AutomationConfigurationOriginal, AutomationConfigurationStatus as AutomationConfigurationStatusOriginal, type AutomationConfigurationStatusWithLiterals as AutomationConfigurationStatusWithLiteralsOriginal, type AutomationIdentifier as AutomationIdentifierOriginal, type AutomationInfoOriginInfoOneOf as AutomationInfoOriginInfoOneOfOriginal, type AutomationInfo as AutomationInfoOriginal, type AutomationInfoTriggerInfo as AutomationInfoTriggerInfoOriginal, type AutomationOriginInfoOneOf as AutomationOriginInfoOneOfOriginal, type Automation as AutomationOriginal, type AutomationSettings as AutomationSettingsOriginal, type BatchActivationRequest as BatchActivationRequestOriginal, BlockType as BlockTypeOriginal, type BlockTypeWithLiterals as BlockTypeWithLiteralsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCancelEventRequest as BulkCancelEventRequestOriginal, type BulkCancelEventResponse as BulkCancelEventResponseOriginal, type BulkCancelEventResult as BulkCancelEventResultOriginal, type BulkReportEventRequest as BulkReportEventRequestOriginal, type BulkReportEventResponse as BulkReportEventResponseOriginal, type BulkReportEventResult as BulkReportEventResultOriginal, type CancelEventRequest as CancelEventRequestOriginal, type CancelEventResponse as CancelEventResponseOriginal, type CancelPendingScheduleRequestByOneOf as CancelPendingScheduleRequestByOneOfOriginal, type CancelPendingScheduleRequest as CancelPendingScheduleRequestOriginal, type CancelPendingScheduleResponse as CancelPendingScheduleResponseOriginal, CancellationReason as CancellationReasonOriginal, type CancellationReasonWithLiterals as CancellationReasonWithLiteralsOriginal, type CancelledStatusInfo as CancelledStatusInfoOriginal, type Case as CaseOriginal, type CodeConditionActionInfo as CodeConditionActionInfoOriginal, type CodeConditionAction as CodeConditionActionOriginal, type CodeConditionFilter as CodeConditionFilterOriginal, CodeSnippetLanguage as CodeSnippetLanguageOriginal, type CodeSnippetLanguageWithLiterals as CodeSnippetLanguageWithLiteralsOriginal, type CodeSnippet as CodeSnippetOriginal, type ConditionActionInfo as ConditionActionInfoOriginal, type ConditionAction as ConditionActionOriginal, type ConditionBlock as ConditionBlockOriginal, type ConditionExpressionGroup as ConditionExpressionGroupOriginal, type ConditionFilter as ConditionFilterOriginal, type ConsumeReportEventRequest as ConsumeReportEventRequestOriginal, type DelayActionInfo as DelayActionInfoOriginal, type DelayAction as DelayActionOriginal, type DelayHelper as DelayHelperOriginal, type DelayOfOneOf as DelayOfOneOfOriginal, type Delay as DelayOriginal, type Dimensions as DimensionsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, Domain as DomainOriginal, type DomainWithLiterals as DomainWithLiteralsOriginal, type DraftInfo as DraftInfoOriginal, type Empty as EmptyOriginal, type EndedStatusInfoAppDefinedActionInfo as EndedStatusInfoAppDefinedActionInfoOriginal, type EndedStatusInfo as EndedStatusInfoOriginal, type EndedStatusInfoTypeInfoOneOf as EndedStatusInfoTypeInfoOneOfOriginal, type Enrichment as EnrichmentOriginal, type Enrichments as EnrichmentsOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, ErrorReason as ErrorReasonOriginal, type ErrorReasonWithLiterals as ErrorReasonWithLiteralsOriginal, type EventInfo as EventInfoOriginal, type ExecuteFromActionRequest as ExecuteFromActionRequestOriginal, type ExecuteFromActionResponse as ExecuteFromActionResponseOriginal, type ExpressionEvaluationResult as ExpressionEvaluationResultOriginal, type ExtendedFields as ExtendedFieldsOriginal, type FailedStatusInfo as FailedStatusInfoOriginal, type FailureInfo as FailureInfoOriginal, type Filter as FilterOriginal, type FilterValueSelection as FilterValueSelectionOriginal, type FilterableAppDefinedActions as FilterableAppDefinedActionsOriginal, type FutureDateActivationOffset as FutureDateActivationOffsetOriginal, type GetScheduleRequest as GetScheduleRequestOriginal, type GetScheduleResponse as GetScheduleResponseOriginal, type Idempotency as IdempotencyOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, IdentifierType as IdentifierTypeOriginal, type IdentifierTypeWithLiterals as IdentifierTypeWithLiteralsOriginal, type Identity as IdentityOriginal, type IfFilter as IfFilterOriginal, type InitiatedStatusInfo as InitiatedStatusInfoOriginal, type InvokedAsyncStatusInfoAppDefinedActionInfo as InvokedAsyncStatusInfoAppDefinedActionInfoOriginal, type InvokedAsyncStatusInfo as InvokedAsyncStatusInfoOriginal, type InvokedAsyncStatusInfoTypeInfoOneOf as InvokedAsyncStatusInfoTypeInfoOneOfOriginal, type ItemMetadata as ItemMetadataOriginal, Language as LanguageOriginal, type LanguageWithLiterals as LanguageWithLiteralsOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type Metadata as MetadataOriginal, type Note as NoteOriginal, type Notes as NotesOriginal, type Offset as OffsetOriginal, Operator as OperatorOriginal, type OperatorWithLiterals as OperatorWithLiteralsOriginal, Origin as OriginOriginal, type OriginWithLiterals as OriginWithLiteralsOriginal, type OutputAction as OutputActionOriginal, type Output as OutputOriginal, type Path as PathOriginal, type Position as PositionOriginal, type PreinstalledIdentifier as PreinstalledIdentifierOriginal, type PreinstalledOrigin as PreinstalledOriginOriginal, type RateLimitActionInfo as RateLimitActionInfoOriginal, type RateLimitAction as RateLimitActionOriginal, type RateLimit as RateLimitOriginal, type RateLimiting as RateLimitingOriginal, type RefreshPayloadRequest as RefreshPayloadRequestOriginal, type RefreshPayloadResponse as RefreshPayloadResponseOriginal, type ReportActionInvocationCompletedRequest as ReportActionInvocationCompletedRequestOriginal, type ReportActionInvocationCompletedRequestStatusInfoOneOf as ReportActionInvocationCompletedRequestStatusInfoOneOfOriginal, type ReportActionInvocationCompletedResponse as ReportActionInvocationCompletedResponseOriginal, type ReportDomainEventRequest as ReportDomainEventRequestOriginal, type ReportDomainEventResponse as ReportDomainEventResponseOriginal, type ReportEventApplicationErrors as ReportEventApplicationErrorsOriginal, type ReportEventRequest as ReportEventRequestOriginal, type ReportEventResponse as ReportEventResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type ResumeAfterAsyncActionCompleted as ResumeAfterAsyncActionCompletedOriginal, type ResumeAfterAsyncActionCompletedStatusInfoOneOf as ResumeAfterAsyncActionCompletedStatusInfoOneOfOriginal, type RetryInfo as RetryInfoOriginal, type RunAutomationRequest as RunAutomationRequestOriginal, type RunAutomationResponse as RunAutomationResponseOriginal, type Runtime as RuntimeOriginal, RuntimeStatus as RuntimeStatusOriginal, type RuntimeStatusWithLiterals as RuntimeStatusWithLiteralsOriginal, type ScheduleActivationRequested as ScheduleActivationRequestedOriginal, type Schedule as ScheduleOriginal, type ScheduleRequest as ScheduleRequestOriginal, type ScheduleResponse as ScheduleResponseOriginal, ScheduleStatus as ScheduleStatusOriginal, type ScheduleStatusWithLiterals as ScheduleStatusWithLiteralsOriginal, type ScheduledAction as ScheduledActionOriginal, type ScheduledStatusInfo as ScheduledStatusInfoOriginal, type Scheduler as SchedulerOriginal, type ServiceMapping as ServiceMappingOriginal, type Service as ServiceOriginal, type SetVariablesActionInfo as SetVariablesActionInfoOriginal, type SetVariablesAction as SetVariablesActionOriginal, type SetVariables as SetVariablesOriginal, type SimpleDelay as SimpleDelayOriginal, SkipReason as SkipReasonOriginal, type SkipReasonWithLiterals as SkipReasonWithLiteralsOriginal, type SkippedStatusInfo as SkippedStatusInfoOriginal, type SpiAction as SpiActionOriginal, type SplitAction as SplitActionOriginal, type SplitActionPath as SplitActionPathOriginal, type StartedStatusInfoAppDefinedActionInfo as StartedStatusInfoAppDefinedActionInfoOriginal, type StartedStatusInfoDelayActionInfo as StartedStatusInfoDelayActionInfoOriginal, type StartedStatusInfo as StartedStatusInfoOriginal, type StartedStatusInfoTypeInfoOneOf as StartedStatusInfoTypeInfoOneOfOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type SuccessInfo as SuccessInfoOriginal, type SwitchFilter as SwitchFilterOriginal, type SystemHelperHelperOneOf as SystemHelperHelperOneOfOriginal, type SystemHelper as SystemHelperOriginal, Target as TargetOriginal, type TargetWithLiterals as TargetWithLiteralsOriginal, TimeUnit as TimeUnitOriginal, type TimeUnitWithLiterals as TimeUnitWithLiteralsOriginal, type TriggerInfo as TriggerInfoOriginal, type Trigger as TriggerOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, Units as UnitsOriginal, type UnitsWithLiterals as UnitsWithLiteralsOriginal, type UpdatePendingSchedulesPayloadRequest as UpdatePendingSchedulesPayloadRequestOriginal, type UpdatePendingSchedulesPayloadResponse as UpdatePendingSchedulesPayloadResponseOriginal, type UpdateScheduleStatusRequest as UpdateScheduleStatusRequestOriginal, type UpdateScheduleStatusResponse as UpdateScheduleStatusResponseOriginal, type V1RunAutomationRequestIdentifierOneOf as V1RunAutomationRequestIdentifierOneOfOriginal, type V1RunAutomationRequest as V1RunAutomationRequestOriginal, type V1RunAutomationResponse as V1RunAutomationResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkCancelEvent, bulkReportEvent, cancelEvent, reportEvent };