@wix/auto_sdk_automations_activations 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.
Files changed (111) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/automations-v2-activation-activations.context.d.ts +14 -0
  11. package/build/cjs/src/automations-v2-activation-activations.context.js +35 -0
  12. package/build/cjs/src/automations-v2-activation-activations.context.js.map +1 -0
  13. package/build/cjs/src/automations-v2-activation-activations.http.d.ts +31 -0
  14. package/build/cjs/src/automations-v2-activation-activations.http.js +143 -0
  15. package/build/cjs/src/automations-v2-activation-activations.http.js.map +1 -0
  16. package/build/cjs/src/automations-v2-activation-activations.meta.d.ts +16 -0
  17. package/build/cjs/src/automations-v2-activation-activations.meta.js +104 -0
  18. package/build/cjs/src/automations-v2-activation-activations.meta.js.map +1 -0
  19. package/build/cjs/src/automations-v2-activation-activations.public.d.ts +74 -0
  20. package/build/cjs/src/automations-v2-activation-activations.public.js +66 -0
  21. package/build/cjs/src/automations-v2-activation-activations.public.js.map +1 -0
  22. package/build/cjs/src/automations-v2-activation-activations.types.d.ts +1592 -0
  23. package/build/cjs/src/automations-v2-activation-activations.types.js +195 -0
  24. package/build/cjs/src/automations-v2-activation-activations.types.js.map +1 -0
  25. package/build/cjs/src/automations-v2-activation-activations.universal.d.ts +1775 -0
  26. package/build/cjs/src/automations-v2-activation-activations.universal.js +423 -0
  27. package/build/cjs/src/automations-v2-activation-activations.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/automations-v2-activation-activations.context.d.ts +14 -0
  39. package/build/es/src/automations-v2-activation-activations.context.js +14 -0
  40. package/build/es/src/automations-v2-activation-activations.context.js.map +1 -0
  41. package/build/es/src/automations-v2-activation-activations.http.d.ts +31 -0
  42. package/build/es/src/automations-v2-activation-activations.http.js +136 -0
  43. package/build/es/src/automations-v2-activation-activations.http.js.map +1 -0
  44. package/build/es/src/automations-v2-activation-activations.meta.d.ts +16 -0
  45. package/build/es/src/automations-v2-activation-activations.meta.js +74 -0
  46. package/build/es/src/automations-v2-activation-activations.meta.js.map +1 -0
  47. package/build/es/src/automations-v2-activation-activations.public.d.ts +74 -0
  48. package/build/es/src/automations-v2-activation-activations.public.js +41 -0
  49. package/build/es/src/automations-v2-activation-activations.public.js.map +1 -0
  50. package/build/es/src/automations-v2-activation-activations.types.d.ts +1592 -0
  51. package/build/es/src/automations-v2-activation-activations.types.js +192 -0
  52. package/build/es/src/automations-v2-activation-activations.types.js.map +1 -0
  53. package/build/es/src/automations-v2-activation-activations.universal.d.ts +1775 -0
  54. package/build/es/src/automations-v2-activation-activations.universal.js +393 -0
  55. package/build/es/src/automations-v2-activation-activations.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/automations-v2-activation-activations.context.d.ts +14 -0
  66. package/build/internal/cjs/src/automations-v2-activation-activations.context.js +35 -0
  67. package/build/internal/cjs/src/automations-v2-activation-activations.context.js.map +1 -0
  68. package/build/internal/cjs/src/automations-v2-activation-activations.http.d.ts +31 -0
  69. package/build/internal/cjs/src/automations-v2-activation-activations.http.js +143 -0
  70. package/build/internal/cjs/src/automations-v2-activation-activations.http.js.map +1 -0
  71. package/build/internal/cjs/src/automations-v2-activation-activations.meta.d.ts +16 -0
  72. package/build/internal/cjs/src/automations-v2-activation-activations.meta.js +104 -0
  73. package/build/internal/cjs/src/automations-v2-activation-activations.meta.js.map +1 -0
  74. package/build/internal/cjs/src/automations-v2-activation-activations.public.d.ts +74 -0
  75. package/build/internal/cjs/src/automations-v2-activation-activations.public.js +66 -0
  76. package/build/internal/cjs/src/automations-v2-activation-activations.public.js.map +1 -0
  77. package/build/internal/cjs/src/automations-v2-activation-activations.types.d.ts +1592 -0
  78. package/build/internal/cjs/src/automations-v2-activation-activations.types.js +195 -0
  79. package/build/internal/cjs/src/automations-v2-activation-activations.types.js.map +1 -0
  80. package/build/internal/cjs/src/automations-v2-activation-activations.universal.d.ts +1775 -0
  81. package/build/internal/cjs/src/automations-v2-activation-activations.universal.js +423 -0
  82. package/build/internal/cjs/src/automations-v2-activation-activations.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/automations-v2-activation-activations.context.d.ts +14 -0
  93. package/build/internal/es/src/automations-v2-activation-activations.context.js +14 -0
  94. package/build/internal/es/src/automations-v2-activation-activations.context.js.map +1 -0
  95. package/build/internal/es/src/automations-v2-activation-activations.http.d.ts +31 -0
  96. package/build/internal/es/src/automations-v2-activation-activations.http.js +136 -0
  97. package/build/internal/es/src/automations-v2-activation-activations.http.js.map +1 -0
  98. package/build/internal/es/src/automations-v2-activation-activations.meta.d.ts +16 -0
  99. package/build/internal/es/src/automations-v2-activation-activations.meta.js +74 -0
  100. package/build/internal/es/src/automations-v2-activation-activations.meta.js.map +1 -0
  101. package/build/internal/es/src/automations-v2-activation-activations.public.d.ts +74 -0
  102. package/build/internal/es/src/automations-v2-activation-activations.public.js +41 -0
  103. package/build/internal/es/src/automations-v2-activation-activations.public.js.map +1 -0
  104. package/build/internal/es/src/automations-v2-activation-activations.types.d.ts +1592 -0
  105. package/build/internal/es/src/automations-v2-activation-activations.types.js +192 -0
  106. package/build/internal/es/src/automations-v2-activation-activations.types.js.map +1 -0
  107. package/build/internal/es/src/automations-v2-activation-activations.universal.d.ts +1775 -0
  108. package/build/internal/es/src/automations-v2-activation-activations.universal.js +393 -0
  109. package/build/internal/es/src/automations-v2-activation-activations.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -0,0 +1,1592 @@
1
+ export interface Activation {
2
+ /** Activation ID */
3
+ id?: string;
4
+ /** Activation automation */
5
+ automation?: Automation;
6
+ }
7
+ export interface Automation extends AutomationOriginInfoOneOf {
8
+ /** Application info */
9
+ applicationInfo?: ApplicationOrigin;
10
+ /** Preinstalled info */
11
+ preinstalledInfo?: PreinstalledOrigin;
12
+ /**
13
+ * Automation ID.
14
+ * @readonly
15
+ */
16
+ id?: string | null;
17
+ /**
18
+ * Revision number, which increments by 1 each time the automation is updated.
19
+ * To prevent conflicting changes,
20
+ * the current revision must be passed when updating the automation.
21
+ *
22
+ * Ignored when creating an automation.
23
+ * @readonly
24
+ */
25
+ revision?: string | null;
26
+ /**
27
+ * Information about the creator of the automation.
28
+ * @readonly
29
+ */
30
+ createdBy?: AuditInfo;
31
+ /**
32
+ * Date and time the automation was created.
33
+ * @readonly
34
+ */
35
+ createdDate?: Date | null;
36
+ /**
37
+ * The entity that last updated the automation.
38
+ * @readonly
39
+ */
40
+ updatedBy?: AuditInfo;
41
+ /**
42
+ * Date and time the automation was last updated.
43
+ * @readonly
44
+ */
45
+ updatedDate?: Date | null;
46
+ /** Automation name that is displayed on the user's site. */
47
+ name?: string;
48
+ /** Automation description. */
49
+ description?: string | null;
50
+ /** Object that defines the automation's trigger, actions, and activation status. */
51
+ configuration?: AutomationConfiguration;
52
+ /** Defines how the automation was added to the site. */
53
+ origin?: Origin;
54
+ /** Automation settings. */
55
+ settings?: AutomationSettings;
56
+ /**
57
+ * Draft info (optional - only if the automation is a draft)
58
+ * @readonly
59
+ */
60
+ draftInfo?: DraftInfo;
61
+ /** Namespace */
62
+ namespace?: string | null;
63
+ /** Extended Fields */
64
+ extendedFields?: ExtendedFields;
65
+ }
66
+ /** @oneof */
67
+ export interface AutomationOriginInfoOneOf {
68
+ /** Application info */
69
+ applicationInfo?: ApplicationOrigin;
70
+ /** Preinstalled info */
71
+ preinstalledInfo?: PreinstalledOrigin;
72
+ }
73
+ export interface ActionSettings {
74
+ /**
75
+ * List of actions that cannot be deleted.
76
+ * Default: Empty. All actions are deletable by default.
77
+ */
78
+ permanentActionIds?: string[];
79
+ /**
80
+ * List of actions that cannot be edited.
81
+ * Default: Empty. All actions are editable by default.
82
+ */
83
+ readonlyActionIds?: string[];
84
+ /** Whether the option to add a delay is disabled for the automation. */
85
+ disableDelayAddition?: boolean;
86
+ /** Whether the option to add a condition is disabled for the automation. */
87
+ disableConditionAddition?: boolean;
88
+ }
89
+ export declare enum Domain {
90
+ /** User domain (default). */
91
+ USER = "USER",
92
+ /** Wix domain. */
93
+ WIX = "WIX"
94
+ }
95
+ export interface Enrichment {
96
+ /** Enrichment input mappings. */
97
+ inputMappings?: Record<string, any>[] | null;
98
+ }
99
+ export interface AuditInfo extends AuditInfoIdOneOf {
100
+ /** User ID. */
101
+ userId?: string;
102
+ /** Application ID. */
103
+ appId?: string;
104
+ }
105
+ /** @oneof */
106
+ export interface AuditInfoIdOneOf {
107
+ /** User ID. */
108
+ userId?: string;
109
+ /** Application ID. */
110
+ appId?: string;
111
+ }
112
+ /** Automation runtime configuration */
113
+ export interface AutomationConfiguration {
114
+ /** Status of the automation on the site. */
115
+ status?: AutomationConfigurationStatus;
116
+ /** Automation trigger configuration. */
117
+ trigger?: Trigger;
118
+ /** List of IDs of root actions. Root actions are the first actions to run after the trigger. The actions in the list run in parallel. */
119
+ rootActionIds?: string[];
120
+ /**
121
+ * Map of all actions that the automation may execute.
122
+ * The key is the action ID, and the value is the action configuration.
123
+ */
124
+ actions?: Record<string, AutomationConfigurationAction>;
125
+ }
126
+ export declare enum TimeUnit {
127
+ UNKNOWN_TIME_UNIT = "UNKNOWN_TIME_UNIT",
128
+ MINUTES = "MINUTES",
129
+ HOURS = "HOURS",
130
+ DAYS = "DAYS",
131
+ WEEKS = "WEEKS",
132
+ MONTHS = "MONTHS"
133
+ }
134
+ export interface Filter {
135
+ /** Filter ID. */
136
+ id?: string;
137
+ /** Field key from the payload schema, for example "formId". */
138
+ fieldKey?: string;
139
+ /** Filter expression that evaluates to a boolean. */
140
+ filterExpression?: string;
141
+ }
142
+ export interface FutureDateActivationOffset {
143
+ /**
144
+ * The offset value. The value is always taken as negative, so that the automation runs before the trigger date.
145
+ * To create an offset that causes the automation to run after the trigger date, use a delay action.
146
+ */
147
+ preScheduledEventOffsetExpression?: string;
148
+ /** Time unit for the scheduled event offset. */
149
+ scheduledEventOffsetTimeUnit?: TimeUnit;
150
+ }
151
+ export interface RateLimit {
152
+ /** Value expressing the maximum number of times the trigger can be activated. */
153
+ maxActivationsExpression?: string;
154
+ /** Duration of the rate limiting window in the selected time unit. If no value is set, the rate limit is permanent. */
155
+ durationExpression?: string | null;
156
+ /** Time unit for the rate limit duration. */
157
+ durationTimeUnit?: TimeUnit;
158
+ /** Unique identifier of each activation, by which rate limiter will count activations. */
159
+ uniqueIdentifierExpression?: string | null;
160
+ }
161
+ export interface ConditionExpressionGroup {
162
+ /** Expression group operator. */
163
+ operator?: Operator;
164
+ /** List of boolean expressions to be evaluated with the given operator. */
165
+ booleanExpressions?: string[];
166
+ }
167
+ export declare enum Operator {
168
+ UNKNOWN_OPERATOR = "UNKNOWN_OPERATOR",
169
+ OR = "OR",
170
+ AND = "AND"
171
+ }
172
+ export declare enum Type {
173
+ /** Automation will be triggered according to the trigger configuration. */
174
+ UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
175
+ /** App defined Action. */
176
+ APP_DEFINED = "APP_DEFINED",
177
+ /** Condition Action. */
178
+ CONDITION = "CONDITION",
179
+ /** Delay Action. */
180
+ DELAY = "DELAY",
181
+ /** RateLimit Action. */
182
+ RATE_LIMIT = "RATE_LIMIT",
183
+ /** Set Variables Action. */
184
+ SET_VARIABLES = "SET_VARIABLES",
185
+ /** Output Action. */
186
+ OUTPUT = "OUTPUT"
187
+ }
188
+ export interface AppDefinedAction {
189
+ /** ID of the app that defines the action. */
190
+ appId?: string;
191
+ /** Action key. */
192
+ actionKey?: string;
193
+ /** Action input mapping. */
194
+ inputMapping?: Record<string, any> | null;
195
+ /**
196
+ * Array of conditions determining whether to skip the action in the automation flow.
197
+ * The action will be skipped if any of the expression groups evaluate to `true`.
198
+ * Actions following a skipped action will still run.
199
+ */
200
+ skipConditionOrExpressionGroups?: ConditionExpressionGroup[];
201
+ /** List of IDs of actions to run in parallel once the action completes. */
202
+ postActionIds?: string[];
203
+ /** Optional output schema of the action. It will be used instead the action schema in case it's provided. */
204
+ overrideOutputSchema?: Record<string, any> | null;
205
+ }
206
+ export interface ConditionAction {
207
+ /** The condition evaluates to `true` if either of the expression groups evaluate to `true`. */
208
+ orExpressionGroups?: ConditionExpressionGroup[];
209
+ /** List of IDs of actions to run when the entire condition is evaluated to `true`. */
210
+ truePostActionIds?: string[];
211
+ /** List of IDs of actions to run when the entire condition is evaluated to `false`. */
212
+ falsePostActionIds?: string[];
213
+ }
214
+ export interface DelayAction {
215
+ /** Value expressing the amount of time to wait from a specific date or from the time the action is executed. */
216
+ offsetExpression?: string | null;
217
+ /** Time unit for delay offset. */
218
+ offsetTimeUnit?: TimeUnit;
219
+ /**
220
+ * The action due date. If defined without an offset, the automation will wait until this date to execute the next step.
221
+ * If an offset is defined, it's calculated from this date.
222
+ * The date is expressed in the number of milliseconds since the Unix Epoch (1 January, 1970 UTC).
223
+ */
224
+ dueDateEpochExpression?: string | null;
225
+ /** List of IDs of actions to run in parallel after the delay. */
226
+ postActionIds?: string[];
227
+ }
228
+ export interface RateLimitAction {
229
+ /** The maximum number of activations allowed for the action. */
230
+ maxActivationsExpression?: string;
231
+ /**
232
+ * Duration of the rate limiting window, expressed in selected time unit.
233
+ * If no value is set, then there is no time limit on the rate limiter.
234
+ */
235
+ rateLimitDurationExpression?: string | null;
236
+ /** Time unit for the rate limit duration. */
237
+ rateLimitDurationTimeUnit?: TimeUnit;
238
+ /** Unique identifier of each activation by which rate limiter counts activations. */
239
+ uniqueIdentifierExpression?: string | null;
240
+ /** List of IDs of actions to run in parallel once the action completes. */
241
+ postActionIds?: string[];
242
+ }
243
+ export interface SetVariablesAction {
244
+ /**
245
+ * output mapping
246
+ * for example: {"someField": "{{10}}", "someOtherField": "{{multiply( var('account.points.balance') ;2 )}}" }
247
+ */
248
+ outputMapping?: Record<string, any> | null;
249
+ /**
250
+ * output json schema representation
251
+ * could be string instead of Struct (and introduce some compression to minimize the size of it)
252
+ */
253
+ outputSchema?: Record<string, any> | null;
254
+ /** List of IDs of actions to run in parallel after variable initialization. */
255
+ postActionIds?: string[];
256
+ }
257
+ export interface OutputAction {
258
+ /** Output action output mapping. */
259
+ outputMapping?: Record<string, any> | null;
260
+ }
261
+ export declare enum AutomationConfigurationStatus {
262
+ /** unused */
263
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
264
+ /** Automation will be triggered according to the trigger configuration */
265
+ ACTIVE = "ACTIVE",
266
+ /** Automation will not be triggered */
267
+ INACTIVE = "INACTIVE"
268
+ }
269
+ export interface Trigger {
270
+ /** ID of the app that defines the trigger. */
271
+ appId?: string;
272
+ /** Trigger key. */
273
+ triggerKey?: string;
274
+ /**
275
+ * List of filters on schema fields.
276
+ * In order for the automation to run, all filter expressions must evaluate to `true` for a given payload.
277
+ */
278
+ filters?: Filter[];
279
+ /** Defines the time offset between the trigger date and when the automation runs. */
280
+ scheduledEventOffset?: FutureDateActivationOffset;
281
+ /** Limits the number of times an automation can be triggered. */
282
+ rateLimit?: RateLimit;
283
+ /**
284
+ * An optional configuration, per automation, of a schema that is optionally offered by the trigger provider to affect the behavior of the trigger.
285
+ * For example, a trigger provider may offer a schema that allows the user to configure the trigger to happen at a certain time of day,
286
+ * He would define a schema with a field called "startDate" and using this parameter the user can define his preferred startDate, per automation.
287
+ */
288
+ automationConfigMapping?: Record<string, any> | null;
289
+ /** Optional schema of the trigger. It will be used instead the trigger schema in case it's provided. */
290
+ overrideSchema?: Record<string, any> | null;
291
+ }
292
+ export interface AutomationConfigurationAction extends AutomationConfigurationActionInfoOneOf {
293
+ /** Action defined by an app (via RPC, HTTP or Velo). */
294
+ appDefinedInfo?: AppDefinedAction;
295
+ /** Condition action. */
296
+ conditionInfo?: ConditionAction;
297
+ /** Delay action. */
298
+ delayInfo?: DelayAction;
299
+ /** Rate-limiting action. */
300
+ rateLimitInfo?: RateLimitAction;
301
+ /** Action ID. If not specified, a new ID is generated. */
302
+ id?: string | null;
303
+ /** Action type. */
304
+ type?: Type;
305
+ /**
306
+ * Human-readable name to differentiate the action from other actions of the same type.
307
+ * The name can contain only alphanumeric characters and underscores. If not provided, a namespace in the form `actionkey-indexOfAction` is
308
+ * generated automatically.
309
+ * If the action has output, the output will be available in the payload under this name.
310
+ * If the user has multiple actions with the same appId and actionKey, previous action output will be overwritten.
311
+ */
312
+ namespace?: string | null;
313
+ }
314
+ /** @oneof */
315
+ export interface AutomationConfigurationActionInfoOneOf {
316
+ /** Action defined by an app (via RPC, HTTP or Velo). */
317
+ appDefinedInfo?: AppDefinedAction;
318
+ /** Condition action. */
319
+ conditionInfo?: ConditionAction;
320
+ /** Delay action. */
321
+ delayInfo?: DelayAction;
322
+ /** Rate-limiting action. */
323
+ rateLimitInfo?: RateLimitAction;
324
+ }
325
+ export declare enum Origin {
326
+ /** Default value. This is unused. */
327
+ UNKNOWN_ORIGIN = "UNKNOWN_ORIGIN",
328
+ /** User created automation. */
329
+ USER = "USER",
330
+ /** Automation created by application (site specific). */
331
+ APPLICATION = "APPLICATION",
332
+ /** Preinstalled application automation. */
333
+ PREINSTALLED = "PREINSTALLED",
334
+ /** Automation created from a recipe. */
335
+ RECIPE = "RECIPE"
336
+ }
337
+ export interface ApplicationOrigin {
338
+ /** Application ID. */
339
+ appId?: string;
340
+ }
341
+ export interface PreinstalledOrigin {
342
+ /** ID of the app that defines the preinstalled automation. */
343
+ appId?: string;
344
+ /** Application component ID. */
345
+ componentId?: string;
346
+ /** Application component version. */
347
+ componentVersion?: number;
348
+ /**
349
+ * Whether the automation is an override automation. If the user modifies the preinstalled automation installed on their site, a site-specific
350
+ * automation is created that overrides the original one. If the user makes no modifications this boolean is set to `false` and the original
351
+ * preinstalled automation is used.
352
+ *
353
+ * Default: `false`
354
+ * @readonly
355
+ */
356
+ override?: boolean | null;
357
+ }
358
+ export interface AutomationSettings {
359
+ /**
360
+ * Whether the automation is hidden from users.
361
+ * Default: `false`
362
+ */
363
+ hidden?: boolean;
364
+ /**
365
+ * Whether the automation is read-only.
366
+ * Default: `false`
367
+ */
368
+ readonly?: boolean;
369
+ /**
370
+ * Whether the option to delete the automation from the site is disabled.
371
+ * Default: `false`
372
+ */
373
+ disableDelete?: boolean;
374
+ /**
375
+ * Whether the option to change the automation status (from active to inactive and vice versa) is disabled.
376
+ * Default: `false`
377
+ */
378
+ disableStatusChange?: boolean;
379
+ /** Automation action settings. */
380
+ actionSettings?: ActionSettings;
381
+ }
382
+ export interface DraftInfo {
383
+ /**
384
+ * Optional - automationId of the original automation.
385
+ * @readonly
386
+ */
387
+ originalAutomationId?: string | null;
388
+ }
389
+ export interface Enrichments {
390
+ /** Whether the studio site enrichment is wanted. */
391
+ studioSite?: Enrichment;
392
+ }
393
+ export interface ExtendedFields {
394
+ /**
395
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
396
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
397
+ *
398
+ * You can only access fields for which you have the appropriate permissions.
399
+ *
400
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
401
+ */
402
+ namespaces?: Record<string, Record<string, any>>;
403
+ }
404
+ export interface ActivationStatus {
405
+ /** Activation's ID. */
406
+ id?: string;
407
+ /** Configuration's ID. */
408
+ configurationId?: string;
409
+ /** Configuration's Correlation ID. */
410
+ configurationCorrelationId?: string;
411
+ /** Activation's status. */
412
+ status?: Status;
413
+ /** Activation's error reason (if there is one). */
414
+ errorReason?: string | null;
415
+ }
416
+ export declare enum Status {
417
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
418
+ STARTED = "STARTED",
419
+ ENDED = "ENDED",
420
+ ERROR = "ERROR",
421
+ SCHEDULED = "SCHEDULED",
422
+ FROM_SCHEDULER = "FROM_SCHEDULER",
423
+ RETRY = "RETRY",
424
+ RESUMED = "RESUMED",
425
+ PAUSED = "PAUSED",
426
+ ACTION_SKIPPED = "ACTION_SKIPPED"
427
+ }
428
+ export interface ActivationStatusChanged extends ActivationStatusChangedStatusInfoOneOf {
429
+ /** Initiated status information */
430
+ initiatedInfo?: InitiatedStatusInfo;
431
+ /** Started status information */
432
+ startedInfo?: ActivationStatusChangedStartedStatusInfo;
433
+ /** Scheduled status information */
434
+ scheduledInfo?: ScheduledStatusInfo;
435
+ /** Cancelled status information */
436
+ cancelledInfo?: CancelledStatusInfo;
437
+ /** Failed status information */
438
+ failedInfo?: ActivationStatusChangedFailedStatusInfo;
439
+ /** Skipped status information */
440
+ skippedInfo?: SkippedStatusInfo;
441
+ /** Activation */
442
+ activation?: Activation;
443
+ /** Activation status */
444
+ status?: ActivationStatusChangedStatus;
445
+ /** Change event created date */
446
+ statusChangedDate?: Date | null;
447
+ }
448
+ /** @oneof */
449
+ export interface ActivationStatusChangedStatusInfoOneOf {
450
+ /** Initiated status information */
451
+ initiatedInfo?: InitiatedStatusInfo;
452
+ /** Started status information */
453
+ startedInfo?: ActivationStatusChangedStartedStatusInfo;
454
+ /** Scheduled status information */
455
+ scheduledInfo?: ScheduledStatusInfo;
456
+ /** Cancelled status information */
457
+ cancelledInfo?: CancelledStatusInfo;
458
+ /** Failed status information */
459
+ failedInfo?: ActivationStatusChangedFailedStatusInfo;
460
+ /** Skipped status information */
461
+ skippedInfo?: SkippedStatusInfo;
462
+ }
463
+ export declare enum Target {
464
+ UNKNOWN_TARGET = "UNKNOWN_TARGET",
465
+ SCHEDULE = "SCHEDULE",
466
+ IMMEDIATE = "IMMEDIATE"
467
+ }
468
+ export declare enum CancellationReason {
469
+ UNKNOWN_CANCELLATION_REASON = "UNKNOWN_CANCELLATION_REASON",
470
+ /** Indicates that the activation was cancelled directly. */
471
+ EVENT_CANCELLED = "EVENT_CANCELLED",
472
+ /** Indicates that the activation was cancelled because the automation was deactivated. */
473
+ AUTOMATION_DEACTIVATED = "AUTOMATION_DEACTIVATED",
474
+ /** Indicates that the activation was cancelled because the automation was deleted. */
475
+ AUTOMATION_DELETED = "AUTOMATION_DELETED",
476
+ /** Indicates that the activation was cancelled after the automation schedule time was reached. */
477
+ CANCELLED_BY_REFRESH_PAYLOAD = "CANCELLED_BY_REFRESH_PAYLOAD",
478
+ /** Indicates that the activation was cancelled due to a UoU GDPR "Right to be Forgotten" request. */
479
+ CANCELLED_BY_GDPR_REQUEST = "CANCELLED_BY_GDPR_REQUEST"
480
+ }
481
+ export interface Identity {
482
+ /** User ID */
483
+ userId?: string | null;
484
+ /** App ID */
485
+ appId?: string | null;
486
+ }
487
+ export declare enum ErrorReason {
488
+ /** Unexpected error reason */
489
+ UNEXPECTED_ERROR_REASON = "UNEXPECTED_ERROR_REASON",
490
+ /** Failed to evaluate the schedule date expression */
491
+ SCHEDULE_DATE_EVALUATION_FAILED = "SCHEDULE_DATE_EVALUATION_FAILED"
492
+ }
493
+ export declare enum SkipReason {
494
+ UNKNOWN_SKIP_REASON = "UNKNOWN_SKIP_REASON",
495
+ /** Activation was skipped because the scheduled execution time had already passed at the time of execution. */
496
+ SCHEDULE_DATE_EXPIRED = "SCHEDULE_DATE_EXPIRED",
497
+ /** Activation was skipped because the trigger filters defined in the automation did not match the payload. */
498
+ TRIGGER_FILTERS_NOT_PASSED = "TRIGGER_FILTERS_NOT_PASSED"
499
+ }
500
+ export declare enum ActivationStatusChangedStatus {
501
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
502
+ /** Indicates that activation has not started yet and no actions have been executed. */
503
+ INITIATED = "INITIATED",
504
+ /** 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. */
505
+ SCHEDULED = "SCHEDULED",
506
+ /** Indicates the automation activation has started and is currently in progress. */
507
+ STARTED = "STARTED",
508
+ /** Indicates all the automation actions were handled either by invoking them, skipping them, etc. */
509
+ ENDED = "ENDED",
510
+ /** Indicates the activation was cancelled. */
511
+ CANCELLED = "CANCELLED",
512
+ /**
513
+ * Indicates the activation failed to start.
514
+ * Note that failure in the activation of a single action will not result in a failure in activation of the entire automation.
515
+ */
516
+ FAILED = "FAILED",
517
+ /**
518
+ * Indicates that the automation activation was skipped without executing any actions.
519
+ * Note that an activation will either be skipped immediately or move to INITIATED state.
520
+ */
521
+ SKIPPED = "SKIPPED"
522
+ }
523
+ export interface InitiatedStatusInfo {
524
+ /** Activation target */
525
+ target?: Target;
526
+ /** Event payload */
527
+ payload?: Record<string, any> | null;
528
+ /** External entity ID */
529
+ externalEntityId?: string | null;
530
+ /** Unique identifier for the request that initiated the automation */
531
+ requestId?: string;
532
+ }
533
+ export interface ActivationStatusChangedStartedStatusInfo {
534
+ /** Enriched and refreshed payload */
535
+ payload?: Record<string, any> | null;
536
+ }
537
+ export interface ScheduledStatusInfo {
538
+ /** Schedule identifier */
539
+ scheduleId?: string;
540
+ /** Indicates when the activation should start */
541
+ date?: Date | null;
542
+ }
543
+ export interface CancelledStatusInfo {
544
+ /** Cancellation reason */
545
+ reason?: CancellationReason;
546
+ /** Identity (such as user, app, etc.) that caused the cancellation. */
547
+ initiator?: Identity;
548
+ }
549
+ export interface ActivationStatusChangedFailedStatusInfo {
550
+ /**
551
+ * Error description
552
+ * @readonly
553
+ */
554
+ errorDescription?: string;
555
+ /**
556
+ * Error code
557
+ * @readonly
558
+ */
559
+ errorCode?: string | null;
560
+ /** Error reason */
561
+ errorReason?: ErrorReason;
562
+ /** Event payload */
563
+ payload?: Record<string, any> | null;
564
+ /** External entity ID */
565
+ externalEntityId?: string | null;
566
+ /** Unique identifier for the request that initiated the automation */
567
+ requestId?: string | null;
568
+ }
569
+ export interface SkippedStatusInfo {
570
+ /** The reason why the automation activation was skipped */
571
+ reason?: SkipReason;
572
+ /** Event payload */
573
+ payload?: Record<string, any> | null;
574
+ /** External entity ID */
575
+ externalEntityId?: string | null;
576
+ /** Unique identifier for the request that initiated the automation */
577
+ requestId?: string;
578
+ }
579
+ export interface ScheduleRequest {
580
+ schedule?: Schedule;
581
+ }
582
+ export interface Schedule {
583
+ /** @readonly */
584
+ id?: string | null;
585
+ /** doesn't have to be unique. example: triggerName+entityId */
586
+ identifier?: string;
587
+ configurationCorrelationId?: string;
588
+ activationId?: string;
589
+ scheduledAction?: ScheduledAction;
590
+ /** Raw domain event, not enriched */
591
+ eventPayload?: string;
592
+ /** @readonly */
593
+ scheduleStatus?: ScheduleStatus;
594
+ /** @readonly */
595
+ scheduleDate?: Date | null;
596
+ /** @readonly */
597
+ createdDate?: Date | null;
598
+ /** @readonly */
599
+ updatedDate?: Date | null;
600
+ overrideable?: boolean | null;
601
+ triggerInfo?: TriggerInfo;
602
+ automation?: Automation;
603
+ }
604
+ export interface ScheduledAction {
605
+ /** Action's id. */
606
+ id?: string;
607
+ /** decide how long we should wait */
608
+ delay?: Delay;
609
+ }
610
+ export interface Delay extends DelayOfOneOf {
611
+ simple?: SimpleDelay;
612
+ /**
613
+ * jsonata expression - sleep until the given date
614
+ * for example: $toMillis(MyObject.Date) + 2*1000*60*60*24) -> will schedule 2 days after MyObject.Date
615
+ */
616
+ dateExpression?: string;
617
+ }
618
+ /** @oneof */
619
+ export interface DelayOfOneOf {
620
+ simple?: SimpleDelay;
621
+ /**
622
+ * jsonata expression - sleep until the given date
623
+ * for example: $toMillis(MyObject.Date) + 2*1000*60*60*24) -> will schedule 2 days after MyObject.Date
624
+ */
625
+ dateExpression?: string;
626
+ }
627
+ export interface SimpleDelay {
628
+ value?: number;
629
+ units?: Units;
630
+ /** Optional, used if provided: Jsonata expression that evaluates to a number of milliseconds to wait */
631
+ delayExpression?: string | null;
632
+ }
633
+ export declare enum Units {
634
+ UNKNOWN = "UNKNOWN",
635
+ MINUTES = "MINUTES",
636
+ HOURS = "HOURS",
637
+ DAYS = "DAYS"
638
+ }
639
+ export declare enum ScheduleStatus {
640
+ UNKNOWN_SCHEDULE_STATUS = "UNKNOWN_SCHEDULE_STATUS",
641
+ PENDING = "PENDING",
642
+ CANCELLED = "CANCELLED",
643
+ DONE = "DONE"
644
+ }
645
+ export interface TriggerInfo {
646
+ /** App id of the initial trigger. */
647
+ appId?: string;
648
+ /** Trigger key of the initial trigger. */
649
+ triggerKey?: string;
650
+ }
651
+ export interface ScheduleResponse {
652
+ id?: string;
653
+ }
654
+ export interface CancelPendingScheduleRequest extends CancelPendingScheduleRequestByOneOf {
655
+ id?: string;
656
+ identifier?: string;
657
+ configurationCorrelationId?: string;
658
+ activationId?: string;
659
+ identifierPattern?: string;
660
+ }
661
+ /** @oneof */
662
+ export interface CancelPendingScheduleRequestByOneOf {
663
+ id?: string;
664
+ identifier?: string;
665
+ configurationCorrelationId?: string;
666
+ activationId?: string;
667
+ identifierPattern?: string;
668
+ }
669
+ export interface CancelPendingScheduleResponse {
670
+ }
671
+ export interface UpdatePendingSchedulesPayloadRequest {
672
+ identifier?: string;
673
+ eventPayload?: string;
674
+ }
675
+ export interface UpdatePendingSchedulesPayloadResponse {
676
+ }
677
+ export interface DomainEvent extends DomainEventBodyOneOf {
678
+ createdEvent?: EntityCreatedEvent;
679
+ updatedEvent?: EntityUpdatedEvent;
680
+ deletedEvent?: EntityDeletedEvent;
681
+ actionEvent?: ActionEvent;
682
+ /**
683
+ * Unique event ID.
684
+ * Allows clients to ignore duplicate webhooks.
685
+ */
686
+ id?: string;
687
+ /**
688
+ * Assumes actions are also always typed to an entity_type
689
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
690
+ */
691
+ entityFqdn?: string;
692
+ /**
693
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
694
+ * This is although the created/updated/deleted notion is duplication of the oneof types
695
+ * Example: created/updated/deleted/started/completed/email_opened
696
+ */
697
+ slug?: string;
698
+ /** ID of the entity associated with the event. */
699
+ entityId?: string;
700
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
701
+ eventTime?: Date | null;
702
+ /**
703
+ * Whether the event was triggered as a result of a privacy regulation application
704
+ * (for example, GDPR).
705
+ */
706
+ triggeredByAnonymizeRequest?: boolean | null;
707
+ /** If present, indicates the action that triggered the event. */
708
+ originatedFrom?: string | null;
709
+ /**
710
+ * A sequence number defining the order of updates to the underlying entity.
711
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
712
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
713
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
714
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
715
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
716
+ */
717
+ entityEventSequence?: string | null;
718
+ }
719
+ /** @oneof */
720
+ export interface DomainEventBodyOneOf {
721
+ createdEvent?: EntityCreatedEvent;
722
+ updatedEvent?: EntityUpdatedEvent;
723
+ deletedEvent?: EntityDeletedEvent;
724
+ actionEvent?: ActionEvent;
725
+ }
726
+ export interface EntityCreatedEvent {
727
+ entityAsJson?: string;
728
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
729
+ restoreInfo?: RestoreInfo;
730
+ }
731
+ export interface RestoreInfo {
732
+ deletedDate?: Date | null;
733
+ }
734
+ export interface EntityUpdatedEvent {
735
+ /**
736
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
737
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
738
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
739
+ */
740
+ currentEntityAsJson?: string;
741
+ }
742
+ export interface EntityDeletedEvent {
743
+ /** Entity that was deleted */
744
+ deletedEntityAsJson?: string | null;
745
+ }
746
+ export interface ActionEvent {
747
+ bodyAsJson?: string;
748
+ }
749
+ export interface MessageEnvelope {
750
+ /** App instance ID. */
751
+ instanceId?: string | null;
752
+ /** Event type. */
753
+ eventType?: string;
754
+ /** The identification type and identity data. */
755
+ identity?: IdentificationData;
756
+ /** Stringify payload. */
757
+ data?: string;
758
+ }
759
+ export interface IdentificationData extends IdentificationDataIdOneOf {
760
+ /** ID of a site visitor that has not logged in to the site. */
761
+ anonymousVisitorId?: string;
762
+ /** ID of a site visitor that has logged in to the site. */
763
+ memberId?: string;
764
+ /** ID of a Wix user (site owner, contributor, etc.). */
765
+ wixUserId?: string;
766
+ /** ID of an app. */
767
+ appId?: string;
768
+ /** @readonly */
769
+ identityType?: WebhookIdentityType;
770
+ }
771
+ /** @oneof */
772
+ export interface IdentificationDataIdOneOf {
773
+ /** ID of a site visitor that has not logged in to the site. */
774
+ anonymousVisitorId?: string;
775
+ /** ID of a site visitor that has logged in to the site. */
776
+ memberId?: string;
777
+ /** ID of a Wix user (site owner, contributor, etc.). */
778
+ wixUserId?: string;
779
+ /** ID of an app. */
780
+ appId?: string;
781
+ }
782
+ export declare enum WebhookIdentityType {
783
+ UNKNOWN = "UNKNOWN",
784
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
785
+ MEMBER = "MEMBER",
786
+ WIX_USER = "WIX_USER",
787
+ APP = "APP"
788
+ }
789
+ export interface ActivationRequest {
790
+ /** Activation's ID. */
791
+ activationId?: string;
792
+ /** Configuration's ID. */
793
+ configurationId?: string;
794
+ configurationCorrelationId?: string;
795
+ /** Received event name. */
796
+ eventName?: string;
797
+ /** Received event slug. */
798
+ eventSlug?: string | null;
799
+ /** Received event payload. */
800
+ eventPayload?: string | null;
801
+ /** List of action data. */
802
+ actions?: ActionData[];
803
+ /** External ID. */
804
+ externalId?: string;
805
+ /** The source of this activation */
806
+ source?: ActivationSource;
807
+ /** Actions tree */
808
+ actionsMap?: ActionsData;
809
+ /** Automation V2. Used for reporting domain event until activation request will be deprecated. */
810
+ automation?: Automation;
811
+ /** Trigger entity for the activation, available for v2 and v3 automations only */
812
+ triggerSchema?: Record<string, any> | null;
813
+ }
814
+ export interface Runtime {
815
+ }
816
+ export interface Scheduler {
817
+ scheduleId?: string | null;
818
+ }
819
+ export interface AsyncAction {
820
+ }
821
+ export interface ActionData {
822
+ /**
823
+ * Action's id.
824
+ * @readonly
825
+ */
826
+ id?: string | null;
827
+ /** Action's data. */
828
+ action?: Action;
829
+ }
830
+ export interface Action extends ActionActionOneOf {
831
+ service?: Service;
832
+ systemHelper?: SystemHelper;
833
+ spiAction?: SpiAction;
834
+ }
835
+ /** @oneof */
836
+ export interface ActionActionOneOf {
837
+ service?: Service;
838
+ systemHelper?: SystemHelper;
839
+ spiAction?: SpiAction;
840
+ }
841
+ export interface ServiceMapping {
842
+ /** Sevice name. */
843
+ name?: string;
844
+ /** Method name. */
845
+ method?: string;
846
+ }
847
+ export interface IfFilter {
848
+ /** If filter's condition. */
849
+ condition?: string;
850
+ /** If's true post actions. */
851
+ truePostActions?: ActionData[];
852
+ /** If's false post actions. */
853
+ falsePostActions?: ActionData[];
854
+ /** If's true post actions ids. */
855
+ truePostActionsIds?: string[];
856
+ /** If's false post actions ids. */
857
+ falsePostActionsIds?: string[];
858
+ }
859
+ export interface SwitchFilter {
860
+ /** Switch's filter cases. */
861
+ cases?: Case[];
862
+ }
863
+ export interface Case {
864
+ /** Case's condition. */
865
+ condition?: any;
866
+ /** Case's post actions. */
867
+ postActions?: ActionData[];
868
+ /** Case's post actions ids. */
869
+ postActionsIds?: string[];
870
+ }
871
+ export interface DelayHelper {
872
+ /** jsonata expression, for example: triggerName + eventId */
873
+ scheduleIdentifier?: string;
874
+ /** decide how long we should wait */
875
+ delay?: Delay;
876
+ /** Delay's post actions. */
877
+ postActions?: ActionData[];
878
+ /**
879
+ * Optional: if true, any new schedule with the same schedule identifier will override the existing one.
880
+ * If false, the new schedule will be ignored.
881
+ */
882
+ overrideable?: boolean | null;
883
+ /** Delay's post actions ids. */
884
+ postActionsIds?: string[];
885
+ }
886
+ export interface RateLimiting {
887
+ /** The maximum number of activations allowed in the given time frame */
888
+ maxNumOfActivations?: number;
889
+ /** Optional, used if provided: A jsonata expression that evaluates to the maximum number of activations allowed in the given time frame */
890
+ maxNumOfActivationsExpression?: string | null;
891
+ /** If given - the time frame in minutes, otherwise, for life */
892
+ timeFrameInMinutes?: number | null;
893
+ /** Optional, used if provided - A jsonata expression that evaluates to the time frame in minutes, otherwise, for life */
894
+ timeFrameInMinutesExpression?: string | null;
895
+ /** The jsonata to use to extract the entity/resource key from the enriched event payload */
896
+ keyJsonata?: string;
897
+ /** 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 */
898
+ postActions?: ActionData[];
899
+ /** 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 */
900
+ postActionsIds?: string[];
901
+ }
902
+ export interface ConditionFilter {
903
+ /** condition evaluates to `true` if either of the blocks evaluate to `true` (aka OR between all). */
904
+ conditionBlocks?: ConditionBlock[];
905
+ /** Actions to perform when condition_blocks evaluates to `true`. */
906
+ postActions?: ActionData[];
907
+ /** Action's post actions ids. */
908
+ postActionsIds?: string[];
909
+ /** Actions to perform when condition_blocks evaluates to `false`. */
910
+ elsePostActions?: ActionData[];
911
+ }
912
+ export declare enum BlockType {
913
+ UNKNOWN = "UNKNOWN",
914
+ OR = "OR",
915
+ AND = "AND"
916
+ }
917
+ export interface ConditionBlock {
918
+ type?: BlockType;
919
+ lineExpressions?: string[];
920
+ }
921
+ export interface Output {
922
+ /** The jsonata to use to produce the output */
923
+ outputMapping?: string;
924
+ }
925
+ export interface SetVariables {
926
+ /**
927
+ * Action's output mapping.
928
+ * Jsonata expressions to set variables
929
+ * for example: { "var1": "$average([10,20])", "var2": "$number($lookup($, $decodeUrlComponent(\"var1\"))) >= $number(8)"" }
930
+ */
931
+ outputMapping?: string;
932
+ /** Action's post actions. */
933
+ postActions?: ActionData[];
934
+ /** Action's post actions ids. */
935
+ postActionsIds?: string[];
936
+ /** The namespace of the action */
937
+ namespace?: string | null;
938
+ }
939
+ export interface Service {
940
+ /** Action's service mapping. */
941
+ serviceMapping?: ServiceMapping;
942
+ /**
943
+ * Action's input mapping.
944
+ * Jsonata description of the input this service gets.
945
+ */
946
+ inputMapping?: string | null;
947
+ /**
948
+ * Action's output mapping.
949
+ * Jsonata description of the output this service returns.
950
+ */
951
+ outputMapping?: string | null;
952
+ /** Action's post actions. */
953
+ postActions?: ActionData[];
954
+ /** Action's post actions ids. */
955
+ postActionsIds?: string[];
956
+ /** The namespace of the action */
957
+ namespace?: string | null;
958
+ }
959
+ export interface SystemHelper extends SystemHelperHelperOneOf {
960
+ ifFilter?: IfFilter;
961
+ switchFilter?: SwitchFilter;
962
+ delay?: DelayHelper;
963
+ rateLimiting?: RateLimiting;
964
+ conditionFilter?: ConditionFilter;
965
+ output?: Output;
966
+ setVariables?: SetVariables;
967
+ }
968
+ /** @oneof */
969
+ export interface SystemHelperHelperOneOf {
970
+ ifFilter?: IfFilter;
971
+ switchFilter?: SwitchFilter;
972
+ delay?: DelayHelper;
973
+ rateLimiting?: RateLimiting;
974
+ conditionFilter?: ConditionFilter;
975
+ output?: Output;
976
+ setVariables?: SetVariables;
977
+ }
978
+ export interface SpiAction {
979
+ /** The App Def Id of the action provider */
980
+ appDefId?: string;
981
+ /** Identifier for this action - human readable action key - unique per app def id */
982
+ actionKey?: string;
983
+ /** The configuration of the user for this action, can include params that are taken from the trigger event payload */
984
+ userActionConfig?: string | null;
985
+ /** The post action to execute after this action */
986
+ postActions?: ActionData[];
987
+ /** The output configuration of the user for this action, can include params that are taken from the trigger event payload */
988
+ userOutputActionConfig?: string | null;
989
+ /**
990
+ * optional skip condition expression for current action
991
+ * decides whether to skip the action before executing it's post actions
992
+ */
993
+ skipConditionExpression?: string | null;
994
+ /** Action's post actions ids. */
995
+ postActionsIds?: string[];
996
+ /** The namespace of the action */
997
+ namespace?: string | null;
998
+ }
999
+ export interface ActivationSource extends ActivationSourceOfOneOf {
1000
+ runtime?: Runtime;
1001
+ scheduler?: Scheduler;
1002
+ asyncAction?: AsyncAction;
1003
+ }
1004
+ /** @oneof */
1005
+ export interface ActivationSourceOfOneOf {
1006
+ runtime?: Runtime;
1007
+ scheduler?: Scheduler;
1008
+ asyncAction?: AsyncAction;
1009
+ }
1010
+ export interface ActionsData {
1011
+ /** Ids of the first level actions. */
1012
+ rootActionIds?: string[];
1013
+ /** Map of action id to action data. */
1014
+ actions?: Record<string, Action>;
1015
+ }
1016
+ export interface ActionStatus {
1017
+ /** Action's status. */
1018
+ id?: string;
1019
+ /** Activation's ID. */
1020
+ activationId?: string;
1021
+ /** Action's name. */
1022
+ actionName?: string | null;
1023
+ /** Action's status. */
1024
+ status?: Status;
1025
+ /** Action's error reason (if there is one). */
1026
+ errorReason?: string | null;
1027
+ /** Activation external id. */
1028
+ activationExternalId?: string;
1029
+ /** Trigger app id. */
1030
+ triggerAppId?: string | null;
1031
+ /** Trigger key. */
1032
+ triggerKey?: string | null;
1033
+ /** The configuration correlation id */
1034
+ configurationCorrelationId?: string | null;
1035
+ }
1036
+ export interface BatchActivationRequest {
1037
+ /** List of Activation-Request. */
1038
+ activationRequests?: ActivationRequest[];
1039
+ }
1040
+ export interface Empty {
1041
+ }
1042
+ export interface ActivationActionStatusChanged extends ActivationActionStatusChangedInfoOneOf, ActivationActionStatusChangedStatusInfoOneOf {
1043
+ /** App defined action info */
1044
+ appDefinedInfo?: AppDefinedActionInfo;
1045
+ /** Started status information */
1046
+ startedInfo?: StartedStatusInfo;
1047
+ /** Ended status information */
1048
+ endedInfo?: EndedStatusInfo;
1049
+ /** Failed status information */
1050
+ failedInfo?: FailedStatusInfo;
1051
+ /** Action ID */
1052
+ id?: string;
1053
+ /** Activation ID */
1054
+ activationId?: string;
1055
+ /** Automation info */
1056
+ automationInfo?: AutomationInfo;
1057
+ /** Action type */
1058
+ type?: Type;
1059
+ /** External entity ID */
1060
+ externalEntityId?: string | null;
1061
+ /** Event date */
1062
+ statusChangedDate?: Date | null;
1063
+ /** Action activation status */
1064
+ status?: ActivationActionStatusChangedStatus;
1065
+ }
1066
+ /** @oneof */
1067
+ export interface ActivationActionStatusChangedInfoOneOf {
1068
+ /** App defined action info */
1069
+ appDefinedInfo?: AppDefinedActionInfo;
1070
+ }
1071
+ /** @oneof */
1072
+ export interface ActivationActionStatusChangedStatusInfoOneOf {
1073
+ /** Started status information */
1074
+ startedInfo?: StartedStatusInfo;
1075
+ /** Ended status information */
1076
+ endedInfo?: EndedStatusInfo;
1077
+ /** Failed status information */
1078
+ failedInfo?: FailedStatusInfo;
1079
+ }
1080
+ export interface StartedStatusInfoAppDefinedActionInfo {
1081
+ /** Action input */
1082
+ input?: Record<string, any> | null;
1083
+ }
1084
+ export interface StartedStatusInfoDelayActionInfo {
1085
+ /** Indicates when this action becomes completed and the activation will move to the post actions */
1086
+ date?: Date | null;
1087
+ }
1088
+ export interface ExpressionEvaluationResult {
1089
+ /** Indicates if the expression was evaluated to true or false */
1090
+ passed?: boolean;
1091
+ /** Indicates if there was an error in the evaluation process */
1092
+ error?: boolean;
1093
+ }
1094
+ export interface EndedStatusInfoAppDefinedActionInfo {
1095
+ /** Output returned by the action implementer. */
1096
+ output?: Record<string, any> | null;
1097
+ }
1098
+ export interface ConditionActionInfo {
1099
+ /** Indicates that the condition `if` clause evaluated to `true`. */
1100
+ passed?: boolean;
1101
+ /** Collects results per each expression evaluation that took place */
1102
+ expressionResults?: Record<string, ExpressionEvaluationResult>;
1103
+ }
1104
+ export interface RateLimitActionInfo {
1105
+ /** Indicates if the rate limiter passed (not reached the quota) */
1106
+ passed?: boolean;
1107
+ }
1108
+ export interface DelayActionInfo {
1109
+ /** Enriched and refreshed payload */
1110
+ payload?: Record<string, any> | null;
1111
+ }
1112
+ export interface SetVariablesActionInfo {
1113
+ /** Output returned after jsonata expression evaluation */
1114
+ output?: Record<string, any> | null;
1115
+ }
1116
+ export interface AutomationInfo extends AutomationInfoOriginInfoOneOf {
1117
+ /** Application info */
1118
+ applicationInfo?: ApplicationOrigin;
1119
+ /** Preinstalled info */
1120
+ preinstalledInfo?: PreinstalledOrigin;
1121
+ /** Automation ID */
1122
+ id?: string;
1123
+ /** Origin type */
1124
+ origin?: Origin;
1125
+ /** Trigger info */
1126
+ triggerInfo?: AutomationInfoTriggerInfo;
1127
+ }
1128
+ /** @oneof */
1129
+ export interface AutomationInfoOriginInfoOneOf {
1130
+ /** Application info */
1131
+ applicationInfo?: ApplicationOrigin;
1132
+ /** Preinstalled info */
1133
+ preinstalledInfo?: PreinstalledOrigin;
1134
+ }
1135
+ export interface AutomationInfoTriggerInfo {
1136
+ /** Trigger app ID */
1137
+ appId?: string;
1138
+ /** Trigger key */
1139
+ triggerKey?: string;
1140
+ }
1141
+ export interface AppDefinedActionInfo {
1142
+ /** Action app ID */
1143
+ appId?: string;
1144
+ /** Action key */
1145
+ actionKey?: string;
1146
+ }
1147
+ export declare enum ActivationActionStatusChangedStatus {
1148
+ UNKNOWN_ACTION_ACTIVATION_STATUS = "UNKNOWN_ACTION_ACTIVATION_STATUS",
1149
+ /**
1150
+ * Indicates that action activation has started and is in progress.
1151
+ * Relevant to action types: APP_DEFINED, DELAY.
1152
+ */
1153
+ STARTED = "STARTED",
1154
+ /**
1155
+ * Indicates that the action activation was completed without errors.
1156
+ * Relevant to action types: APP_DEFINED, DELAY, CONDITION, RATE_LIMIT.
1157
+ */
1158
+ ENDED = "ENDED",
1159
+ /**
1160
+ * Indicates that the action was skipped and post actions won't start.
1161
+ * Relevant to action types: APP_DEFINED.
1162
+ */
1163
+ SKIPPED = "SKIPPED",
1164
+ /**
1165
+ * Indicates that the action failed.
1166
+ * Relevant to action types: APP_DEFINED, DELAY, RATE_LIMIT.
1167
+ */
1168
+ FAILED = "FAILED"
1169
+ }
1170
+ export interface StartedStatusInfo extends StartedStatusInfoTypeInfoOneOf {
1171
+ /** APP DEFINED action additional info */
1172
+ appDefinedActionInfo?: StartedStatusInfoAppDefinedActionInfo;
1173
+ /** Delay action additional info */
1174
+ delayActionInfo?: StartedStatusInfoDelayActionInfo;
1175
+ }
1176
+ /** @oneof */
1177
+ export interface StartedStatusInfoTypeInfoOneOf {
1178
+ /** APP DEFINED action additional info */
1179
+ appDefinedActionInfo?: StartedStatusInfoAppDefinedActionInfo;
1180
+ /** Delay action additional info */
1181
+ delayActionInfo?: StartedStatusInfoDelayActionInfo;
1182
+ }
1183
+ export interface EndedStatusInfo extends EndedStatusInfoTypeInfoOneOf {
1184
+ /** APP DEFINED action additional info */
1185
+ appDefinedActionInfo?: EndedStatusInfoAppDefinedActionInfo;
1186
+ /** Condition action additional info */
1187
+ conditionActionInfo?: ConditionActionInfo;
1188
+ /** Rate limit action additional info */
1189
+ rateLimitActionInfo?: RateLimitActionInfo;
1190
+ /** Delay action additional info */
1191
+ delayActionInfo?: DelayActionInfo;
1192
+ /** Set Variables action additional info */
1193
+ setVariablesActionInfo?: SetVariablesActionInfo;
1194
+ }
1195
+ /** @oneof */
1196
+ export interface EndedStatusInfoTypeInfoOneOf {
1197
+ /** APP DEFINED action additional info */
1198
+ appDefinedActionInfo?: EndedStatusInfoAppDefinedActionInfo;
1199
+ /** Condition action additional info */
1200
+ conditionActionInfo?: ConditionActionInfo;
1201
+ /** Rate limit action additional info */
1202
+ rateLimitActionInfo?: RateLimitActionInfo;
1203
+ /** Delay action additional info */
1204
+ delayActionInfo?: DelayActionInfo;
1205
+ /** Set Variables action additional info */
1206
+ setVariablesActionInfo?: SetVariablesActionInfo;
1207
+ }
1208
+ export interface FailedStatusInfo {
1209
+ /** Error description */
1210
+ errorDescription?: string;
1211
+ /** Error code */
1212
+ errorCode?: string | null;
1213
+ }
1214
+ export interface ActivationResumeAfterDelay {
1215
+ /** Activation identifier */
1216
+ id?: string;
1217
+ /** Activation schedule identifier */
1218
+ scheduleId?: string;
1219
+ /** Activation schedule due date */
1220
+ scheduleDate?: Date | null;
1221
+ /** Activation payload */
1222
+ payload?: Record<string, any> | null;
1223
+ /** Activation Automation */
1224
+ automation?: Automation;
1225
+ /** Scheduled action identifier - with the intent to execute that action's post actions */
1226
+ scheduledActionId?: string;
1227
+ /** Optional - external entity id that this activation is related to */
1228
+ externalEntityId?: string | null;
1229
+ }
1230
+ export interface ActionCompletedRequest {
1231
+ /** The execution identifier that was given to the spi provider when we invoked the action */
1232
+ executionIdentifier?: string;
1233
+ /** The result of invoking the action. Must conform to the output schema configured by the action provider. */
1234
+ result?: Record<string, any> | null;
1235
+ }
1236
+ export interface RefreshPayloadRequest {
1237
+ /** Application definition ID. */
1238
+ appDefId?: string;
1239
+ /** Trigger key. */
1240
+ triggerKey?: string;
1241
+ /** Payload to refresh. */
1242
+ payload?: Record<string, any> | null;
1243
+ /** External entity ID. */
1244
+ externalEntityId?: string | null;
1245
+ }
1246
+ export interface RefreshPayloadResponse {
1247
+ /** Updated payload. */
1248
+ payload?: Record<string, any> | null;
1249
+ /** If the automation activation should be canceled (default is false) */
1250
+ cancelActivation?: boolean | null;
1251
+ }
1252
+ export interface RunAutomationRequest {
1253
+ /** App of the automation trigger */
1254
+ appId?: string;
1255
+ /** Trigger key of the action */
1256
+ triggerKey?: string;
1257
+ /** Payload of the triggered event */
1258
+ triggerPayload?: Record<string, any> | null;
1259
+ /** Specific automation id to run */
1260
+ automationId?: string;
1261
+ /** Schema of the trigger */
1262
+ triggerSchema?: Record<string, any> | null;
1263
+ }
1264
+ export interface RunAutomationResponse {
1265
+ /** Automation activation output payload */
1266
+ output?: Record<string, any> | null;
1267
+ }
1268
+ export interface ActivationScheduleRequested {
1269
+ /** Activation identifier */
1270
+ id?: string;
1271
+ /** Activation schedule request date */
1272
+ requestedDate?: Date | null;
1273
+ /** Activation schedule due date */
1274
+ scheduleDate?: Date | null;
1275
+ /** Activation payload */
1276
+ payload?: Record<string, any> | null;
1277
+ /** Activation Automation */
1278
+ automation?: Automation;
1279
+ /** Optional - external entity id that this activation is related to */
1280
+ externalEntityId?: string | null;
1281
+ }
1282
+ export interface ScheduleActivationRequested {
1283
+ /** Activation identifier */
1284
+ id?: string;
1285
+ /** Optional - external entity id that this activation is related to */
1286
+ externalEntityId?: string | null;
1287
+ /** Activation payload */
1288
+ payload?: Record<string, any> | null;
1289
+ /** Activation Automation */
1290
+ automation?: Automation;
1291
+ /** Activation schedule date */
1292
+ scheduleDate?: Date | null;
1293
+ }
1294
+ export interface ActivationContinuedAfterSchedule {
1295
+ /** Activation identifier */
1296
+ id?: string;
1297
+ /** Activation Automation */
1298
+ automation?: Automation;
1299
+ }
1300
+ export interface ReportEventRequest {
1301
+ /**
1302
+ * Trigger key as defined in your app's trigger configuration
1303
+ * in the app dashboard.
1304
+ * For example, `form_submitted` or `invoice_due`.
1305
+ */
1306
+ triggerKey: string;
1307
+ /**
1308
+ * Event payload, formatted as key:value pairs.
1309
+ * Must comply with the payload schema
1310
+ * if you provided one when configuring your trigger.
1311
+ *
1312
+ * Key names can include only alphanumeric characters or underscores
1313
+ * (`A-Z`, `a-z`, `0-9`, `_`).
1314
+ * They cannot start with an underscore.
1315
+ *
1316
+ * Values can be strings, numbers, integers, booleans, or arrays.
1317
+ * If a value is an array, the array items must be objects,
1318
+ * and nested object properties must be
1319
+ * strings, numbers, integers, or booleans only.
1320
+ */
1321
+ payload?: Record<string, any> | null;
1322
+ /**
1323
+ * ID of the related resource in GUID format.
1324
+ * For example, `fc81a355-3429-50fc-a4c7-def486e828f3`.
1325
+ *
1326
+ * Required if your app needs to
1327
+ * [cancel the event](https://dev.wix.com/docs/rest/business-management/automations/triggered-events/cancel-event)
1328
+ * if the automation becomes no longer relevant.
1329
+ *
1330
+ * Typically, this ID is defined in your system,
1331
+ * but you can also use any Wix resource GUID,
1332
+ * such as contact ID, member ID, or invoice ID.
1333
+ * See
1334
+ * [Choose the right `externalEntityId`](https://dev.wix.com/docs/rest/business-management/automations/triggered-events/reporting-and-canceling-events#about-canceling-events)
1335
+ * for more information.
1336
+ */
1337
+ externalEntityId?: string | null;
1338
+ /** Idempotency information for the event. */
1339
+ idempotency?: Idempotency;
1340
+ }
1341
+ export interface Idempotency {
1342
+ /**
1343
+ * A unique identifier for the event.
1344
+ * If you send the same idempotency key in multiple report event requests, for the same trigger key and app id,
1345
+ * consecutive requests will be ignored after the first one. Note that the idempotency key is kept for a week before it expires.
1346
+ */
1347
+ key?: string;
1348
+ /** Optional. The time to live (TTL) in milliseconds before the key will expire. Default is a week. */
1349
+ ttlInMilliseconds?: string | null;
1350
+ }
1351
+ export interface ReportEventResponse {
1352
+ /** The activation IDs of triggered ReportEvents. */
1353
+ activationIds?: string[];
1354
+ }
1355
+ export interface BulkReportEventRequest {
1356
+ /**
1357
+ * Trigger key as defined in your app's trigger configuration
1358
+ * in the app dashboard.
1359
+ * For example, `form_submitted` or `invoice_due`.
1360
+ */
1361
+ triggerKey: string;
1362
+ /** Repeated list of event details for bulk reporting. */
1363
+ eventsInfo: EventInfo[];
1364
+ }
1365
+ export interface EventInfo {
1366
+ /**
1367
+ * Event payload, formatted as key:value pairs.
1368
+ * Must comply with the payload schema
1369
+ * if you provided one when configuring your trigger.
1370
+ */
1371
+ payload?: Record<string, any> | null;
1372
+ /** ID of the related resource in GUID format. */
1373
+ externalEntityId?: string | null;
1374
+ /** Idempotency information for the event. */
1375
+ idempotency?: Idempotency;
1376
+ }
1377
+ export interface BulkReportEventResponse {
1378
+ /** Trigger key associated with the event. */
1379
+ triggerKey?: string;
1380
+ /** List of results for each item in the bulk report event request. */
1381
+ results?: BulkReportEventResult[];
1382
+ /** Metadata for the overall bulk action, including success and failure counts. */
1383
+ bulkActionMetadata?: BulkActionMetadata;
1384
+ }
1385
+ export interface BulkReportEventResult {
1386
+ /** Metadata for the individual item in the request. */
1387
+ itemMetadata?: ItemMetadata;
1388
+ /** Event details for the item in the request. */
1389
+ eventInfo?: EventInfo;
1390
+ /** The activation IDs of triggered ReportEvents. */
1391
+ activationIds?: string[];
1392
+ }
1393
+ export interface ItemMetadata {
1394
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
1395
+ id?: string | null;
1396
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
1397
+ originalIndex?: number;
1398
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
1399
+ success?: boolean;
1400
+ /** Details about the error in case of failure. */
1401
+ error?: ApplicationError;
1402
+ }
1403
+ export interface ApplicationError {
1404
+ /** Error code. */
1405
+ code?: string;
1406
+ /** Description of the error. */
1407
+ description?: string;
1408
+ /** Data related to the error. */
1409
+ data?: Record<string, any> | null;
1410
+ }
1411
+ export interface BulkActionMetadata {
1412
+ /** Number of items that were successfully processed. */
1413
+ totalSuccesses?: number;
1414
+ /** Number of items that couldn't be processed. */
1415
+ totalFailures?: number;
1416
+ /** Number of failures without details because detailed failure threshold was exceeded. */
1417
+ undetailedFailures?: number;
1418
+ }
1419
+ export interface BulkCancelEventRequest {
1420
+ /**
1421
+ * Trigger key whose events you want to cancel.
1422
+ * For example, `form_submitted` or `invoice_due`.
1423
+ */
1424
+ triggerKey: string;
1425
+ /** Repeated list of external_entity_id, representing the related resources' IDs. */
1426
+ externalEntityIds: string[];
1427
+ }
1428
+ export interface BulkCancelEventResponse {
1429
+ /** Trigger key related to the canceled event. */
1430
+ triggerKey?: string;
1431
+ /** List of results for each item in the bulk cancel event request. */
1432
+ results?: BulkCancelEventResult[];
1433
+ /** Metadata for the overall bulk action, including success and failure counts. */
1434
+ bulkActionMetadata?: BulkActionMetadata;
1435
+ }
1436
+ export interface BulkCancelEventResult {
1437
+ /** Metadata of the item, including its ID and success or failure status. */
1438
+ itemMetadata?: ItemMetadata;
1439
+ /** ID of the related resource in GUID format. */
1440
+ externalEntityId?: string;
1441
+ }
1442
+ export interface CancelEventRequest {
1443
+ /**
1444
+ * ID of the related resource in GUID format.
1445
+ * For example, `fc81a355-3429-50fc-a4c7-def486e828f3`.
1446
+ *
1447
+ * Typically, this ID is defined in your system,
1448
+ * but you can also use any Wix resource GUID,
1449
+ * such as contact ID, member ID, or invoice ID.
1450
+ * See
1451
+ * [Choose the right `externalEntityId`](https://dev.wix.com/docs/rest/business-management/automations/triggered-events/reporting-and-canceling-events#choose-the-right-externalentityid)
1452
+ * for more information.
1453
+ */
1454
+ externalEntityId: string;
1455
+ /**
1456
+ * Trigger key whose event you want to cancel.
1457
+ * For example, `form_submitted` or `invoice_due`.
1458
+ */
1459
+ triggerKey: string;
1460
+ }
1461
+ export interface CancelEventResponse {
1462
+ }
1463
+ export interface V1RunAutomationRequest extends V1RunAutomationRequestIdentifierOneOf {
1464
+ /** a preinstalled automation identifier */
1465
+ preinstalledIdentifier?: PreinstalledIdentifier;
1466
+ /** a automation of any type identifier that will be available in future */
1467
+ automationIdentifier?: AutomationIdentifier;
1468
+ /** identifier MUST be either AUTOMATION or PREINSTALLED */
1469
+ identifierType?: IdentifierType;
1470
+ /**
1471
+ * Event payload, formatted as key:value pairs.
1472
+ * Must comply with the payload schema
1473
+ * if you provided one when configuring your trigger.
1474
+ *
1475
+ * Key names can include only alphanumeric characters or underscores
1476
+ * (`A-Z`, `a-z`, `0-9`, `_`).
1477
+ * They cannot start with an underscore.
1478
+ *
1479
+ * Values can be strings, numbers, integers, booleans, or arrays.
1480
+ * If a value is an array, the array items must be objects,
1481
+ * and nested object properties must be
1482
+ * strings, numbers, integers, or booleans only.
1483
+ */
1484
+ payload?: Record<string, any> | null;
1485
+ }
1486
+ /** @oneof */
1487
+ export interface V1RunAutomationRequestIdentifierOneOf {
1488
+ /** a preinstalled automation identifier */
1489
+ preinstalledIdentifier?: PreinstalledIdentifier;
1490
+ /** a automation of any type identifier that will be available in future */
1491
+ automationIdentifier?: AutomationIdentifier;
1492
+ }
1493
+ export declare enum IdentifierType {
1494
+ UNKNOWN_IDENTIFIER = "UNKNOWN_IDENTIFIER",
1495
+ PREINSTALLED = "PREINSTALLED",
1496
+ AUTOMATION = "AUTOMATION"
1497
+ }
1498
+ export interface PreinstalledIdentifier {
1499
+ /** identifier for the application of the preinstalled */
1500
+ appId?: string;
1501
+ /** application component id */
1502
+ componentId?: string;
1503
+ }
1504
+ export interface AutomationIdentifier {
1505
+ /** automation id */
1506
+ automationId?: string;
1507
+ }
1508
+ export interface V1RunAutomationResponse {
1509
+ }
1510
+ export interface ReportDomainEventRequest {
1511
+ /** trigger app id */
1512
+ triggerAppId?: string;
1513
+ /** report event request */
1514
+ reportEventRequest?: ReportEventRequest;
1515
+ }
1516
+ export interface ReportDomainEventResponse {
1517
+ }
1518
+ export interface ExecuteFromActionRequest {
1519
+ /** Requested action id */
1520
+ actionId?: string;
1521
+ /** Optional: an activation id to link this action to */
1522
+ activationId?: string | null;
1523
+ /** Activation payload */
1524
+ payload?: Record<string, any> | null;
1525
+ /** Configuration correlation id to run this action from */
1526
+ configurationCorrelationId?: string;
1527
+ /** Optional - schedule id that this action was scheduled from */
1528
+ scheduleId?: string | null;
1529
+ /** Optional - an external entity id that this execution is related to */
1530
+ externalEntityId?: string | null;
1531
+ /** Optional - Activation automation */
1532
+ automation?: Automation;
1533
+ }
1534
+ export interface ExecuteFromActionResponse {
1535
+ }
1536
+ export interface ActivationScheduleCompleted {
1537
+ /** Activation identifier */
1538
+ id?: string;
1539
+ /** Activation schedule identifier */
1540
+ scheduleId?: string;
1541
+ /** Activation schedule due date */
1542
+ scheduleDate?: Date | null;
1543
+ /** Activation payload */
1544
+ payload?: Record<string, any> | null;
1545
+ /** Activation Automation */
1546
+ automation?: Automation;
1547
+ /** Optional - external entity id that this activation is related to */
1548
+ externalEntityId?: string | null;
1549
+ }
1550
+ export interface ReportEventResponseNonNullableFields {
1551
+ activationIds: string[];
1552
+ }
1553
+ interface ApplicationErrorNonNullableFields {
1554
+ code: string;
1555
+ description: string;
1556
+ }
1557
+ interface ItemMetadataNonNullableFields {
1558
+ originalIndex: number;
1559
+ success: boolean;
1560
+ error?: ApplicationErrorNonNullableFields;
1561
+ }
1562
+ interface IdempotencyNonNullableFields {
1563
+ key: string;
1564
+ }
1565
+ interface EventInfoNonNullableFields {
1566
+ idempotency?: IdempotencyNonNullableFields;
1567
+ }
1568
+ interface BulkReportEventResultNonNullableFields {
1569
+ itemMetadata?: ItemMetadataNonNullableFields;
1570
+ eventInfo?: EventInfoNonNullableFields;
1571
+ activationIds: string[];
1572
+ }
1573
+ interface BulkActionMetadataNonNullableFields {
1574
+ totalSuccesses: number;
1575
+ totalFailures: number;
1576
+ undetailedFailures: number;
1577
+ }
1578
+ export interface BulkReportEventResponseNonNullableFields {
1579
+ triggerKey: string;
1580
+ results: BulkReportEventResultNonNullableFields[];
1581
+ bulkActionMetadata?: BulkActionMetadataNonNullableFields;
1582
+ }
1583
+ interface BulkCancelEventResultNonNullableFields {
1584
+ itemMetadata?: ItemMetadataNonNullableFields;
1585
+ externalEntityId: string;
1586
+ }
1587
+ export interface BulkCancelEventResponseNonNullableFields {
1588
+ triggerKey: string;
1589
+ results: BulkCancelEventResultNonNullableFields[];
1590
+ bulkActionMetadata?: BulkActionMetadataNonNullableFields;
1591
+ }
1592
+ export {};