@wix/automations 1.0.0

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.
@@ -0,0 +1,1750 @@
1
+ interface Activation {
2
+ /** Activation ID */
3
+ _id?: string;
4
+ /** Activation automation */
5
+ automation?: Automation;
6
+ }
7
+ /** Automation */
8
+ interface Automation extends AutomationOriginInfoOneOf {
9
+ /** Application info */
10
+ applicationInfo?: ApplicationOrigin;
11
+ /** Preinstalled info */
12
+ preinstalledInfo?: PreinstalledOrigin;
13
+ /**
14
+ * Automation ID.
15
+ * @readonly
16
+ */
17
+ _id?: string | null;
18
+ /**
19
+ * Revision number, which increments by 1 each time the Automation is updated.
20
+ * To prevent conflicting changes,
21
+ * the current revision must be passed when updating the Automation.
22
+ *
23
+ * Ignored when creating an Automation.
24
+ * @readonly
25
+ */
26
+ revision?: string | null;
27
+ /**
28
+ * information about the creator of the automation
29
+ * @readonly
30
+ */
31
+ createdBy?: AuditInfo;
32
+ /**
33
+ * Date and time the Automation was created.
34
+ * @readonly
35
+ */
36
+ _createdDate?: Date;
37
+ /**
38
+ * information about who updated of the automation
39
+ * @readonly
40
+ */
41
+ updatedBy?: AuditInfo;
42
+ /**
43
+ * Date and time the Automation was last updated.
44
+ * @readonly
45
+ */
46
+ _updatedDate?: Date;
47
+ /** Automation name */
48
+ name?: string;
49
+ /** Automation description */
50
+ description?: string | null;
51
+ /** Automation runtime configuration */
52
+ configuration?: AutomationConfiguration;
53
+ /** Origin type */
54
+ origin?: Origin;
55
+ /** Automation settings */
56
+ settings?: AutomationSettings;
57
+ }
58
+ /** @oneof */
59
+ interface AutomationOriginInfoOneOf {
60
+ /** Application info */
61
+ applicationInfo?: ApplicationOrigin;
62
+ /** Preinstalled info */
63
+ preinstalledInfo?: PreinstalledOrigin;
64
+ }
65
+ interface ActionSettings {
66
+ /** list of permanent action ids of actions that cannot be deleted (default - empty, all actions are deletable by default) */
67
+ permanentActionIds?: string[];
68
+ /** list of readonly action ids, (default - empty, all actions are editable by default) */
69
+ readonlyActionIds?: string[];
70
+ /** sets if adding a delay action is disabled for this automation */
71
+ disableDelayAddition?: boolean;
72
+ /** sets if adding a condition action is disabled for this automation */
73
+ disableConditionAddition?: boolean;
74
+ }
75
+ interface AuditInfo extends AuditInfoIdOneOf {
76
+ /** user identifier */
77
+ userId?: string;
78
+ /** application identifier */
79
+ appId?: string;
80
+ }
81
+ /** @oneof */
82
+ interface AuditInfoIdOneOf {
83
+ /** user identifier */
84
+ userId?: string;
85
+ /** application identifier */
86
+ appId?: string;
87
+ }
88
+ /** Automation runtime configuration */
89
+ interface AutomationConfiguration {
90
+ /** Automation's Status */
91
+ status?: AutomationConfigurationStatus;
92
+ /** Trigger configuration */
93
+ trigger?: Trigger;
94
+ /** actions that run in parallel after the trigger */
95
+ rootActionIds?: string[];
96
+ /**
97
+ * map of all actions by actionId
98
+ * The key is the actionId of the action, and the value is the action configuration
99
+ */
100
+ actions?: Record<string, AutomationConfigurationAction>;
101
+ }
102
+ declare enum TimeUnit {
103
+ UNDEFINED = "UNDEFINED",
104
+ MINUTES = "MINUTES",
105
+ HOURS = "HOURS",
106
+ DAYS = "DAYS",
107
+ WEEKS = "WEEKS",
108
+ MONTHS = "MONTHS"
109
+ }
110
+ interface Filter {
111
+ /** the filter identifier */
112
+ _id?: string;
113
+ /** the field key from the schema, for example "formId" */
114
+ fieldKey?: string;
115
+ /** filter expression that evaluates to a boolean, for example - {{ contains(["guid1","guid2"];formId) }} */
116
+ filterExpression?: string;
117
+ }
118
+ interface FutureDateActivationOffset {
119
+ /**
120
+ * expression of offset before the trigger's time (in selected time unit), when the Automation should run
121
+ * only allows negative offset from the trigger's date (before the trigger), positive offset should be achieved via offset delay action
122
+ * preScheduledEventOffsetExpression: "{{5}}" + timeUnit: Days - to run the Automation 5 days before the trigger's date
123
+ * or, preScheduledEventOffsetExpression: "{{ someNumberField }}" + timeUnit: Minutes, to run the Automation someNumberField's value in minutes before the trigger's date
124
+ */
125
+ preScheduledEventOffsetExpression?: string;
126
+ /** Time unit for the scheduled event offset */
127
+ scheduledEventOffsetTimeUnit?: TimeUnit;
128
+ }
129
+ interface ConditionExpressionGroup {
130
+ /** expression group operator */
131
+ operator?: Operator;
132
+ /**
133
+ * list of boolean expressions to be evaluated with the given operator
134
+ * examples - {{ true }}, {{ someBooleanField }}, {{ contains(["guid1...","guid2..."];formId) }}
135
+ */
136
+ booleanExpressions?: string[];
137
+ }
138
+ declare enum Operator {
139
+ UNKNOWN_OPERATOR = "UNKNOWN_OPERATOR",
140
+ OR = "OR",
141
+ AND = "AND"
142
+ }
143
+ declare enum Type {
144
+ /** Automation will be triggered according to the trigger configuration */
145
+ UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
146
+ /** App defined Action */
147
+ APP_DEFINED = "APP_DEFINED",
148
+ /** Condition Action */
149
+ CONDITION = "CONDITION",
150
+ /** Delay Action */
151
+ DELAY = "DELAY",
152
+ /** RateLimit Action */
153
+ RATE_LIMIT = "RATE_LIMIT",
154
+ /** Output Action */
155
+ OUTPUT = "OUTPUT"
156
+ }
157
+ interface AppDefinedAction {
158
+ /** Action app id */
159
+ appId?: string;
160
+ /** Action key */
161
+ actionKey?: string;
162
+ /**
163
+ * Action input mapping, example:
164
+ * {
165
+ * "to": "{{ var(contact.email) }}",
166
+ * "subject": "Your registration to {{ var(eventName) }} is Confirmed",
167
+ * "body": "Hi {{ var(contact.name) }}, you are confirmed for the event"
168
+ * }
169
+ */
170
+ inputMapping?: Record<string, any> | null;
171
+ /**
172
+ * optional skip condition configuration - if this action should be skipped when the automation runs (following actions of a skipped action will still run)
173
+ * the action will be skipped if either of the expression groups evaluate to `true`
174
+ * the relation between the expression groups is an OR relation.
175
+ */
176
+ skipConditionOrExpressionGroups?: ConditionExpressionGroup[];
177
+ /** actions to run in parallel after this action finishes */
178
+ postActionIds?: string[];
179
+ }
180
+ interface ConditionAction {
181
+ /**
182
+ * the condition evaluates to `true` if either of the expression groups evaluate to `true`
183
+ * the relation between the expression groups is an OR relation.
184
+ */
185
+ orExpressionGroups?: ConditionExpressionGroup[];
186
+ /** actions to run when the entire condition is evaluated to `true` */
187
+ truePostActionIds?: string[];
188
+ /** actions to run when the entire condition is evaluated to `false` */
189
+ falsePostActionIds?: string[];
190
+ }
191
+ interface DelayAction {
192
+ /**
193
+ * optional - expression for amount of time to wait (in selected time unit) - from a specific date or from the time the action is executed
194
+ * offsetExpression: "{{5}}" + timeUnit: Days - to wait for 5 days from the time the delay was invoked
195
+ * or, offsetExpression: "{{5}}" + timeUnit: Days + dueDateEpochExpression: "{{someDateField}}" - to wait for 5 days from the time date in "someDateField" field in the payload
196
+ * or, offsetExpression: "{{ someNumberField }}" + timeUnit: Minutes, to wait for someNumberField's value in minutes
197
+ */
198
+ offsetExpression?: string | null;
199
+ /** Time unit for delay offset */
200
+ offsetTimeUnit?: TimeUnit;
201
+ /**
202
+ * optional - expression of the due date to wait until, if an offset was defined, it will be calculated from this date
203
+ * number of milliseconds since the Unix Epoch (1 January, 1970 UTC)
204
+ * for example - "{{ 18238348023423 }}", or "{{ someEpochFromPayloadField }}" / "{{ contact.birthdate }}"
205
+ */
206
+ dueDateEpochExpression?: string | null;
207
+ /** actions to run in parallel after this action finishes */
208
+ postActionIds?: string[];
209
+ }
210
+ interface RateLimitAction {
211
+ /**
212
+ * Maximum number of activations expression. the expression will need to be parsed to Int on runtime
213
+ * for example - "{{ 1 }}" to set max activations to 1, or "{{ var(someNumberField) }}" to set max activations as the value of "someNumberField" from the payload
214
+ */
215
+ maxActivationsExpression?: string;
216
+ /**
217
+ * Duration of the rate limiting window (in selected time unit) expression for rate limiter, if empty then no time limit. the expression will need to be parsed to Int on runtime
218
+ * for example - "{{ 10 }}" to set timeframe to be 10 minutes, or {{ var(someNumberField) }} to set timeframe in minutes as the value of "someNumberField" from the payload
219
+ */
220
+ rateLimitDurationExpression?: string | null;
221
+ /** Time unit for the rate limit duration */
222
+ rateLimitDurationTimeUnit?: TimeUnit;
223
+ /**
224
+ * Unique identifier of each activation by which rate limiter will count activations, expected return type is string
225
+ * for example - {{ var(contact.id) }} to set the unique identifier as the value of "contact.id" from the payload
226
+ */
227
+ uniqueIdentifierExpression?: string | null;
228
+ /** actions to run in parallel after this action finishes */
229
+ postActionIds?: string[];
230
+ }
231
+ interface OutputAction {
232
+ /**
233
+ * Output action output mapping
234
+ * {
235
+ * "to": "{{ var(contact.email) }}"
236
+ * }
237
+ */
238
+ outputMapping?: Record<string, any> | null;
239
+ }
240
+ declare enum AutomationConfigurationStatus {
241
+ /** unused */
242
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
243
+ /** Automation will be triggered according to the trigger configuration */
244
+ ACTIVE = "ACTIVE",
245
+ /** Automation will not be triggered */
246
+ INACTIVE = "INACTIVE"
247
+ }
248
+ interface Trigger {
249
+ /** Trigger Application id */
250
+ appId?: string;
251
+ /** Trigger key */
252
+ triggerKey?: string;
253
+ /**
254
+ * optional - list of filters on schema fields
255
+ * the relation between the filter expressions is an AND relation.
256
+ * all filter expressions must be evaluated to `true` for a given payload in order for the automation to be executed
257
+ */
258
+ filters?: Filter[];
259
+ /** optional - future date trigger activation offset */
260
+ scheduledEventOffset?: FutureDateActivationOffset;
261
+ }
262
+ interface AutomationConfigurationAction extends AutomationConfigurationActionInfoOneOf {
263
+ /** App defined Action (via RPC, HTTP or Velo) */
264
+ appDefinedInfo?: AppDefinedAction;
265
+ /** Condition action */
266
+ conditionInfo?: ConditionAction;
267
+ /** Delay action */
268
+ delayInfo?: DelayAction;
269
+ /** Rate limiting action */
270
+ rateLimitInfo?: RateLimitAction;
271
+ /** Action id, if not specified, will be generated */
272
+ _id?: string | null;
273
+ /** Type of the action */
274
+ type?: Type;
275
+ /**
276
+ * Human readable name for the action (may only contain alphanumeric characters and underscores) to differentiate from other actions of the same kind.
277
+ * if the action has output, the output will be available in the payload under this name, otherwise it will be concatenated to the payload as is
278
+ * without namespaces (or in case of exact same namespaces), if the user has multiple actions of the same kind (appId+actionKey), the output will be overwritten.
279
+ *
280
+ * for example, given:
281
+ * - if the action output looks like this - { "message": "hello" }
282
+ * - the namespace is "action_1"
283
+ * - the trigger payload looks like this - { "someField": "50", "someBoolean": true }
284
+ *
285
+ * the payload will look like this:
286
+ * {
287
+ * "someField": "50",
288
+ * "someBoolean": true,
289
+ * "action_1": {
290
+ * "message": "hello"
291
+ * }
292
+ * }
293
+ *
294
+ * given the following Automation configuration:
295
+ *
296
+ * (Trigger A)
297
+ * |
298
+ * (Action B) // namespace = "action_b_1"
299
+ * |
300
+ * (Action B) // namespace = "action_b_2"
301
+ * |
302
+ * (Action C)
303
+ *
304
+ *
305
+ * the available fields that Action C will be able to use to map to it's input fields will be:
306
+ * {
307
+ * "someField": "50",
308
+ * "someBoolean": true,
309
+ * "action_b_1": {
310
+ * "message": "hello"
311
+ * },
312
+ * "action_b_2": {
313
+ * "message": "hello"
314
+ * }
315
+ * }
316
+ * so the user can select which specific action output to use (action_b_1.message or action_b_2.message, in the case above)
317
+ */
318
+ namespace?: string | null;
319
+ }
320
+ /** @oneof */
321
+ interface AutomationConfigurationActionInfoOneOf {
322
+ /** App defined Action (via RPC, HTTP or Velo) */
323
+ appDefinedInfo?: AppDefinedAction;
324
+ /** Condition action */
325
+ conditionInfo?: ConditionAction;
326
+ /** Delay action */
327
+ delayInfo?: DelayAction;
328
+ /** Rate limiting action */
329
+ rateLimitInfo?: RateLimitAction;
330
+ }
331
+ declare enum Origin {
332
+ /** default value. this is unused */
333
+ UNKNOWN_ORIGIN = "UNKNOWN_ORIGIN",
334
+ /** user created automation */
335
+ USER = "USER",
336
+ /** automation created by application (site specific) */
337
+ APPLICATION = "APPLICATION",
338
+ /** preinstalled application automation */
339
+ PREINSTALLED = "PREINSTALLED"
340
+ }
341
+ interface ApplicationOrigin {
342
+ /** identifier for the application */
343
+ appId?: string;
344
+ }
345
+ interface PreinstalledOrigin {
346
+ /** identifier for the application */
347
+ appId?: string;
348
+ /** application component ID */
349
+ componentId?: string;
350
+ /** application component Version */
351
+ componentVersion?: number;
352
+ /**
353
+ * is this a user modified preinstalled automation (on a specific site) or the original one
354
+ * @readonly
355
+ */
356
+ override?: boolean | null;
357
+ }
358
+ interface AutomationSettings {
359
+ /** sets if the automation is hidden from users */
360
+ hidden?: boolean;
361
+ /** sets if the automation is readonly */
362
+ readonly?: boolean;
363
+ /** sets if deleting the automation is disabled */
364
+ disableDelete?: boolean;
365
+ /** sets if changing the automation status is disabled (from active to inactive and vice versa) */
366
+ disableStatusChange?: boolean;
367
+ /** Automation's action settings */
368
+ actionSettings?: ActionSettings;
369
+ }
370
+ interface ActivationStatus {
371
+ /** Activation's ID. */
372
+ _id?: string;
373
+ /** Configuration's ID. */
374
+ configurationId?: string;
375
+ /** Configuration's Correlation ID. */
376
+ configurationCorrelationId?: string;
377
+ /** Activation's status. */
378
+ status?: Status;
379
+ /** Activation's error reason (if there is one). */
380
+ errorReason?: string | null;
381
+ }
382
+ declare enum Status {
383
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
384
+ STARTED = "STARTED",
385
+ ENDED = "ENDED",
386
+ ERROR = "ERROR",
387
+ SCHEDULED = "SCHEDULED",
388
+ FROM_SCHEDULER = "FROM_SCHEDULER",
389
+ RETRY = "RETRY",
390
+ RESUMED = "RESUMED",
391
+ PAUSED = "PAUSED",
392
+ ACTION_SKIPPED = "ACTION_SKIPPED"
393
+ }
394
+ interface ActivationStatusChanged extends ActivationStatusChangedStatusInfoOneOf {
395
+ /** Initiated status information */
396
+ initiatedInfo?: InitiatedStatusInfo;
397
+ /** Scheduled status information */
398
+ scheduledInfo?: ScheduledStatusInfo;
399
+ /** Cancelled status information */
400
+ cancelledInfo?: CancelledStatusInfo;
401
+ /** Failed status information */
402
+ failedInfo?: ActivationStatusChangedFailedStatusInfo;
403
+ /** Activation */
404
+ activation?: Activation;
405
+ /** Activation status */
406
+ status?: ActivationStatusChangedStatus;
407
+ /** Change event created date */
408
+ statusChangedDate?: Date;
409
+ }
410
+ /** @oneof */
411
+ interface ActivationStatusChangedStatusInfoOneOf {
412
+ /** Initiated status information */
413
+ initiatedInfo?: InitiatedStatusInfo;
414
+ /** Scheduled status information */
415
+ scheduledInfo?: ScheduledStatusInfo;
416
+ /** Cancelled status information */
417
+ cancelledInfo?: CancelledStatusInfo;
418
+ /** Failed status information */
419
+ failedInfo?: ActivationStatusChangedFailedStatusInfo;
420
+ }
421
+ declare enum Target {
422
+ UNKNOWN_TARGET = "UNKNOWN_TARGET",
423
+ SCHEDULE = "SCHEDULE",
424
+ IMMEDIATE = "IMMEDIATE"
425
+ }
426
+ declare enum CancellationReason {
427
+ UNKNOWN_CANCELLATION_REASON = "UNKNOWN_CANCELLATION_REASON",
428
+ /** Indicating that the activation was cancelled directly */
429
+ EVENT_CANCELLED = "EVENT_CANCELLED",
430
+ /** Indicating that the activation is cancelled because the automation was deactivated */
431
+ AUTOMATION_DEACTIVATED = "AUTOMATION_DEACTIVATED",
432
+ /** Indicating that the activation is cancelled because the automation was deleted */
433
+ AUTOMATION_DELETED = "AUTOMATION_DELETED"
434
+ }
435
+ interface Identity {
436
+ /** User ID */
437
+ userId?: string | null;
438
+ /** App ID */
439
+ appId?: string | null;
440
+ }
441
+ declare enum ActivationStatusChangedStatus {
442
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
443
+ /** This indicates activation is not started yet (no action has run yet) */
444
+ INITIATED = "INITIATED",
445
+ /** The activation is in scheduled status when the automation has future date or debounce defined and we're in the waiting stage (no action has run yet) */
446
+ SCHEDULED = "SCHEDULED",
447
+ /** This indicates the automation activation has started and currently in progress */
448
+ STARTED = "STARTED",
449
+ /** This indicates all the automation actions were handled either by invoking them, skipping them etc. */
450
+ ENDED = "ENDED",
451
+ /** This indicates the activation was cancelled */
452
+ CANCELLED = "CANCELLED",
453
+ /**
454
+ * This indicates the activation failed to start
455
+ * Note that failure in the activation of a single action will not result a failure in activation of the entire automation
456
+ */
457
+ FAILED = "FAILED"
458
+ }
459
+ interface InitiatedStatusInfo {
460
+ /** Activation target */
461
+ target?: Target;
462
+ /** Event payload */
463
+ payload?: Record<string, any> | null;
464
+ /** External entity ID */
465
+ externalEntityId?: string | null;
466
+ /** Unique identifier for the request that initiated the automation */
467
+ requestId?: string;
468
+ }
469
+ interface ScheduledStatusInfo {
470
+ /** Schedule identifier */
471
+ scheduleId?: string;
472
+ /** Indicating when the activation should start */
473
+ date?: Date;
474
+ }
475
+ interface CancelledStatusInfo {
476
+ /** Cancellation reason */
477
+ reason?: CancellationReason;
478
+ /** The identity (such as user, app etc.) that caused the cancellation */
479
+ initiator?: Identity;
480
+ }
481
+ interface ActivationStatusChangedFailedStatusInfo {
482
+ /**
483
+ * Error description
484
+ * @readonly
485
+ */
486
+ errorDescription?: string;
487
+ /**
488
+ * Error code
489
+ * @readonly
490
+ */
491
+ errorCode?: string | null;
492
+ }
493
+ interface ScheduleRequest {
494
+ schedule?: Schedule;
495
+ }
496
+ interface Schedule {
497
+ /** @readonly */
498
+ _id?: string | null;
499
+ /** doesn't have to be unique. example: triggerName+entityId */
500
+ identifier?: string;
501
+ configurationCorrelationId?: string;
502
+ activationId?: string;
503
+ scheduledAction?: ScheduledAction;
504
+ /** Raw domain event, not enriched */
505
+ eventPayload?: string;
506
+ /** @readonly */
507
+ scheduleStatus?: ScheduleStatus;
508
+ /** @readonly */
509
+ scheduleDate?: Date;
510
+ /** @readonly */
511
+ _createdDate?: Date;
512
+ /** @readonly */
513
+ _updatedDate?: Date;
514
+ overrideable?: boolean | null;
515
+ triggerInfo?: TriggerInfo;
516
+ automation?: Automation;
517
+ }
518
+ interface ScheduledAction {
519
+ /** Action's id. */
520
+ _id?: string;
521
+ /** decide how long we should wait */
522
+ delay?: Delay;
523
+ }
524
+ interface Delay extends DelayOfOneOf {
525
+ simple?: SimpleDelay;
526
+ /**
527
+ * jsonata expression - sleep until the given date
528
+ * for example: $toMillis(MyObject.Date) + 2*1000*60*60*24) -> will schedule 2 days after MyObject.Date
529
+ */
530
+ dateExpression?: string;
531
+ }
532
+ /** @oneof */
533
+ interface DelayOfOneOf {
534
+ simple?: SimpleDelay;
535
+ /**
536
+ * jsonata expression - sleep until the given date
537
+ * for example: $toMillis(MyObject.Date) + 2*1000*60*60*24) -> will schedule 2 days after MyObject.Date
538
+ */
539
+ dateExpression?: string;
540
+ }
541
+ interface SimpleDelay {
542
+ value?: number;
543
+ units?: Units;
544
+ /** Optional, used if provided: Jsonata expression that evaluates to a number of milliseconds to wait */
545
+ delayExpression?: string | null;
546
+ }
547
+ declare enum Units {
548
+ UNKNOWN = "UNKNOWN",
549
+ MINUTES = "MINUTES",
550
+ HOURS = "HOURS",
551
+ DAYS = "DAYS"
552
+ }
553
+ declare enum ScheduleStatus {
554
+ UNKNOWN_SCHEDULE_STATUS = "UNKNOWN_SCHEDULE_STATUS",
555
+ PENDING = "PENDING",
556
+ CANCELLED = "CANCELLED",
557
+ DONE = "DONE"
558
+ }
559
+ interface TriggerInfo {
560
+ /** App id of the initial trigger. */
561
+ appId?: string;
562
+ /** Trigger key of the initial trigger. */
563
+ triggerKey?: string;
564
+ }
565
+ interface ScheduleResponse {
566
+ _id?: string;
567
+ }
568
+ interface CancelPendingScheduleRequest extends CancelPendingScheduleRequestByOneOf {
569
+ _id?: string;
570
+ identifier?: string;
571
+ configurationCorrelationId?: string;
572
+ activationId?: string;
573
+ identifierPattern?: string;
574
+ }
575
+ /** @oneof */
576
+ interface CancelPendingScheduleRequestByOneOf {
577
+ _id?: string;
578
+ identifier?: string;
579
+ configurationCorrelationId?: string;
580
+ activationId?: string;
581
+ identifierPattern?: string;
582
+ }
583
+ interface CancelPendingScheduleResponse {
584
+ }
585
+ interface UpdatePendingSchedulesPayloadRequest {
586
+ identifier?: string;
587
+ eventPayload?: string;
588
+ }
589
+ interface UpdatePendingSchedulesPayloadResponse {
590
+ }
591
+ interface DomainEvent extends DomainEventBodyOneOf {
592
+ createdEvent?: EntityCreatedEvent;
593
+ updatedEvent?: EntityUpdatedEvent;
594
+ deletedEvent?: EntityDeletedEvent;
595
+ actionEvent?: ActionEvent;
596
+ /**
597
+ * Unique event ID.
598
+ * Allows clients to ignore duplicate webhooks.
599
+ */
600
+ _id?: string;
601
+ /**
602
+ * Assumes actions are also always typed to an entity_type
603
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
604
+ */
605
+ entityFqdn?: string;
606
+ /**
607
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
608
+ * This is although the created/updated/deleted notion is duplication of the oneof types
609
+ * Example: created/updated/deleted/started/completed/email_opened
610
+ */
611
+ slug?: string;
612
+ /** ID of the entity associated with the event. */
613
+ entityId?: string;
614
+ /** Event timestamp. */
615
+ eventTime?: Date;
616
+ /**
617
+ * Whether the event was triggered as a result of a privacy regulation application
618
+ * (for example, GDPR).
619
+ */
620
+ triggeredByAnonymizeRequest?: boolean | null;
621
+ /** If present, indicates the action that triggered the event. */
622
+ originatedFrom?: string | null;
623
+ /**
624
+ * A sequence number defining the order of updates to the underlying entity.
625
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
626
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
627
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
628
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
629
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
630
+ */
631
+ entityEventSequence?: string | null;
632
+ }
633
+ /** @oneof */
634
+ interface DomainEventBodyOneOf {
635
+ createdEvent?: EntityCreatedEvent;
636
+ updatedEvent?: EntityUpdatedEvent;
637
+ deletedEvent?: EntityDeletedEvent;
638
+ actionEvent?: ActionEvent;
639
+ }
640
+ interface EntityCreatedEvent {
641
+ entity?: string;
642
+ }
643
+ interface EntityUpdatedEvent {
644
+ /**
645
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
646
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
647
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
648
+ */
649
+ currentEntity?: string;
650
+ }
651
+ interface EntityDeletedEvent {
652
+ /** Entity that was deleted */
653
+ deletedEntity?: string | null;
654
+ }
655
+ interface ActionEvent {
656
+ body?: string;
657
+ }
658
+ interface MessageEnvelope {
659
+ /** App instance ID. */
660
+ instanceId?: string | null;
661
+ /** Event type. */
662
+ eventType?: string;
663
+ /** The identification type and identity data. */
664
+ identity?: IdentificationData;
665
+ /** Stringify payload. */
666
+ data?: string;
667
+ }
668
+ interface IdentificationData extends IdentificationDataIdOneOf {
669
+ /** ID of a site visitor that has not logged in to the site. */
670
+ anonymousVisitorId?: string;
671
+ /** ID of a site visitor that has logged in to the site. */
672
+ memberId?: string;
673
+ /** ID of a Wix user (site owner, contributor, etc.). */
674
+ wixUserId?: string;
675
+ /** ID of an app. */
676
+ appId?: string;
677
+ /** @readonly */
678
+ identityType?: WebhookIdentityType;
679
+ }
680
+ /** @oneof */
681
+ interface IdentificationDataIdOneOf {
682
+ /** ID of a site visitor that has not logged in to the site. */
683
+ anonymousVisitorId?: string;
684
+ /** ID of a site visitor that has logged in to the site. */
685
+ memberId?: string;
686
+ /** ID of a Wix user (site owner, contributor, etc.). */
687
+ wixUserId?: string;
688
+ /** ID of an app. */
689
+ appId?: string;
690
+ }
691
+ declare enum WebhookIdentityType {
692
+ UNKNOWN = "UNKNOWN",
693
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
694
+ MEMBER = "MEMBER",
695
+ WIX_USER = "WIX_USER",
696
+ APP = "APP"
697
+ }
698
+ interface ActivationRequest {
699
+ /** Activation's ID. */
700
+ activationId?: string;
701
+ /** Configuration's ID. */
702
+ configurationId?: string;
703
+ configurationCorrelationId?: string;
704
+ /** Received event name. */
705
+ eventName?: string;
706
+ /** Received event slug. */
707
+ eventSlug?: string | null;
708
+ /** Received event payload. */
709
+ eventPayload?: string | null;
710
+ /** List of action data. */
711
+ actions?: ActionData[];
712
+ /** External ID. */
713
+ externalId?: string;
714
+ /** The source of this activation */
715
+ source?: ActivationSource;
716
+ /** Actions tree */
717
+ actionsMap?: ActionsData;
718
+ /** Automation V2. Used for reporting domain event until activation request will be deprecated. */
719
+ automation?: Automation;
720
+ /** Trigger entity for the activation, available for v2 and v3 automations only */
721
+ triggerSchema?: Record<string, any> | null;
722
+ }
723
+ interface Runtime {
724
+ }
725
+ interface Scheduler {
726
+ scheduleId?: string | null;
727
+ }
728
+ interface AsyncAction {
729
+ }
730
+ interface ActionData {
731
+ /**
732
+ * Action's id.
733
+ * @readonly
734
+ */
735
+ _id?: string | null;
736
+ /** Action's data. */
737
+ action?: Action;
738
+ }
739
+ interface Action extends ActionActionOneOf {
740
+ service?: Service;
741
+ systemHelper?: SystemHelper;
742
+ spiAction?: SpiAction;
743
+ }
744
+ /** @oneof */
745
+ interface ActionActionOneOf {
746
+ service?: Service;
747
+ systemHelper?: SystemHelper;
748
+ spiAction?: SpiAction;
749
+ }
750
+ interface ServiceMapping {
751
+ /** Sevice name. */
752
+ name?: string;
753
+ /** Method name. */
754
+ method?: string;
755
+ }
756
+ interface IfFilter {
757
+ /** If filter's condition. */
758
+ condition?: string;
759
+ /** If's true post actions. */
760
+ truePostActions?: ActionData[];
761
+ /** If's false post actions. */
762
+ falsePostActions?: ActionData[];
763
+ /** If's true post actions ids. */
764
+ truePostActionsIds?: string[];
765
+ /** If's false post actions ids. */
766
+ falsePostActionsIds?: string[];
767
+ }
768
+ interface SwitchFilter {
769
+ /** Switch's filter cases. */
770
+ cases?: Case[];
771
+ }
772
+ interface Case {
773
+ /** Case's condition. */
774
+ condition?: any;
775
+ /** Case's post actions. */
776
+ postActions?: ActionData[];
777
+ /** Case's post actions ids. */
778
+ postActionsIds?: string[];
779
+ }
780
+ interface DelayHelper {
781
+ /** jsonata expression, for example: triggerName + eventId */
782
+ scheduleIdentifier?: string;
783
+ /** decide how long we should wait */
784
+ delay?: Delay;
785
+ /** Delay's post actions. */
786
+ postActions?: ActionData[];
787
+ /**
788
+ * Optional: if true, any new schedule with the same schedule identifier will override the existing one.
789
+ * If false, the new schedule will be ignored.
790
+ */
791
+ overrideable?: boolean | null;
792
+ /** Delay's post actions ids. */
793
+ postActionsIds?: string[];
794
+ }
795
+ interface RateLimiting {
796
+ /** The maximum number of activations allowed in the given time frame */
797
+ maxNumOfActivations?: number;
798
+ /** Optional, used if provided: A jsonata expression that evaluates to the maximum number of activations allowed in the given time frame */
799
+ maxNumOfActivationsExpression?: string | null;
800
+ /** If given - the time frame in minutes, otherwise, for life */
801
+ timeFrameInMinutes?: number | null;
802
+ /** Optional, used if provided - A jsonata expression that evaluates to the time frame in minutes, otherwise, for life */
803
+ timeFrameInMinutesExpression?: string | null;
804
+ /** The jsonata to use to extract the entity/resource key from the enriched event payload */
805
+ keyJsonata?: string;
806
+ /** 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 */
807
+ postActions?: ActionData[];
808
+ /** 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 */
809
+ postActionsIds?: string[];
810
+ }
811
+ interface ConditionFilter {
812
+ /** condition evaluates to `true` if either of the blocks evaluate to `true` (aka OR between all). */
813
+ conditionBlocks?: ConditionBlock[];
814
+ /** Actions to perform when condition_blocks evaluates to `true`. */
815
+ postActions?: ActionData[];
816
+ /** Action's post actions ids. */
817
+ postActionsIds?: string[];
818
+ /** Actions to perform when condition_blocks evaluates to `false`. */
819
+ elsePostActions?: ActionData[];
820
+ }
821
+ declare enum BlockType {
822
+ UNKNOWN = "UNKNOWN",
823
+ OR = "OR",
824
+ AND = "AND"
825
+ }
826
+ interface ConditionBlock {
827
+ type?: BlockType;
828
+ lineExpressions?: string[];
829
+ }
830
+ interface Output {
831
+ /** The jsonata to use to produce the output */
832
+ outputMapping?: string;
833
+ }
834
+ interface Service {
835
+ /** Action's service mapping. */
836
+ serviceMapping?: ServiceMapping;
837
+ /**
838
+ * Action's input mapping.
839
+ * Jsonata description of the input this service gets.
840
+ */
841
+ inputMapping?: string | null;
842
+ /**
843
+ * Action's output mapping.
844
+ * Jsonata description of the output this service returns.
845
+ */
846
+ outputMapping?: string | null;
847
+ /** Action's post actions. */
848
+ postActions?: ActionData[];
849
+ /** Action's post actions ids. */
850
+ postActionsIds?: string[];
851
+ /** The namespace of the action */
852
+ namespace?: string | null;
853
+ }
854
+ interface SystemHelper extends SystemHelperHelperOneOf {
855
+ ifFilter?: IfFilter;
856
+ switchFilter?: SwitchFilter;
857
+ delay?: DelayHelper;
858
+ rateLimiting?: RateLimiting;
859
+ conditionFilter?: ConditionFilter;
860
+ output?: Output;
861
+ }
862
+ /** @oneof */
863
+ interface SystemHelperHelperOneOf {
864
+ ifFilter?: IfFilter;
865
+ switchFilter?: SwitchFilter;
866
+ delay?: DelayHelper;
867
+ rateLimiting?: RateLimiting;
868
+ conditionFilter?: ConditionFilter;
869
+ output?: Output;
870
+ }
871
+ interface SpiAction {
872
+ /** The App Def Id of the action provider */
873
+ appDefId?: string;
874
+ /** Identifier for this action - human readable action key - unique per app def id */
875
+ actionKey?: string;
876
+ /** The configuration of the user for this action, can include params that are taken from the trigger event payload */
877
+ userActionConfig?: string | null;
878
+ /** The post action to execute after this action */
879
+ postActions?: ActionData[];
880
+ /** The output configuration of the user for this action, can include params that are taken from the trigger event payload */
881
+ userOutputActionConfig?: string | null;
882
+ /**
883
+ * optional skip condition expression for current action
884
+ * decides whether to skip the action before executing it's post actions
885
+ */
886
+ skipConditionExpression?: string | null;
887
+ /** Action's post actions ids. */
888
+ postActionsIds?: string[];
889
+ /** The namespace of the action */
890
+ namespace?: string | null;
891
+ }
892
+ interface ActivationSource extends ActivationSourceOfOneOf {
893
+ runtime?: Runtime;
894
+ scheduler?: Scheduler;
895
+ asyncAction?: AsyncAction;
896
+ }
897
+ /** @oneof */
898
+ interface ActivationSourceOfOneOf {
899
+ runtime?: Runtime;
900
+ scheduler?: Scheduler;
901
+ asyncAction?: AsyncAction;
902
+ }
903
+ interface ActionsData {
904
+ /** Ids of the first level actions. */
905
+ rootActionIds?: string[];
906
+ /** Map of action id to action data. */
907
+ actions?: Record<string, Action>;
908
+ }
909
+ interface ActionStatus {
910
+ /** Action's status. */
911
+ _id?: string;
912
+ /** Activation's ID. */
913
+ activationId?: string;
914
+ /** Action's name. */
915
+ actionName?: string | null;
916
+ /** Action's status. */
917
+ status?: Status;
918
+ /** Action's error reason (if there is one). */
919
+ errorReason?: string | null;
920
+ /** Activation external id. */
921
+ activationExternalId?: string;
922
+ /** Trigger app id. */
923
+ triggerAppId?: string | null;
924
+ /** Trigger key. */
925
+ triggerKey?: string | null;
926
+ /** The configuration correlation id */
927
+ configurationCorrelationId?: string | null;
928
+ }
929
+ interface BatchActivationRequest {
930
+ /** List of Activation-Request. */
931
+ activationRequests?: ActivationRequest[];
932
+ }
933
+ interface Empty {
934
+ }
935
+ interface ActivationActionStatusChanged extends ActivationActionStatusChangedStatusInfoOneOf {
936
+ /** Started status information */
937
+ startedInfo?: StartedStatusInfo;
938
+ /** Ended status information */
939
+ endedInfo?: EndedStatusInfo;
940
+ /** Failed status information */
941
+ failedInfo?: FailedStatusInfo;
942
+ /** Action ID */
943
+ _id?: string;
944
+ /** Activation ID */
945
+ activationId?: string;
946
+ /** Automation info */
947
+ automationInfo?: AutomationInfo;
948
+ /** Action type */
949
+ type?: Type;
950
+ /** Event date */
951
+ statusChangedDate?: Date;
952
+ /** Action activation status */
953
+ status?: ActivationActionStatusChangedStatus;
954
+ }
955
+ /** @oneof */
956
+ interface ActivationActionStatusChangedStatusInfoOneOf {
957
+ /** Started status information */
958
+ startedInfo?: StartedStatusInfo;
959
+ /** Ended status information */
960
+ endedInfo?: EndedStatusInfo;
961
+ /** Failed status information */
962
+ failedInfo?: FailedStatusInfo;
963
+ }
964
+ interface StartedStatusInfoAppDefinedActionInfo {
965
+ /** Action input */
966
+ input?: Record<string, any> | null;
967
+ }
968
+ interface DelayActionInfo {
969
+ /** Indicates when this action becomes completed and the activation will move to the post actions */
970
+ date?: Date;
971
+ }
972
+ interface ExpressionEvaluationResult {
973
+ /** Indicates if the expression was evaluated to true or false */
974
+ passed?: boolean;
975
+ /** Indicates if there was an error in the evaluation process */
976
+ error?: boolean;
977
+ }
978
+ interface AppDefinedActionInfo {
979
+ /** The output that the action implementer returned */
980
+ output?: Record<string, any> | null;
981
+ }
982
+ interface ConditionActionInfo {
983
+ /** Indicates that the condition `if` clause evaluated to `true` */
984
+ passed?: boolean;
985
+ /** Collects results per each expression evaluation that took place */
986
+ expressionResults?: Record<string, ExpressionEvaluationResult>;
987
+ }
988
+ interface RateLimitActionInfo {
989
+ /** Indicates if the rate limiter passed (not reached the quota) */
990
+ passed?: boolean;
991
+ }
992
+ interface AutomationInfo extends AutomationInfoOriginInfoOneOf {
993
+ /** Application info */
994
+ applicationInfo?: ApplicationOrigin;
995
+ /** Preinstalled info */
996
+ preinstalledInfo?: PreinstalledOrigin;
997
+ /** Automation ID */
998
+ _id?: string;
999
+ /** Origin type */
1000
+ origin?: Origin;
1001
+ }
1002
+ /** @oneof */
1003
+ interface AutomationInfoOriginInfoOneOf {
1004
+ /** Application info */
1005
+ applicationInfo?: ApplicationOrigin;
1006
+ /** Preinstalled info */
1007
+ preinstalledInfo?: PreinstalledOrigin;
1008
+ }
1009
+ declare enum ActivationActionStatusChangedStatus {
1010
+ UNKNOWN_ACTION_ACTIVATION_STATUS = "UNKNOWN_ACTION_ACTIVATION_STATUS",
1011
+ /**
1012
+ * Indicating that action activation has been started and it's in progress
1013
+ * Relevant to action types: APP_DEFINED, DELAY
1014
+ */
1015
+ STARTED = "STARTED",
1016
+ /**
1017
+ * Indicating that the action activation is completed without errors
1018
+ * Relevant to action types: APP_DEFINED, DELAY, CONDITION, RATE_LIMIT
1019
+ */
1020
+ ENDED = "ENDED",
1021
+ /**
1022
+ * Indicating that the action is skipped and post actions will not start
1023
+ * Relevant to action types: APP_DEFINED
1024
+ */
1025
+ SKIPPED = "SKIPPED",
1026
+ /**
1027
+ * Indicating that the action failed
1028
+ * Relevant to action types: APP_DEFINED, DELAY, RATE_LIMIT
1029
+ */
1030
+ FAILED = "FAILED"
1031
+ }
1032
+ interface StartedStatusInfo extends StartedStatusInfoTypeInfoOneOf {
1033
+ /** APP DEFINED action additional info */
1034
+ appDefinedActionInfo?: StartedStatusInfoAppDefinedActionInfo;
1035
+ /** Delay action additional info */
1036
+ delayActionInfo?: DelayActionInfo;
1037
+ }
1038
+ /** @oneof */
1039
+ interface StartedStatusInfoTypeInfoOneOf {
1040
+ /** APP DEFINED action additional info */
1041
+ appDefinedActionInfo?: StartedStatusInfoAppDefinedActionInfo;
1042
+ /** Delay action additional info */
1043
+ delayActionInfo?: DelayActionInfo;
1044
+ }
1045
+ interface EndedStatusInfo extends EndedStatusInfoTypeInfoOneOf {
1046
+ /** APP DEFINED action additional info */
1047
+ appDefinedActionInfo?: AppDefinedActionInfo;
1048
+ /** Condition action additional info */
1049
+ conditionActionInfo?: ConditionActionInfo;
1050
+ /** Rate limit action additional info */
1051
+ rateLimitActionInfo?: RateLimitActionInfo;
1052
+ }
1053
+ /** @oneof */
1054
+ interface EndedStatusInfoTypeInfoOneOf {
1055
+ /** APP DEFINED action additional info */
1056
+ appDefinedActionInfo?: AppDefinedActionInfo;
1057
+ /** Condition action additional info */
1058
+ conditionActionInfo?: ConditionActionInfo;
1059
+ /** Rate limit action additional info */
1060
+ rateLimitActionInfo?: RateLimitActionInfo;
1061
+ }
1062
+ interface FailedStatusInfo {
1063
+ /** Error description */
1064
+ errorDescription?: string;
1065
+ /** Error code */
1066
+ errorCode?: string | null;
1067
+ }
1068
+ interface ActivationResumeAfterDelay {
1069
+ /** Activation identifier */
1070
+ _id?: string;
1071
+ /** Activation schedule identifier */
1072
+ scheduleId?: string;
1073
+ /** Activation schedule due date */
1074
+ scheduleDate?: Date;
1075
+ /** Activation payload */
1076
+ payload?: Record<string, any> | null;
1077
+ /** Activation Automation */
1078
+ automation?: Automation;
1079
+ /** Scheduled action identifier - with the intent to execute that action's post actions */
1080
+ scheduledActionId?: string;
1081
+ /** Optional - external entity id that this activation is related to */
1082
+ externalEntityId?: string | null;
1083
+ }
1084
+ interface ActionCompletedRequest {
1085
+ /** The execution identifier that was given to the spi provider when we invoked the action */
1086
+ executionIdentifier?: string;
1087
+ /** The result of invoking the action. Must conform to the output schema configured by the action provider. */
1088
+ result?: Record<string, any> | null;
1089
+ }
1090
+ interface RefreshPayloadRequest {
1091
+ /** Application definition ID. */
1092
+ appDefId?: string;
1093
+ /** Trigger key. */
1094
+ triggerKey?: string;
1095
+ /** Payload to refresh. */
1096
+ payload?: Record<string, any> | null;
1097
+ /** External entity ID. */
1098
+ externalEntityId?: string | null;
1099
+ }
1100
+ interface RefreshPayloadResponse {
1101
+ /** Updated payload. */
1102
+ payload?: Record<string, any> | null;
1103
+ /** If the automation activation should be canceled (default is false) */
1104
+ cancelActivation?: boolean | null;
1105
+ }
1106
+ interface RunAutomationRequest {
1107
+ /** App of the automation trigger */
1108
+ appId?: string;
1109
+ /** Trigger key of the action */
1110
+ triggerKey?: string;
1111
+ /** Payload of the triggered event */
1112
+ triggerPayload?: Record<string, any> | null;
1113
+ /** Specific automation id to run */
1114
+ automationId?: string;
1115
+ }
1116
+ interface RunAutomationResponse {
1117
+ /** Automation activation output payload */
1118
+ output?: Record<string, any> | null;
1119
+ }
1120
+ interface ActivationScheduleRequested {
1121
+ /** Activation identifier */
1122
+ _id?: string;
1123
+ /** Activation schedule request date */
1124
+ requestedDate?: Date;
1125
+ /** Activation schedule due date */
1126
+ scheduleDate?: Date;
1127
+ /** Activation payload */
1128
+ payload?: Record<string, any> | null;
1129
+ /** Activation Automation */
1130
+ automation?: Automation;
1131
+ /** Optional - external entity id that this activation is related to */
1132
+ externalEntityId?: string | null;
1133
+ }
1134
+ interface ActivationContinuedAfterSchedule {
1135
+ /** Activation identifier */
1136
+ _id?: string;
1137
+ /** Activation Automation */
1138
+ automation?: Automation;
1139
+ }
1140
+ interface ReportEventRequest {
1141
+ /**
1142
+ * Trigger key as defined in your app's trigger configuration
1143
+ * in the Wix Developers Center.
1144
+ * For example, `form_submitted` or `invoice_due`.
1145
+ */
1146
+ triggerKey: string;
1147
+ /**
1148
+ * Event payload, formatted as key:value pairs.
1149
+ * Must comply with the payload schema
1150
+ * if you provided one when configuring your trigger.
1151
+ *
1152
+ * Key names can include only alphanumeric characters or underscores
1153
+ * (`A-Z`, `a-z`, `0-9`, `_`).
1154
+ * They cannot start with an underscore.
1155
+ *
1156
+ * Values can be strings, numbers, integers, booleans, or arrays.
1157
+ * If a value is an array, the array items must be objects,
1158
+ * and nested object properties must be
1159
+ * strings, numbers, integers, or booleans only.
1160
+ */
1161
+ payload?: Record<string, any> | null;
1162
+ /**
1163
+ * ID of the related resource in GUID format.
1164
+ * For example, `fc81a355-3429-50fc-a4c7-def486e828f3`.
1165
+ *
1166
+ * Required if your app needs to
1167
+ * [cancel the event](https://dev.wix.com/docs/rest/business-management/automations/triggered-events/cancel-event)
1168
+ * if the automation becomes no longer relevant.
1169
+ *
1170
+ * Typically, this ID is defined in your system,
1171
+ * but you can also use any Wix resource GUID,
1172
+ * such as contact ID, member ID, or invoice ID.
1173
+ * See
1174
+ * [Choose the right `externalEntityId`](https://dev.wix.com/docs/rest/business-management/automations/triggered-events/reporting-and-canceling-events#about-canceling-events)
1175
+ * for more information.
1176
+ */
1177
+ externalEntityId?: string | null;
1178
+ /** Idempotency information for the event */
1179
+ idempotency?: Idempotency;
1180
+ }
1181
+ interface Idempotency {
1182
+ /**
1183
+ * A unique identifier for the event.
1184
+ * If you send the same idempotency key in multiple report event requests, for the same trigger key and app id,
1185
+ * consecutive requests will be ignored after the first one. Note that the idempotency key is kept for a week before it expires.
1186
+ */
1187
+ key?: string;
1188
+ /** Optional. The time to live (TTL) in milliseconds before the key will expire. Default is a week. */
1189
+ ttlInMilliseconds?: string | null;
1190
+ }
1191
+ interface ReportEventResponse {
1192
+ /** The activation IDs of triggered ReportEvents. */
1193
+ activationIds?: string[];
1194
+ }
1195
+ interface BulkReportEventRequest {
1196
+ /**
1197
+ * Trigger key as defined in your app's trigger configuration
1198
+ * in the Wix Developers Center.
1199
+ * For example, `form_submitted` or `invoice_due`.
1200
+ */
1201
+ triggerKey: string;
1202
+ /** Repeated list of event details for bulk reporting */
1203
+ eventsInfo: EventInfo[];
1204
+ }
1205
+ interface EventInfo {
1206
+ /**
1207
+ * Event payload, formatted as key:value pairs.
1208
+ * Must comply with the payload schema
1209
+ * if you provided one when configuring your trigger.
1210
+ */
1211
+ payload?: Record<string, any> | null;
1212
+ /** ID of the related resource in GUID format. */
1213
+ externalEntityId?: string | null;
1214
+ /** Idempotency information for the event */
1215
+ idempotency?: Idempotency;
1216
+ }
1217
+ interface BulkReportEventResponse {
1218
+ /** Trigger key associated with the event */
1219
+ triggerKey?: string;
1220
+ /** List of results for each item in the bulk report event request */
1221
+ results?: BulkReportEventResult[];
1222
+ /** Metadata for the overall bulk action, including success and failure counts */
1223
+ bulkActionMetadata?: BulkActionMetadata;
1224
+ }
1225
+ interface BulkReportEventResult {
1226
+ /** Metadata for the individual item in the request */
1227
+ itemMetadata?: ItemMetadata;
1228
+ /** Event details for the item in the request */
1229
+ eventInfo?: EventInfo;
1230
+ /** The activation IDs of triggered ReportEvents. */
1231
+ activationIds?: string[];
1232
+ }
1233
+ interface ItemMetadata {
1234
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
1235
+ _id?: string | null;
1236
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
1237
+ originalIndex?: number;
1238
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
1239
+ success?: boolean;
1240
+ /** Details about the error in case of failure. */
1241
+ error?: ApplicationError;
1242
+ }
1243
+ interface ApplicationError {
1244
+ /** Error code. */
1245
+ code?: string;
1246
+ /** Description of the error. */
1247
+ description?: string;
1248
+ /** Data related to the error. */
1249
+ data?: Record<string, any> | null;
1250
+ }
1251
+ interface BulkActionMetadata {
1252
+ /** Number of items that were successfully processed. */
1253
+ totalSuccesses?: number;
1254
+ /** Number of items that couldn't be processed. */
1255
+ totalFailures?: number;
1256
+ /** Number of failures without details because detailed failure threshold was exceeded. */
1257
+ undetailedFailures?: number;
1258
+ }
1259
+ interface BulkCancelEventRequest {
1260
+ /**
1261
+ * Trigger key whose events you want to cancel.
1262
+ * For example, `form_submitted` or `invoice_due`.
1263
+ */
1264
+ triggerKey: string;
1265
+ /** Repeated list of external_entity_id, representing the related resources' IDs */
1266
+ externalEntityIds: string[];
1267
+ }
1268
+ interface BulkCancelEventResponse {
1269
+ /** Trigger key related to the cancelled event */
1270
+ triggerKey?: string;
1271
+ /** List of results for each item in the bulk cancel event request */
1272
+ results?: BulkCancelEventResult[];
1273
+ /** Metadata for the overall bulk action, including success and failure counts */
1274
+ bulkActionMetadata?: BulkActionMetadata;
1275
+ }
1276
+ interface BulkCancelEventResult {
1277
+ /** Metadata of the item, including its ID and success or failure status */
1278
+ itemMetadata?: ItemMetadata;
1279
+ /** ID of the related resource in GUID format */
1280
+ externalEntityId?: string;
1281
+ }
1282
+ interface CancelEventRequest {
1283
+ /**
1284
+ * ID of the related resource in GUID format.
1285
+ * For example, `fc81a355-3429-50fc-a4c7-def486e828f3`.
1286
+ *
1287
+ * Typically, this ID is defined in your system,
1288
+ * but you can also use any Wix resource GUID,
1289
+ * such as contact ID, member ID, or invoice ID.
1290
+ * See
1291
+ * [Choose the right `externalEntityId`](https://dev.wix.com/docs/rest/business-management/automations/triggered-events/reporting-and-canceling-events#choose-the-right-externalentityid)
1292
+ * for more information.
1293
+ */
1294
+ externalEntityId: string;
1295
+ /**
1296
+ * Trigger key whose event you want to cancel.
1297
+ * For example, `form_submitted` or `invoice_due`.
1298
+ */
1299
+ triggerKey: string;
1300
+ }
1301
+ interface CancelEventResponse {
1302
+ }
1303
+ interface V1RunAutomationRequest extends V1RunAutomationRequestIdentifierOneOf {
1304
+ /** a preinstalled automation identifier */
1305
+ preinstalledIdentifier?: PreinstalledIdentifier;
1306
+ /** a automation of any type identifier that will be available in future */
1307
+ automationIdentifier?: AutomationIdentifier;
1308
+ /** identifier MUST be either AUTOMATION or PREINSTALLED */
1309
+ identifierType?: IdentifierType;
1310
+ /**
1311
+ * Event payload, formatted as key:value pairs.
1312
+ * Must comply with the payload schema
1313
+ * if you provided one when configuring your trigger.
1314
+ *
1315
+ * Key names can include only alphanumeric characters or underscores
1316
+ * (`A-Z`, `a-z`, `0-9`, `_`).
1317
+ * They cannot start with an underscore.
1318
+ *
1319
+ * Values can be strings, numbers, integers, booleans, or arrays.
1320
+ * If a value is an array, the array items must be objects,
1321
+ * and nested object properties must be
1322
+ * strings, numbers, integers, or booleans only.
1323
+ */
1324
+ payload?: Record<string, any> | null;
1325
+ }
1326
+ /** @oneof */
1327
+ interface V1RunAutomationRequestIdentifierOneOf {
1328
+ /** a preinstalled automation identifier */
1329
+ preinstalledIdentifier?: PreinstalledIdentifier;
1330
+ /** a automation of any type identifier that will be available in future */
1331
+ automationIdentifier?: AutomationIdentifier;
1332
+ }
1333
+ declare enum IdentifierType {
1334
+ UNKNOWN_IDENTIFIER = "UNKNOWN_IDENTIFIER",
1335
+ PREINSTALLED = "PREINSTALLED",
1336
+ AUTOMATION = "AUTOMATION"
1337
+ }
1338
+ interface PreinstalledIdentifier {
1339
+ /** identifier for the application of the preinstalled */
1340
+ appId?: string;
1341
+ /** application component id */
1342
+ componentId?: string;
1343
+ }
1344
+ interface AutomationIdentifier {
1345
+ /** automation id */
1346
+ automationId?: string;
1347
+ }
1348
+ interface V1RunAutomationResponse {
1349
+ }
1350
+ interface ReportDomainEventRequest {
1351
+ /** trigger app id */
1352
+ triggerAppId?: string;
1353
+ /** report event request */
1354
+ reportEventRequest?: ReportEventRequest;
1355
+ }
1356
+ interface ReportDomainEventResponse {
1357
+ }
1358
+ interface ExecuteFromActionRequest {
1359
+ /** Requested action id */
1360
+ actionId?: string;
1361
+ /** Optional: an activation id to link this action to */
1362
+ activationId?: string | null;
1363
+ /** Activation payload */
1364
+ payload?: Record<string, any> | null;
1365
+ /** Configuration correlation id to run this action from */
1366
+ configurationCorrelationId?: string;
1367
+ /** Optional - schedule id that this action was scheduled from */
1368
+ scheduleId?: string | null;
1369
+ /** Optional - an external entity id that this execution is related to */
1370
+ externalEntityId?: string | null;
1371
+ }
1372
+ interface ExecuteFromActionResponse {
1373
+ }
1374
+ interface ActivationScheduleCompleted {
1375
+ /** Activation identifier */
1376
+ _id?: string;
1377
+ /** Activation schedule identifier */
1378
+ scheduleId?: string;
1379
+ /** Activation schedule due date */
1380
+ scheduleDate?: Date;
1381
+ /** Activation payload */
1382
+ payload?: Record<string, any> | null;
1383
+ /** Activation Automation */
1384
+ automation?: Automation;
1385
+ /** Optional - external entity id that this activation is related to */
1386
+ externalEntityId?: string | null;
1387
+ }
1388
+ interface ReportEventResponseNonNullableFields {
1389
+ activationIds: string[];
1390
+ }
1391
+ interface BulkReportEventResponseNonNullableFields {
1392
+ triggerKey: string;
1393
+ results: {
1394
+ itemMetadata?: {
1395
+ originalIndex: number;
1396
+ success: boolean;
1397
+ error?: {
1398
+ code: string;
1399
+ description: string;
1400
+ };
1401
+ };
1402
+ eventInfo?: {
1403
+ idempotency?: {
1404
+ key: string;
1405
+ };
1406
+ };
1407
+ activationIds: string[];
1408
+ }[];
1409
+ bulkActionMetadata?: {
1410
+ totalSuccesses: number;
1411
+ totalFailures: number;
1412
+ undetailedFailures: number;
1413
+ };
1414
+ }
1415
+ interface BulkCancelEventResponseNonNullableFields {
1416
+ triggerKey: string;
1417
+ results: {
1418
+ itemMetadata?: {
1419
+ originalIndex: number;
1420
+ success: boolean;
1421
+ error?: {
1422
+ code: string;
1423
+ description: string;
1424
+ };
1425
+ };
1426
+ externalEntityId: string;
1427
+ }[];
1428
+ bulkActionMetadata?: {
1429
+ totalSuccesses: number;
1430
+ totalFailures: number;
1431
+ undetailedFailures: number;
1432
+ };
1433
+ }
1434
+ interface BaseEventMetadata {
1435
+ /** App instance ID. */
1436
+ instanceId?: string | null;
1437
+ /** Event type. */
1438
+ eventType?: string;
1439
+ /** The identification type and identity data. */
1440
+ identity?: IdentificationData;
1441
+ }
1442
+ interface EventMetadata extends BaseEventMetadata {
1443
+ /**
1444
+ * Unique event ID.
1445
+ * Allows clients to ignore duplicate webhooks.
1446
+ */
1447
+ _id?: string;
1448
+ /**
1449
+ * Assumes actions are also always typed to an entity_type
1450
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1451
+ */
1452
+ entityFqdn?: string;
1453
+ /**
1454
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1455
+ * This is although the created/updated/deleted notion is duplication of the oneof types
1456
+ * Example: created/updated/deleted/started/completed/email_opened
1457
+ */
1458
+ slug?: string;
1459
+ /** ID of the entity associated with the event. */
1460
+ entityId?: string;
1461
+ /** Event timestamp. */
1462
+ eventTime?: Date;
1463
+ /**
1464
+ * Whether the event was triggered as a result of a privacy regulation application
1465
+ * (for example, GDPR).
1466
+ */
1467
+ triggeredByAnonymizeRequest?: boolean | null;
1468
+ /** If present, indicates the action that triggered the event. */
1469
+ originatedFrom?: string | null;
1470
+ /**
1471
+ * A sequence number defining the order of updates to the underlying entity.
1472
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
1473
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1474
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1475
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
1476
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1477
+ */
1478
+ entityEventSequence?: string | null;
1479
+ }
1480
+ interface ActivationStatusChangedEnvelope {
1481
+ data: ActivationStatusChanged;
1482
+ metadata: EventMetadata;
1483
+ }
1484
+ interface ReportEventOptions {
1485
+ /**
1486
+ * Event payload, formatted as key:value pairs.
1487
+ * Must comply with the payload schema
1488
+ * if you provided one when configuring your trigger.
1489
+ *
1490
+ * Key names can include only alphanumeric characters or underscores
1491
+ * (`A-Z`, `a-z`, `0-9`, `_`).
1492
+ * They cannot start with an underscore.
1493
+ *
1494
+ * Values can be strings, numbers, integers, booleans, or arrays.
1495
+ * If a value is an array, the array items must be objects,
1496
+ * and nested object properties must be
1497
+ * strings, numbers, integers, or booleans only.
1498
+ */
1499
+ payload?: Record<string, any> | null;
1500
+ /**
1501
+ * ID of the related resource in GUID format.
1502
+ * For example, `fc81a355-3429-50fc-a4c7-def486e828f3`.
1503
+ *
1504
+ * Required if your app needs to
1505
+ * [cancel the event](https://dev.wix.com/docs/rest/business-management/automations/triggered-events/cancel-event)
1506
+ * if the automation becomes no longer relevant.
1507
+ *
1508
+ * Typically, this ID is defined in your system,
1509
+ * but you can also use any Wix resource GUID,
1510
+ * such as contact ID, member ID, or invoice ID.
1511
+ * See
1512
+ * [Choose the right `externalEntityId`](https://dev.wix.com/docs/rest/business-management/automations/triggered-events/reporting-and-canceling-events#about-canceling-events)
1513
+ * for more information.
1514
+ */
1515
+ externalEntityId?: string | null;
1516
+ /** Idempotency information for the event */
1517
+ idempotency?: Idempotency;
1518
+ }
1519
+ interface BulkReportEventOptions {
1520
+ /** Repeated list of event details for bulk reporting */
1521
+ eventsInfo: EventInfo[];
1522
+ }
1523
+ interface BulkCancelEventOptions {
1524
+ /** Repeated list of external_entity_id, representing the related resources' IDs */
1525
+ externalEntityIds: string[];
1526
+ }
1527
+ interface CancelEventOptions {
1528
+ /**
1529
+ * Trigger key whose event you want to cancel.
1530
+ * For example, `form_submitted` or `invoice_due`.
1531
+ */
1532
+ triggerKey: string;
1533
+ }
1534
+
1535
+ interface HttpClient {
1536
+ request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
1537
+ }
1538
+ type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
1539
+ type HttpResponse<T = any> = {
1540
+ data: T;
1541
+ status: number;
1542
+ statusText: string;
1543
+ headers: any;
1544
+ request?: any;
1545
+ };
1546
+ type RequestOptions<_TResponse = any, Data = any> = {
1547
+ method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
1548
+ url: string;
1549
+ data?: Data;
1550
+ params?: URLSearchParams;
1551
+ } & APIMetadata;
1552
+ type APIMetadata = {
1553
+ methodFqn?: string;
1554
+ entityFqdn?: string;
1555
+ packageName?: string;
1556
+ };
1557
+ type EventDefinition<Payload = unknown, Type extends string = string> = {
1558
+ __type: 'event-definition';
1559
+ type: Type;
1560
+ isDomainEvent?: boolean;
1561
+ transformations?: unknown;
1562
+ __payload: Payload;
1563
+ };
1564
+ declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, _transformations?: unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
1565
+
1566
+ declare const __metadata: {
1567
+ PACKAGE_NAME: string;
1568
+ };
1569
+ declare function reportEvent(httpClient: HttpClient): (triggerKey: string, options?: ReportEventOptions) => Promise<ReportEventResponse & ReportEventResponseNonNullableFields>;
1570
+ declare function bulkReportEvent(httpClient: HttpClient): (triggerKey: string, options: BulkReportEventOptions) => Promise<BulkReportEventResponse & BulkReportEventResponseNonNullableFields>;
1571
+ declare function bulkCancelEvent(httpClient: HttpClient): (triggerKey: string, options: BulkCancelEventOptions) => Promise<BulkCancelEventResponse & BulkCancelEventResponseNonNullableFields>;
1572
+ declare function cancelEvent(httpClient: HttpClient): (externalEntityId: string, options: CancelEventOptions) => Promise<void>;
1573
+ declare const onActivationStatusChanged: EventDefinition<ActivationStatusChangedEnvelope, "wix.automations.v2.activation_activation_status_changed">;
1574
+
1575
+ type index_d_Action = Action;
1576
+ type index_d_ActionActionOneOf = ActionActionOneOf;
1577
+ type index_d_ActionCompletedRequest = ActionCompletedRequest;
1578
+ type index_d_ActionData = ActionData;
1579
+ type index_d_ActionEvent = ActionEvent;
1580
+ type index_d_ActionSettings = ActionSettings;
1581
+ type index_d_ActionStatus = ActionStatus;
1582
+ type index_d_ActionsData = ActionsData;
1583
+ type index_d_Activation = Activation;
1584
+ type index_d_ActivationActionStatusChanged = ActivationActionStatusChanged;
1585
+ type index_d_ActivationActionStatusChangedStatus = ActivationActionStatusChangedStatus;
1586
+ declare const index_d_ActivationActionStatusChangedStatus: typeof ActivationActionStatusChangedStatus;
1587
+ type index_d_ActivationActionStatusChangedStatusInfoOneOf = ActivationActionStatusChangedStatusInfoOneOf;
1588
+ type index_d_ActivationContinuedAfterSchedule = ActivationContinuedAfterSchedule;
1589
+ type index_d_ActivationRequest = ActivationRequest;
1590
+ type index_d_ActivationResumeAfterDelay = ActivationResumeAfterDelay;
1591
+ type index_d_ActivationScheduleCompleted = ActivationScheduleCompleted;
1592
+ type index_d_ActivationScheduleRequested = ActivationScheduleRequested;
1593
+ type index_d_ActivationSource = ActivationSource;
1594
+ type index_d_ActivationSourceOfOneOf = ActivationSourceOfOneOf;
1595
+ type index_d_ActivationStatus = ActivationStatus;
1596
+ type index_d_ActivationStatusChanged = ActivationStatusChanged;
1597
+ type index_d_ActivationStatusChangedEnvelope = ActivationStatusChangedEnvelope;
1598
+ type index_d_ActivationStatusChangedFailedStatusInfo = ActivationStatusChangedFailedStatusInfo;
1599
+ type index_d_ActivationStatusChangedStatus = ActivationStatusChangedStatus;
1600
+ declare const index_d_ActivationStatusChangedStatus: typeof ActivationStatusChangedStatus;
1601
+ type index_d_ActivationStatusChangedStatusInfoOneOf = ActivationStatusChangedStatusInfoOneOf;
1602
+ type index_d_AppDefinedAction = AppDefinedAction;
1603
+ type index_d_AppDefinedActionInfo = AppDefinedActionInfo;
1604
+ type index_d_ApplicationError = ApplicationError;
1605
+ type index_d_ApplicationOrigin = ApplicationOrigin;
1606
+ type index_d_AsyncAction = AsyncAction;
1607
+ type index_d_AuditInfo = AuditInfo;
1608
+ type index_d_AuditInfoIdOneOf = AuditInfoIdOneOf;
1609
+ type index_d_Automation = Automation;
1610
+ type index_d_AutomationConfiguration = AutomationConfiguration;
1611
+ type index_d_AutomationConfigurationAction = AutomationConfigurationAction;
1612
+ type index_d_AutomationConfigurationActionInfoOneOf = AutomationConfigurationActionInfoOneOf;
1613
+ type index_d_AutomationConfigurationStatus = AutomationConfigurationStatus;
1614
+ declare const index_d_AutomationConfigurationStatus: typeof AutomationConfigurationStatus;
1615
+ type index_d_AutomationIdentifier = AutomationIdentifier;
1616
+ type index_d_AutomationInfo = AutomationInfo;
1617
+ type index_d_AutomationInfoOriginInfoOneOf = AutomationInfoOriginInfoOneOf;
1618
+ type index_d_AutomationOriginInfoOneOf = AutomationOriginInfoOneOf;
1619
+ type index_d_AutomationSettings = AutomationSettings;
1620
+ type index_d_BaseEventMetadata = BaseEventMetadata;
1621
+ type index_d_BatchActivationRequest = BatchActivationRequest;
1622
+ type index_d_BlockType = BlockType;
1623
+ declare const index_d_BlockType: typeof BlockType;
1624
+ type index_d_BulkActionMetadata = BulkActionMetadata;
1625
+ type index_d_BulkCancelEventOptions = BulkCancelEventOptions;
1626
+ type index_d_BulkCancelEventRequest = BulkCancelEventRequest;
1627
+ type index_d_BulkCancelEventResponse = BulkCancelEventResponse;
1628
+ type index_d_BulkCancelEventResponseNonNullableFields = BulkCancelEventResponseNonNullableFields;
1629
+ type index_d_BulkCancelEventResult = BulkCancelEventResult;
1630
+ type index_d_BulkReportEventOptions = BulkReportEventOptions;
1631
+ type index_d_BulkReportEventRequest = BulkReportEventRequest;
1632
+ type index_d_BulkReportEventResponse = BulkReportEventResponse;
1633
+ type index_d_BulkReportEventResponseNonNullableFields = BulkReportEventResponseNonNullableFields;
1634
+ type index_d_BulkReportEventResult = BulkReportEventResult;
1635
+ type index_d_CancelEventOptions = CancelEventOptions;
1636
+ type index_d_CancelEventRequest = CancelEventRequest;
1637
+ type index_d_CancelEventResponse = CancelEventResponse;
1638
+ type index_d_CancelPendingScheduleRequest = CancelPendingScheduleRequest;
1639
+ type index_d_CancelPendingScheduleRequestByOneOf = CancelPendingScheduleRequestByOneOf;
1640
+ type index_d_CancelPendingScheduleResponse = CancelPendingScheduleResponse;
1641
+ type index_d_CancellationReason = CancellationReason;
1642
+ declare const index_d_CancellationReason: typeof CancellationReason;
1643
+ type index_d_CancelledStatusInfo = CancelledStatusInfo;
1644
+ type index_d_Case = Case;
1645
+ type index_d_ConditionAction = ConditionAction;
1646
+ type index_d_ConditionActionInfo = ConditionActionInfo;
1647
+ type index_d_ConditionBlock = ConditionBlock;
1648
+ type index_d_ConditionExpressionGroup = ConditionExpressionGroup;
1649
+ type index_d_ConditionFilter = ConditionFilter;
1650
+ type index_d_Delay = Delay;
1651
+ type index_d_DelayAction = DelayAction;
1652
+ type index_d_DelayActionInfo = DelayActionInfo;
1653
+ type index_d_DelayHelper = DelayHelper;
1654
+ type index_d_DelayOfOneOf = DelayOfOneOf;
1655
+ type index_d_DomainEvent = DomainEvent;
1656
+ type index_d_DomainEventBodyOneOf = DomainEventBodyOneOf;
1657
+ type index_d_Empty = Empty;
1658
+ type index_d_EndedStatusInfo = EndedStatusInfo;
1659
+ type index_d_EndedStatusInfoTypeInfoOneOf = EndedStatusInfoTypeInfoOneOf;
1660
+ type index_d_EntityCreatedEvent = EntityCreatedEvent;
1661
+ type index_d_EntityDeletedEvent = EntityDeletedEvent;
1662
+ type index_d_EntityUpdatedEvent = EntityUpdatedEvent;
1663
+ type index_d_EventInfo = EventInfo;
1664
+ type index_d_EventMetadata = EventMetadata;
1665
+ type index_d_ExecuteFromActionRequest = ExecuteFromActionRequest;
1666
+ type index_d_ExecuteFromActionResponse = ExecuteFromActionResponse;
1667
+ type index_d_ExpressionEvaluationResult = ExpressionEvaluationResult;
1668
+ type index_d_FailedStatusInfo = FailedStatusInfo;
1669
+ type index_d_Filter = Filter;
1670
+ type index_d_FutureDateActivationOffset = FutureDateActivationOffset;
1671
+ type index_d_Idempotency = Idempotency;
1672
+ type index_d_IdentificationData = IdentificationData;
1673
+ type index_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
1674
+ type index_d_IdentifierType = IdentifierType;
1675
+ declare const index_d_IdentifierType: typeof IdentifierType;
1676
+ type index_d_Identity = Identity;
1677
+ type index_d_IfFilter = IfFilter;
1678
+ type index_d_InitiatedStatusInfo = InitiatedStatusInfo;
1679
+ type index_d_ItemMetadata = ItemMetadata;
1680
+ type index_d_MessageEnvelope = MessageEnvelope;
1681
+ type index_d_Operator = Operator;
1682
+ declare const index_d_Operator: typeof Operator;
1683
+ type index_d_Origin = Origin;
1684
+ declare const index_d_Origin: typeof Origin;
1685
+ type index_d_Output = Output;
1686
+ type index_d_OutputAction = OutputAction;
1687
+ type index_d_PreinstalledIdentifier = PreinstalledIdentifier;
1688
+ type index_d_PreinstalledOrigin = PreinstalledOrigin;
1689
+ type index_d_RateLimitAction = RateLimitAction;
1690
+ type index_d_RateLimitActionInfo = RateLimitActionInfo;
1691
+ type index_d_RateLimiting = RateLimiting;
1692
+ type index_d_RefreshPayloadRequest = RefreshPayloadRequest;
1693
+ type index_d_RefreshPayloadResponse = RefreshPayloadResponse;
1694
+ type index_d_ReportDomainEventRequest = ReportDomainEventRequest;
1695
+ type index_d_ReportDomainEventResponse = ReportDomainEventResponse;
1696
+ type index_d_ReportEventOptions = ReportEventOptions;
1697
+ type index_d_ReportEventRequest = ReportEventRequest;
1698
+ type index_d_ReportEventResponse = ReportEventResponse;
1699
+ type index_d_ReportEventResponseNonNullableFields = ReportEventResponseNonNullableFields;
1700
+ type index_d_RunAutomationRequest = RunAutomationRequest;
1701
+ type index_d_RunAutomationResponse = RunAutomationResponse;
1702
+ type index_d_Runtime = Runtime;
1703
+ type index_d_Schedule = Schedule;
1704
+ type index_d_ScheduleRequest = ScheduleRequest;
1705
+ type index_d_ScheduleResponse = ScheduleResponse;
1706
+ type index_d_ScheduleStatus = ScheduleStatus;
1707
+ declare const index_d_ScheduleStatus: typeof ScheduleStatus;
1708
+ type index_d_ScheduledAction = ScheduledAction;
1709
+ type index_d_ScheduledStatusInfo = ScheduledStatusInfo;
1710
+ type index_d_Scheduler = Scheduler;
1711
+ type index_d_Service = Service;
1712
+ type index_d_ServiceMapping = ServiceMapping;
1713
+ type index_d_SimpleDelay = SimpleDelay;
1714
+ type index_d_SpiAction = SpiAction;
1715
+ type index_d_StartedStatusInfo = StartedStatusInfo;
1716
+ type index_d_StartedStatusInfoAppDefinedActionInfo = StartedStatusInfoAppDefinedActionInfo;
1717
+ type index_d_StartedStatusInfoTypeInfoOneOf = StartedStatusInfoTypeInfoOneOf;
1718
+ type index_d_Status = Status;
1719
+ declare const index_d_Status: typeof Status;
1720
+ type index_d_SwitchFilter = SwitchFilter;
1721
+ type index_d_SystemHelper = SystemHelper;
1722
+ type index_d_SystemHelperHelperOneOf = SystemHelperHelperOneOf;
1723
+ type index_d_Target = Target;
1724
+ declare const index_d_Target: typeof Target;
1725
+ type index_d_TimeUnit = TimeUnit;
1726
+ declare const index_d_TimeUnit: typeof TimeUnit;
1727
+ type index_d_Trigger = Trigger;
1728
+ type index_d_TriggerInfo = TriggerInfo;
1729
+ type index_d_Type = Type;
1730
+ declare const index_d_Type: typeof Type;
1731
+ type index_d_Units = Units;
1732
+ declare const index_d_Units: typeof Units;
1733
+ type index_d_UpdatePendingSchedulesPayloadRequest = UpdatePendingSchedulesPayloadRequest;
1734
+ type index_d_UpdatePendingSchedulesPayloadResponse = UpdatePendingSchedulesPayloadResponse;
1735
+ type index_d_V1RunAutomationRequest = V1RunAutomationRequest;
1736
+ type index_d_V1RunAutomationRequestIdentifierOneOf = V1RunAutomationRequestIdentifierOneOf;
1737
+ type index_d_V1RunAutomationResponse = V1RunAutomationResponse;
1738
+ type index_d_WebhookIdentityType = WebhookIdentityType;
1739
+ declare const index_d_WebhookIdentityType: typeof WebhookIdentityType;
1740
+ declare const index_d___metadata: typeof __metadata;
1741
+ declare const index_d_bulkCancelEvent: typeof bulkCancelEvent;
1742
+ declare const index_d_bulkReportEvent: typeof bulkReportEvent;
1743
+ declare const index_d_cancelEvent: typeof cancelEvent;
1744
+ declare const index_d_onActivationStatusChanged: typeof onActivationStatusChanged;
1745
+ declare const index_d_reportEvent: typeof reportEvent;
1746
+ declare namespace index_d {
1747
+ export { type index_d_Action as Action, type index_d_ActionActionOneOf as ActionActionOneOf, type index_d_ActionCompletedRequest as ActionCompletedRequest, type index_d_ActionData as ActionData, type index_d_ActionEvent as ActionEvent, type index_d_ActionSettings as ActionSettings, type index_d_ActionStatus as ActionStatus, type index_d_ActionsData as ActionsData, type index_d_Activation as Activation, type index_d_ActivationActionStatusChanged as ActivationActionStatusChanged, index_d_ActivationActionStatusChangedStatus as ActivationActionStatusChangedStatus, type index_d_ActivationActionStatusChangedStatusInfoOneOf as ActivationActionStatusChangedStatusInfoOneOf, type index_d_ActivationContinuedAfterSchedule as ActivationContinuedAfterSchedule, type index_d_ActivationRequest as ActivationRequest, type index_d_ActivationResumeAfterDelay as ActivationResumeAfterDelay, type index_d_ActivationScheduleCompleted as ActivationScheduleCompleted, type index_d_ActivationScheduleRequested as ActivationScheduleRequested, type index_d_ActivationSource as ActivationSource, type index_d_ActivationSourceOfOneOf as ActivationSourceOfOneOf, type index_d_ActivationStatus as ActivationStatus, type index_d_ActivationStatusChanged as ActivationStatusChanged, type index_d_ActivationStatusChangedEnvelope as ActivationStatusChangedEnvelope, type index_d_ActivationStatusChangedFailedStatusInfo as ActivationStatusChangedFailedStatusInfo, index_d_ActivationStatusChangedStatus as ActivationStatusChangedStatus, type index_d_ActivationStatusChangedStatusInfoOneOf as ActivationStatusChangedStatusInfoOneOf, type index_d_AppDefinedAction as AppDefinedAction, type index_d_AppDefinedActionInfo as AppDefinedActionInfo, type index_d_ApplicationError as ApplicationError, type index_d_ApplicationOrigin as ApplicationOrigin, type index_d_AsyncAction as AsyncAction, type index_d_AuditInfo as AuditInfo, type index_d_AuditInfoIdOneOf as AuditInfoIdOneOf, type index_d_Automation as Automation, type index_d_AutomationConfiguration as AutomationConfiguration, type index_d_AutomationConfigurationAction as AutomationConfigurationAction, type index_d_AutomationConfigurationActionInfoOneOf as AutomationConfigurationActionInfoOneOf, index_d_AutomationConfigurationStatus as AutomationConfigurationStatus, type index_d_AutomationIdentifier as AutomationIdentifier, type index_d_AutomationInfo as AutomationInfo, type index_d_AutomationInfoOriginInfoOneOf as AutomationInfoOriginInfoOneOf, type index_d_AutomationOriginInfoOneOf as AutomationOriginInfoOneOf, type index_d_AutomationSettings as AutomationSettings, type index_d_BaseEventMetadata as BaseEventMetadata, type index_d_BatchActivationRequest as BatchActivationRequest, index_d_BlockType as BlockType, type index_d_BulkActionMetadata as BulkActionMetadata, type index_d_BulkCancelEventOptions as BulkCancelEventOptions, type index_d_BulkCancelEventRequest as BulkCancelEventRequest, type index_d_BulkCancelEventResponse as BulkCancelEventResponse, type index_d_BulkCancelEventResponseNonNullableFields as BulkCancelEventResponseNonNullableFields, type index_d_BulkCancelEventResult as BulkCancelEventResult, type index_d_BulkReportEventOptions as BulkReportEventOptions, type index_d_BulkReportEventRequest as BulkReportEventRequest, type index_d_BulkReportEventResponse as BulkReportEventResponse, type index_d_BulkReportEventResponseNonNullableFields as BulkReportEventResponseNonNullableFields, type index_d_BulkReportEventResult as BulkReportEventResult, type index_d_CancelEventOptions as CancelEventOptions, type index_d_CancelEventRequest as CancelEventRequest, type index_d_CancelEventResponse as CancelEventResponse, type index_d_CancelPendingScheduleRequest as CancelPendingScheduleRequest, type index_d_CancelPendingScheduleRequestByOneOf as CancelPendingScheduleRequestByOneOf, type index_d_CancelPendingScheduleResponse as CancelPendingScheduleResponse, index_d_CancellationReason as CancellationReason, type index_d_CancelledStatusInfo as CancelledStatusInfo, type index_d_Case as Case, type index_d_ConditionAction as ConditionAction, type index_d_ConditionActionInfo as ConditionActionInfo, type index_d_ConditionBlock as ConditionBlock, type index_d_ConditionExpressionGroup as ConditionExpressionGroup, type index_d_ConditionFilter as ConditionFilter, type index_d_Delay as Delay, type index_d_DelayAction as DelayAction, type index_d_DelayActionInfo as DelayActionInfo, type index_d_DelayHelper as DelayHelper, type index_d_DelayOfOneOf as DelayOfOneOf, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_Empty as Empty, type index_d_EndedStatusInfo as EndedStatusInfo, type index_d_EndedStatusInfoTypeInfoOneOf as EndedStatusInfoTypeInfoOneOf, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_EventInfo as EventInfo, type index_d_EventMetadata as EventMetadata, type index_d_ExecuteFromActionRequest as ExecuteFromActionRequest, type index_d_ExecuteFromActionResponse as ExecuteFromActionResponse, type index_d_ExpressionEvaluationResult as ExpressionEvaluationResult, type index_d_FailedStatusInfo as FailedStatusInfo, type index_d_Filter as Filter, type index_d_FutureDateActivationOffset as FutureDateActivationOffset, type index_d_Idempotency as Idempotency, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, index_d_IdentifierType as IdentifierType, type index_d_Identity as Identity, type index_d_IfFilter as IfFilter, type index_d_InitiatedStatusInfo as InitiatedStatusInfo, type index_d_ItemMetadata as ItemMetadata, type index_d_MessageEnvelope as MessageEnvelope, index_d_Operator as Operator, index_d_Origin as Origin, type index_d_Output as Output, type index_d_OutputAction as OutputAction, type index_d_PreinstalledIdentifier as PreinstalledIdentifier, type index_d_PreinstalledOrigin as PreinstalledOrigin, type index_d_RateLimitAction as RateLimitAction, type index_d_RateLimitActionInfo as RateLimitActionInfo, type index_d_RateLimiting as RateLimiting, type index_d_RefreshPayloadRequest as RefreshPayloadRequest, type index_d_RefreshPayloadResponse as RefreshPayloadResponse, type index_d_ReportDomainEventRequest as ReportDomainEventRequest, type index_d_ReportDomainEventResponse as ReportDomainEventResponse, type index_d_ReportEventOptions as ReportEventOptions, type index_d_ReportEventRequest as ReportEventRequest, type index_d_ReportEventResponse as ReportEventResponse, type index_d_ReportEventResponseNonNullableFields as ReportEventResponseNonNullableFields, type index_d_RunAutomationRequest as RunAutomationRequest, type index_d_RunAutomationResponse as RunAutomationResponse, type index_d_Runtime as Runtime, type index_d_Schedule as Schedule, type index_d_ScheduleRequest as ScheduleRequest, type index_d_ScheduleResponse as ScheduleResponse, index_d_ScheduleStatus as ScheduleStatus, type index_d_ScheduledAction as ScheduledAction, type index_d_ScheduledStatusInfo as ScheduledStatusInfo, type index_d_Scheduler as Scheduler, type index_d_Service as Service, type index_d_ServiceMapping as ServiceMapping, type index_d_SimpleDelay as SimpleDelay, type index_d_SpiAction as SpiAction, type index_d_StartedStatusInfo as StartedStatusInfo, type index_d_StartedStatusInfoAppDefinedActionInfo as StartedStatusInfoAppDefinedActionInfo, type index_d_StartedStatusInfoTypeInfoOneOf as StartedStatusInfoTypeInfoOneOf, index_d_Status as Status, type index_d_SwitchFilter as SwitchFilter, type index_d_SystemHelper as SystemHelper, type index_d_SystemHelperHelperOneOf as SystemHelperHelperOneOf, index_d_Target as Target, index_d_TimeUnit as TimeUnit, type index_d_Trigger as Trigger, type index_d_TriggerInfo as TriggerInfo, index_d_Type as Type, index_d_Units as Units, type index_d_UpdatePendingSchedulesPayloadRequest as UpdatePendingSchedulesPayloadRequest, type index_d_UpdatePendingSchedulesPayloadResponse as UpdatePendingSchedulesPayloadResponse, type index_d_V1RunAutomationRequest as V1RunAutomationRequest, type index_d_V1RunAutomationRequestIdentifierOneOf as V1RunAutomationRequestIdentifierOneOf, type index_d_V1RunAutomationResponse as V1RunAutomationResponse, index_d_WebhookIdentityType as WebhookIdentityType, index_d___metadata as __metadata, index_d_bulkCancelEvent as bulkCancelEvent, index_d_bulkReportEvent as bulkReportEvent, index_d_cancelEvent as cancelEvent, index_d_onActivationStatusChanged as onActivationStatusChanged, index_d_reportEvent as reportEvent };
1748
+ }
1749
+
1750
+ export { index_d as activations };