@wix/auto_sdk_automations_activations 1.0.54 → 1.0.55

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