@wix/auto_sdk_automations_activation-log 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-activation-logs-v1-activation-log-activation-log.context.d.ts +7 -0
  11. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.context.js +25 -0
  12. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.context.js.map +1 -0
  13. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.http.d.ts +11 -0
  14. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.http.js +176 -0
  15. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.http.js.map +1 -0
  16. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.meta.d.ts +17 -0
  17. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.meta.js +85 -0
  18. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.meta.js.map +1 -0
  19. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.public.d.ts +32 -0
  20. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.public.js +40 -0
  21. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.public.js.map +1 -0
  22. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.types.d.ts +1144 -0
  23. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.types.js +158 -0
  24. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.types.js.map +1 -0
  25. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.universal.d.ts +1228 -0
  26. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.universal.js +323 -0
  27. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.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-activation-logs-v1-activation-log-activation-log.context.d.ts +7 -0
  39. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.context.js +7 -0
  40. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.context.js.map +1 -0
  41. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.http.d.ts +11 -0
  42. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.http.js +170 -0
  43. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.http.js.map +1 -0
  44. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.meta.d.ts +17 -0
  45. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.meta.js +56 -0
  46. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.meta.js.map +1 -0
  47. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.public.d.ts +32 -0
  48. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.public.js +19 -0
  49. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.public.js.map +1 -0
  50. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.types.d.ts +1144 -0
  51. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.types.js +155 -0
  52. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.types.js.map +1 -0
  53. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.universal.d.ts +1228 -0
  54. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.universal.js +294 -0
  55. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.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-activation-logs-v1-activation-log-activation-log.context.d.ts +7 -0
  66. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.context.js +25 -0
  67. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.context.js.map +1 -0
  68. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.http.d.ts +11 -0
  69. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.http.js +176 -0
  70. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.http.js.map +1 -0
  71. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.meta.d.ts +17 -0
  72. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.meta.js +85 -0
  73. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.meta.js.map +1 -0
  74. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.public.d.ts +32 -0
  75. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.public.js +40 -0
  76. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.public.js.map +1 -0
  77. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.types.d.ts +1144 -0
  78. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.types.js +158 -0
  79. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.types.js.map +1 -0
  80. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.universal.d.ts +1228 -0
  81. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.universal.js +323 -0
  82. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.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-activation-logs-v1-activation-log-activation-log.context.d.ts +7 -0
  93. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.context.js +7 -0
  94. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.context.js.map +1 -0
  95. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.http.d.ts +11 -0
  96. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.http.js +170 -0
  97. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.http.js.map +1 -0
  98. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.meta.d.ts +17 -0
  99. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.meta.js +56 -0
  100. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.meta.js.map +1 -0
  101. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.public.d.ts +32 -0
  102. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.public.js +19 -0
  103. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.public.js.map +1 -0
  104. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.types.d.ts +1144 -0
  105. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.types.js +155 -0
  106. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.types.js.map +1 -0
  107. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.universal.d.ts +1228 -0
  108. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.universal.js +294 -0
  109. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -0,0 +1,1228 @@
1
+ export interface ActivationLog {
2
+ /**
3
+ * Activation ID
4
+ * @format GUID
5
+ */
6
+ _id?: string;
7
+ /**
8
+ * The activated automation ID
9
+ * @format GUID
10
+ */
11
+ automationId?: string;
12
+ /** The activated automation revision */
13
+ automationRevision?: string;
14
+ /** Automation activation status */
15
+ status?: Status;
16
+ /** Scheduled status additional info */
17
+ initiatedInfo?: InitiatedStatusInfo;
18
+ /** Scheduled status additional info */
19
+ scheduledInfo?: ScheduledStatusInfo;
20
+ /** Started status additional info */
21
+ startedInfo?: StartedStatusInfo;
22
+ /** Ended status additional info */
23
+ endedInfo?: EndedStatusInfo;
24
+ /** Cancelled status additional info */
25
+ cancelledInfo?: CancelledStatusInfo;
26
+ /** Failed status additional info */
27
+ failedInfo?: FailedStatusInfo;
28
+ /** Skipped status additional info */
29
+ skippedInfo?: SkippedStatusInfo;
30
+ /**
31
+ * Warnings information
32
+ * @maxSize 15
33
+ */
34
+ warnings?: Warning[];
35
+ /** Created date */
36
+ _createdDate?: Date | null;
37
+ }
38
+ export declare enum Target {
39
+ UNKNOWN_TARGET = "UNKNOWN_TARGET",
40
+ SCHEDULE = "SCHEDULE",
41
+ IMMEDIATE = "IMMEDIATE"
42
+ }
43
+ export declare enum CancellationReason {
44
+ UNKNOWN_CANCELLATION_REASON = "UNKNOWN_CANCELLATION_REASON",
45
+ /** Indicating that the activation was cancelled directly */
46
+ EVENT_CANCELLED = "EVENT_CANCELLED",
47
+ /** Indicating that the activation is cancelled because the automation was deactivated */
48
+ AUTOMATION_DEACTIVATED = "AUTOMATION_DEACTIVATED",
49
+ /** Indicating that the activation is cancelled because the automation was deleted */
50
+ AUTOMATION_DELETED = "AUTOMATION_DELETED",
51
+ /** Indicating that the activation is cancelled after the automation schedule time was reached */
52
+ CANCELLED_BY_REFRESH_PAYLOAD = "CANCELLED_BY_REFRESH_PAYLOAD",
53
+ /** Indicates that the activation was cancelled due to a UoU GDPR "Right to be Forgotten" request. */
54
+ CANCELLED_BY_GDPR_REQUEST = "CANCELLED_BY_GDPR_REQUEST"
55
+ }
56
+ export interface Identity {
57
+ /**
58
+ * User ID
59
+ * @format GUID
60
+ */
61
+ userId?: string | null;
62
+ /**
63
+ * App ID
64
+ * @format GUID
65
+ */
66
+ appId?: string | null;
67
+ }
68
+ export declare enum ErrorReason {
69
+ /** Unexpected error reason */
70
+ UNEXPECTED_ERROR_REASON = "UNEXPECTED_ERROR_REASON",
71
+ /** Failed to evaluate the schedule date expression */
72
+ SCHEDULE_DATE_EVALUATION_FAILED = "SCHEDULE_DATE_EVALUATION_FAILED"
73
+ }
74
+ export declare enum SkipReason {
75
+ UNKNOWN_SKIP_REASON = "UNKNOWN_SKIP_REASON",
76
+ /** Activation was skipped because the scheduled execution time had already passed at the time of execution */
77
+ SCHEDULE_DATE_EXPIRED = "SCHEDULE_DATE_EXPIRED",
78
+ /** Activation was skipped because the trigger filters defined in the automation did not match the payload. */
79
+ TRIGGER_FILTERS_NOT_PASSED = "TRIGGER_FILTERS_NOT_PASSED",
80
+ /** Activation was skipped because it exceeded the configured rate limit (maximum number of executions allowed in a time period). */
81
+ RATE_LIMIT_EXCEEDED = "RATE_LIMIT_EXCEEDED",
82
+ /** Activation was skipped because an event with the same idempotency key was already processed. */
83
+ EVENT_ALREADY_PROCESSED = "EVENT_ALREADY_PROCESSED"
84
+ }
85
+ export declare enum Status {
86
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
87
+ /** This indicates activation is not started yet (no action has run yet) */
88
+ INITIATED = "INITIATED",
89
+ /** 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) */
90
+ SCHEDULED = "SCHEDULED",
91
+ /** This indicates the automation activation has started and currently in progress */
92
+ STARTED = "STARTED",
93
+ /** This indicates all the automation actions were handled either by invoking them, skipping them etc. */
94
+ ENDED = "ENDED",
95
+ /** This indicates the activation was cancelled */
96
+ CANCELLED = "CANCELLED",
97
+ /**
98
+ * This indicates the activation failed to start
99
+ * Note that failure in the activation of a single action will not result a failure in activation of the entire automation
100
+ */
101
+ FAILED = "FAILED",
102
+ /**
103
+ * Indicates that the automation activation was skipped without executing any actions.
104
+ * Note that an activation will either be skipped immediately or move to INITIATED state.
105
+ */
106
+ SKIPPED = "SKIPPED"
107
+ }
108
+ export interface InitiatedStatusInfo {
109
+ /** Created date */
110
+ statusChangedDate?: Date | null;
111
+ /** Target */
112
+ target?: Target;
113
+ /** The reported trigger payload */
114
+ payload?: Record<string, any> | null;
115
+ /**
116
+ * External entity ID
117
+ * @maxLength 40
118
+ */
119
+ externalEntityId?: string | null;
120
+ /**
121
+ * Unique identifier for the request that initiated the automation
122
+ * @maxLength 100
123
+ */
124
+ requestId?: string | null;
125
+ }
126
+ export interface ScheduledStatusInfo {
127
+ /** Created date */
128
+ statusChangedDate?: Date | null;
129
+ /**
130
+ * Schedule identifier
131
+ * @format GUID
132
+ */
133
+ scheduleId?: string;
134
+ /** Indicating when the activation should start */
135
+ date?: Date | null;
136
+ }
137
+ export interface StartedStatusInfo {
138
+ /** Created date */
139
+ statusChangedDate?: Date | null;
140
+ /** Enriched and refreshed payload */
141
+ payload?: Record<string, any> | null;
142
+ }
143
+ export interface EndedStatusInfo {
144
+ /** Created date */
145
+ statusChangedDate?: Date | null;
146
+ /** Indicates if the activation failed with errors in one or more actions. Actions that failed but eventually ended are not included */
147
+ withFailedActions?: boolean | null;
148
+ }
149
+ export interface CancelledStatusInfo {
150
+ /** Created date */
151
+ statusChangedDate?: Date | null;
152
+ /** Cancellation reason */
153
+ reason?: CancellationReason;
154
+ /** The identity (such as user, app etc.) that caused the cancellation */
155
+ initiator?: Identity;
156
+ }
157
+ export interface FailedStatusInfo {
158
+ /** Created date */
159
+ statusChangedDate?: Date | null;
160
+ /**
161
+ * Error description
162
+ * @maxLength 1000
163
+ * @readonly
164
+ */
165
+ errorDescription?: string;
166
+ /**
167
+ * Error code
168
+ * @maxLength 20
169
+ */
170
+ errorCode?: string | null;
171
+ /** Error reason */
172
+ errorReason?: ErrorReason;
173
+ /** Event payload */
174
+ payload?: Record<string, any> | null;
175
+ /**
176
+ * External entity ID
177
+ * @maxLength 40
178
+ */
179
+ externalEntityId?: string | null;
180
+ /**
181
+ * Unique identifier for the request that initiated the automation
182
+ * @maxLength 100
183
+ */
184
+ requestId?: string | null;
185
+ }
186
+ export interface SkippedStatusInfo {
187
+ /** Created date */
188
+ statusChangedDate?: Date | null;
189
+ /** The reason why the automation activation was skipped */
190
+ reason?: SkipReason;
191
+ /** The reported trigger payload */
192
+ payload?: Record<string, any> | null;
193
+ /**
194
+ * External entity ID
195
+ * @maxLength 40
196
+ */
197
+ externalEntityId?: string | null;
198
+ /**
199
+ * Unique identifier for the request that initiated the automation
200
+ * @maxLength 100
201
+ */
202
+ requestId?: string | null;
203
+ }
204
+ export interface Warning {
205
+ /** Event date */
206
+ warningDate?: Date | null;
207
+ /**
208
+ * Detailed description of what caused the warning
209
+ * @maxLength 1000
210
+ * @readonly
211
+ */
212
+ errorDescription?: string;
213
+ /**
214
+ * Error code of what caused the warning
215
+ * @maxLength 20
216
+ * @readonly
217
+ */
218
+ errorCode?: string | null;
219
+ /** The reason for the warning */
220
+ reason?: WarningReason;
221
+ }
222
+ export declare enum WarningReason {
223
+ UNKNOWN_WARNING_REASON = "UNKNOWN_WARNING_REASON",
224
+ /** Failed to enrich payload with studio site enrichment */
225
+ STUDIO_SITE_ENRICHMENT_FAILED = "STUDIO_SITE_ENRICHMENT_FAILED",
226
+ /** Failed to refresh payload data */
227
+ REFRESH_PAYLOAD_FAILED = "REFRESH_PAYLOAD_FAILED",
228
+ /** Failed to retrieve contact information */
229
+ GET_CONTACT_ENRICHMENT_FAILED = "GET_CONTACT_ENRICHMENT_FAILED",
230
+ /** Failed to retrieve member information */
231
+ GET_MEMBER_ENRICHMENT_FAILED = "GET_MEMBER_ENRICHMENT_FAILED"
232
+ }
233
+ export interface DomainEvent extends DomainEventBodyOneOf {
234
+ createdEvent?: EntityCreatedEvent;
235
+ updatedEvent?: EntityUpdatedEvent;
236
+ deletedEvent?: EntityDeletedEvent;
237
+ actionEvent?: ActionEvent;
238
+ /**
239
+ * Unique event ID.
240
+ * Allows clients to ignore duplicate webhooks.
241
+ */
242
+ _id?: string;
243
+ /**
244
+ * Assumes actions are also always typed to an entity_type
245
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
246
+ */
247
+ entityFqdn?: string;
248
+ /**
249
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
250
+ * This is although the created/updated/deleted notion is duplication of the oneof types
251
+ * Example: created/updated/deleted/started/completed/email_opened
252
+ */
253
+ slug?: string;
254
+ /** ID of the entity associated with the event. */
255
+ entityId?: string;
256
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
257
+ eventTime?: Date | null;
258
+ /**
259
+ * Whether the event was triggered as a result of a privacy regulation application
260
+ * (for example, GDPR).
261
+ */
262
+ triggeredByAnonymizeRequest?: boolean | null;
263
+ /** If present, indicates the action that triggered the event. */
264
+ originatedFrom?: string | null;
265
+ /**
266
+ * A sequence number defining the order of updates to the underlying entity.
267
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
268
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
269
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
270
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
271
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
272
+ */
273
+ entityEventSequence?: string | null;
274
+ }
275
+ /** @oneof */
276
+ export interface DomainEventBodyOneOf {
277
+ createdEvent?: EntityCreatedEvent;
278
+ updatedEvent?: EntityUpdatedEvent;
279
+ deletedEvent?: EntityDeletedEvent;
280
+ actionEvent?: ActionEvent;
281
+ }
282
+ export interface EntityCreatedEvent {
283
+ entity?: string;
284
+ }
285
+ export interface RestoreInfo {
286
+ deletedDate?: Date | null;
287
+ }
288
+ export interface EntityUpdatedEvent {
289
+ /**
290
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
291
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
292
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
293
+ */
294
+ currentEntity?: string;
295
+ }
296
+ export interface EntityDeletedEvent {
297
+ /** Entity that was deleted */
298
+ deletedEntity?: string | null;
299
+ }
300
+ export interface ActionEvent {
301
+ body?: string;
302
+ }
303
+ export interface Empty {
304
+ }
305
+ export interface ActivationContinuedAfterSchedule {
306
+ /**
307
+ * Activation identifier
308
+ * @format GUID
309
+ */
310
+ _id?: string;
311
+ /** Activation Automation */
312
+ automation?: Automation;
313
+ }
314
+ export interface Automation extends AutomationOriginInfoOneOf {
315
+ /** Application info */
316
+ applicationInfo?: ApplicationOrigin;
317
+ /** Preinstalled info */
318
+ preinstalledInfo?: PreinstalledOrigin;
319
+ /**
320
+ * Automation ID.
321
+ * @format GUID
322
+ * @readonly
323
+ */
324
+ _id?: string | null;
325
+ /**
326
+ * Revision number, which increments by 1 each time the automation is updated.
327
+ * To prevent conflicting changes,
328
+ * the current revision must be passed when updating the automation.
329
+ *
330
+ * Ignored when creating an automation.
331
+ * @readonly
332
+ */
333
+ revision?: string | null;
334
+ /**
335
+ * Information about the creator of the automation.
336
+ * @immutable
337
+ * @readonly
338
+ */
339
+ createdBy?: AuditInfo;
340
+ /**
341
+ * Date and time the automation was created.
342
+ * @readonly
343
+ */
344
+ _createdDate?: Date | null;
345
+ /**
346
+ * The entity that last updated the automation.
347
+ * @readonly
348
+ */
349
+ updatedBy?: AuditInfo;
350
+ /**
351
+ * Date and time the automation was last updated.
352
+ * @readonly
353
+ */
354
+ _updatedDate?: Date | null;
355
+ /**
356
+ * Automation name that is displayed on the user's site.
357
+ * @minLength 1
358
+ * @maxLength 500
359
+ */
360
+ name?: string;
361
+ /**
362
+ * Automation description.
363
+ * @maxLength 2000
364
+ */
365
+ description?: string | null;
366
+ /** Object that defines the automation's trigger, actions, and activation status. */
367
+ configuration?: AutomationConfiguration;
368
+ /**
369
+ * Defines how the automation was added to the site.
370
+ * @immutable
371
+ */
372
+ origin?: Origin;
373
+ /** Automation settings. */
374
+ settings?: AutomationSettings;
375
+ /**
376
+ * Draft info (optional - only if the automation is a draft)
377
+ * @readonly
378
+ */
379
+ draftInfo?: DraftInfo;
380
+ /**
381
+ * Namespace
382
+ * @maxLength 50
383
+ */
384
+ namespace?: string | null;
385
+ /** Extended Fields */
386
+ extendedFields?: ExtendedFields;
387
+ }
388
+ /** @oneof */
389
+ export interface AutomationOriginInfoOneOf {
390
+ /** Application info */
391
+ applicationInfo?: ApplicationOrigin;
392
+ /** Preinstalled info */
393
+ preinstalledInfo?: PreinstalledOrigin;
394
+ }
395
+ export interface ActionSettings {
396
+ /**
397
+ * List of actions that cannot be deleted.
398
+ * Default: Empty. All actions are deletable by default.
399
+ * @maxSize 30
400
+ * @format GUID
401
+ */
402
+ permanentActionIds?: string[];
403
+ /**
404
+ * List of actions that cannot be edited.
405
+ * Default: Empty. All actions are editable by default.
406
+ * @maxSize 30
407
+ * @format GUID
408
+ */
409
+ readonlyActionIds?: string[];
410
+ /** Whether the option to add a delay is disabled for the automation. */
411
+ disableDelayAddition?: boolean;
412
+ /** Whether the option to add a condition is disabled for the automation. */
413
+ disableConditionAddition?: boolean;
414
+ }
415
+ export declare enum Domain {
416
+ /** User domain (default). */
417
+ USER = "USER",
418
+ /** Wix domain. */
419
+ WIX = "WIX"
420
+ }
421
+ export interface Enrichment {
422
+ /**
423
+ * Enrichment input mappings.
424
+ * @maxSize 2
425
+ */
426
+ inputMappings?: Record<string, any>[] | null;
427
+ }
428
+ export interface AuditInfo extends AuditInfoIdOneOf {
429
+ /**
430
+ * User ID.
431
+ * @format GUID
432
+ */
433
+ userId?: string;
434
+ /**
435
+ * Application ID.
436
+ * @format GUID
437
+ */
438
+ appId?: string;
439
+ }
440
+ /** @oneof */
441
+ export interface AuditInfoIdOneOf {
442
+ /**
443
+ * User ID.
444
+ * @format GUID
445
+ */
446
+ userId?: string;
447
+ /**
448
+ * Application ID.
449
+ * @format GUID
450
+ */
451
+ appId?: string;
452
+ }
453
+ /** Automation runtime configuration */
454
+ export interface AutomationConfiguration {
455
+ /** Status of the automation on the site. */
456
+ status?: AutomationConfigurationStatus;
457
+ /** Automation trigger configuration. */
458
+ trigger?: Trigger;
459
+ /**
460
+ * 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.
461
+ * @maxSize 20
462
+ * @format GUID
463
+ */
464
+ rootActionIds?: string[];
465
+ /**
466
+ * Map of all actions that the automation may execute.
467
+ * The key is the action ID, and the value is the action configuration.
468
+ */
469
+ actions?: Record<string, Action>;
470
+ }
471
+ export declare enum TimeUnit {
472
+ UNKNOWN_TIME_UNIT = "UNKNOWN_TIME_UNIT",
473
+ MINUTES = "MINUTES",
474
+ HOURS = "HOURS",
475
+ DAYS = "DAYS",
476
+ WEEKS = "WEEKS",
477
+ MONTHS = "MONTHS"
478
+ }
479
+ export interface Filter {
480
+ /**
481
+ * Filter ID.
482
+ * @format GUID
483
+ */
484
+ _id?: string;
485
+ /**
486
+ * Field key from the payload schema, for example "formId".
487
+ * @minLength 1
488
+ * @maxLength 110
489
+ */
490
+ fieldKey?: string;
491
+ /**
492
+ * Filter expression that evaluates to a boolean.
493
+ * @maxLength 2500
494
+ */
495
+ filterExpression?: string;
496
+ }
497
+ export interface FutureDateActivationOffset {
498
+ /**
499
+ * The offset value. The value is always taken as negative, so that the automation runs before the trigger date.
500
+ * To create an offset that causes the automation to run after the trigger date, use a delay action.
501
+ * @maxLength 1000
502
+ */
503
+ preScheduledEventOffsetExpression?: string;
504
+ /** Time unit for the scheduled event offset. */
505
+ scheduledEventOffsetTimeUnit?: TimeUnit;
506
+ }
507
+ export interface RateLimit {
508
+ /**
509
+ * Value expressing the maximum number of times the trigger can be activated.
510
+ * @maxLength 1000
511
+ */
512
+ maxActivationsExpression?: string;
513
+ /**
514
+ * Duration of the rate limiting window in the selected time unit. If no value is set, the rate limit is permanent.
515
+ * @maxLength 1000
516
+ */
517
+ durationExpression?: string | null;
518
+ /** Time unit for the rate limit duration. */
519
+ durationTimeUnit?: TimeUnit;
520
+ /**
521
+ * Unique identifier of each activation, by which rate limiter will count activations.
522
+ * @minLength 1
523
+ * @maxLength 400
524
+ */
525
+ uniqueIdentifierExpression?: string | null;
526
+ }
527
+ export interface FilterValueSelection {
528
+ /**
529
+ * Values that can help the user filter certain automations, values will look like "<filter_id>__<selected_value>"
530
+ * @maxLength 80
531
+ * @maxSize 50
532
+ */
533
+ selectedFilterValues?: string[];
534
+ }
535
+ export interface ConditionExpressionGroup {
536
+ /** Expression group operator. */
537
+ operator?: Operator;
538
+ /**
539
+ * List of boolean expressions to be evaluated with the given operator.
540
+ * @minSize 1
541
+ * @maxSize 20
542
+ * @maxLength 2500
543
+ */
544
+ booleanExpressions?: string[];
545
+ }
546
+ export declare enum Operator {
547
+ UNKNOWN_OPERATOR = "UNKNOWN_OPERATOR",
548
+ OR = "OR",
549
+ AND = "AND"
550
+ }
551
+ export declare enum Type {
552
+ /** Automation will be triggered according to the trigger configuration. */
553
+ UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
554
+ /** App defined Action. */
555
+ APP_DEFINED = "APP_DEFINED",
556
+ /** Condition Action. */
557
+ CONDITION = "CONDITION",
558
+ /** Delay Action. */
559
+ DELAY = "DELAY",
560
+ /** RateLimit Action. */
561
+ RATE_LIMIT = "RATE_LIMIT",
562
+ /** Set Variables Action. */
563
+ SET_VARIABLES = "SET_VARIABLES",
564
+ /** Output Action. */
565
+ OUTPUT = "OUTPUT"
566
+ }
567
+ export interface AppDefinedAction {
568
+ /**
569
+ * ID of the app that defines the action.
570
+ * @format GUID
571
+ */
572
+ appId?: string;
573
+ /**
574
+ * Action key.
575
+ * @minLength 1
576
+ * @maxLength 100
577
+ */
578
+ actionKey?: string;
579
+ /** Action input mapping. */
580
+ inputMapping?: Record<string, any> | null;
581
+ /**
582
+ * Array of conditions determining whether to skip the action in the automation flow.
583
+ * The action will be skipped if any of the expression groups evaluate to `true`.
584
+ * Actions following a skipped action will still run.
585
+ * @maxSize 10
586
+ */
587
+ skipConditionOrExpressionGroups?: ConditionExpressionGroup[];
588
+ /**
589
+ * List of IDs of actions to run in parallel once the action completes.
590
+ * @maxSize 20
591
+ * @format GUID
592
+ */
593
+ postActionIds?: string[];
594
+ /** Optional output schema of the action. It will be used instead the action schema in case it's provided. */
595
+ overrideOutputSchema?: Record<string, any> | null;
596
+ }
597
+ export interface ConditionAction {
598
+ /**
599
+ * The condition evaluates to `true` if either of the expression groups evaluate to `true`.
600
+ * @minSize 1
601
+ * @maxSize 10
602
+ */
603
+ orExpressionGroups?: ConditionExpressionGroup[];
604
+ /**
605
+ * List of IDs of actions to run when the entire condition is evaluated to `true`.
606
+ * @maxSize 20
607
+ * @format GUID
608
+ */
609
+ truePostActionIds?: string[];
610
+ /**
611
+ * List of IDs of actions to run when the entire condition is evaluated to `false`.
612
+ * @maxSize 20
613
+ * @format GUID
614
+ */
615
+ falsePostActionIds?: string[];
616
+ }
617
+ export interface DelayAction {
618
+ /**
619
+ * Value expressing the amount of time to wait from a specific date or from the time the action is executed.
620
+ * @maxLength 1000
621
+ */
622
+ offsetExpression?: string | null;
623
+ /** Time unit for delay offset. */
624
+ offsetTimeUnit?: TimeUnit;
625
+ /**
626
+ * The action due date. If defined without an offset, the automation will wait until this date to execute the next step.
627
+ * If an offset is defined, it's calculated from this date.
628
+ * The date is expressed in the number of milliseconds since the Unix Epoch (1 January, 1970 UTC).
629
+ * @maxLength 1000
630
+ */
631
+ dueDateEpochExpression?: string | null;
632
+ /**
633
+ * List of IDs of actions to run in parallel after the delay.
634
+ * @maxSize 20
635
+ * @format GUID
636
+ */
637
+ postActionIds?: string[];
638
+ }
639
+ export interface RateLimitAction {
640
+ /**
641
+ * The maximum number of activations allowed for the action.
642
+ * @maxLength 1000
643
+ */
644
+ maxActivationsExpression?: string;
645
+ /**
646
+ * Duration of the rate limiting window, expressed in selected time unit.
647
+ * If no value is set, then there is no time limit on the rate limiter.
648
+ * @maxLength 1000
649
+ */
650
+ rateLimitDurationExpression?: string | null;
651
+ /** Time unit for the rate limit duration. */
652
+ rateLimitDurationTimeUnit?: TimeUnit;
653
+ /**
654
+ * Unique identifier of each activation by which rate limiter counts activations.
655
+ * @minLength 1
656
+ * @maxLength 400
657
+ */
658
+ uniqueIdentifierExpression?: string | null;
659
+ /**
660
+ * List of IDs of actions to run in parallel once the action completes.
661
+ * @maxSize 20
662
+ * @format GUID
663
+ */
664
+ postActionIds?: string[];
665
+ }
666
+ export interface SetVariablesAction {
667
+ /**
668
+ * output mapping
669
+ * for example: {"someField": "{{10}}", "someOtherField": "{{multiply( var('account.points.balance') ;2 )}}" }
670
+ */
671
+ outputMapping?: Record<string, any> | null;
672
+ /**
673
+ * output json schema representation
674
+ * could be string instead of Struct (and introduce some compression to minimize the size of it)
675
+ */
676
+ outputSchema?: Record<string, any> | null;
677
+ /**
678
+ * List of IDs of actions to run in parallel after variable initialization.
679
+ * @maxSize 20
680
+ * @format GUID
681
+ */
682
+ postActionIds?: string[];
683
+ }
684
+ export interface OutputAction {
685
+ /** Output action output mapping. */
686
+ outputMapping?: Record<string, any> | null;
687
+ }
688
+ export declare enum AutomationConfigurationStatus {
689
+ /** unused */
690
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
691
+ /** Automation will be triggered according to the trigger configuration */
692
+ ACTIVE = "ACTIVE",
693
+ /** Automation will not be triggered */
694
+ INACTIVE = "INACTIVE"
695
+ }
696
+ export interface Trigger {
697
+ /**
698
+ * ID of the app that defines the trigger.
699
+ * @format GUID
700
+ */
701
+ appId?: string;
702
+ /**
703
+ * Trigger key.
704
+ * @minLength 1
705
+ * @maxLength 100
706
+ */
707
+ triggerKey?: string;
708
+ /**
709
+ * List of filters on schema fields.
710
+ * In order for the automation to run, all filter expressions must evaluate to `true` for a given payload.
711
+ * @maxSize 5
712
+ */
713
+ filters?: Filter[];
714
+ /** Defines the time offset between the trigger date and when the automation runs. */
715
+ scheduledEventOffset?: FutureDateActivationOffset;
716
+ /** Limits the number of times an automation can be triggered. */
717
+ rateLimit?: RateLimit;
718
+ /**
719
+ * An optional configuration, per automation, of a schema that is optionally offered by the trigger provider to affect the behavior of the trigger.
720
+ * 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,
721
+ * He would define a schema with a field called "startDate" and using this parameter the user can define his preferred startDate, per automation.
722
+ */
723
+ automationConfigMapping?: Record<string, any> | null;
724
+ /** Optional schema of the trigger. It will be used instead the trigger schema in case it's provided. */
725
+ overrideSchema?: Record<string, any> | null;
726
+ }
727
+ export interface Action extends ActionInfoOneOf {
728
+ /** Action defined by an app (via RPC, HTTP or Velo). */
729
+ appDefinedInfo?: AppDefinedAction;
730
+ /** Condition action. */
731
+ conditionInfo?: ConditionAction;
732
+ /** Delay action. */
733
+ delayInfo?: DelayAction;
734
+ /** Rate-limiting action. */
735
+ rateLimitInfo?: RateLimitAction;
736
+ /**
737
+ * Action ID. If not specified, a new ID is generated.
738
+ * @format GUID
739
+ */
740
+ _id?: string | null;
741
+ /** Action type. */
742
+ type?: Type;
743
+ /**
744
+ * Human-readable name to differentiate the action from other actions of the same type.
745
+ * The name can contain only alphanumeric characters and underscores. If not provided, a namespace in the form `actionkey-indexOfAction` is
746
+ * generated automatically.
747
+ * If the action has output, the output will be available in the payload under this name.
748
+ * If the user has multiple actions with the same appId and actionKey, previous action output will be overwritten.
749
+ * @minLength 1
750
+ * @maxLength 100
751
+ */
752
+ namespace?: string | null;
753
+ }
754
+ /** @oneof */
755
+ export interface ActionInfoOneOf {
756
+ /** Action defined by an app (via RPC, HTTP or Velo). */
757
+ appDefinedInfo?: AppDefinedAction;
758
+ /** Condition action. */
759
+ conditionInfo?: ConditionAction;
760
+ /** Delay action. */
761
+ delayInfo?: DelayAction;
762
+ /** Rate-limiting action. */
763
+ rateLimitInfo?: RateLimitAction;
764
+ }
765
+ export interface FilterableAppDefinedActions {
766
+ /**
767
+ * App defined action identifiers, each identifier in form `${appId}_${actionKey}`
768
+ * @minSize 1
769
+ * @maxSize 100
770
+ * @minLength 1
771
+ * @maxLength 150
772
+ */
773
+ actionIdentifiers?: string[];
774
+ }
775
+ export declare enum Origin {
776
+ /** Default value. This is unused. */
777
+ UNKNOWN_ORIGIN = "UNKNOWN_ORIGIN",
778
+ /** User created automation. */
779
+ USER = "USER",
780
+ /** Automation created by application (site specific). */
781
+ APPLICATION = "APPLICATION",
782
+ /** Preinstalled application automation. */
783
+ PREINSTALLED = "PREINSTALLED",
784
+ /** Automation created from a recipe. */
785
+ RECIPE = "RECIPE"
786
+ }
787
+ export interface ApplicationOrigin {
788
+ /**
789
+ * Application ID.
790
+ * @format GUID
791
+ */
792
+ appId?: string;
793
+ /**
794
+ * External ID to correlate multiple sites to an automation
795
+ * @format GUID
796
+ */
797
+ appDefinedExternalId?: string | null;
798
+ }
799
+ export interface PreinstalledOrigin {
800
+ /**
801
+ * ID of the app that defines the preinstalled automation.
802
+ * @format GUID
803
+ */
804
+ appId?: string;
805
+ /**
806
+ * Application component ID.
807
+ * @format GUID
808
+ */
809
+ componentId?: string;
810
+ /** Application component version. */
811
+ componentVersion?: number;
812
+ /**
813
+ * Whether the automation is an override automation. If the user modifies the preinstalled automation installed on their site, a site-specific
814
+ * automation is created that overrides the original one. If the user makes no modifications this boolean is set to `false` and the original
815
+ * preinstalled automation is used.
816
+ *
817
+ * Default: `false`
818
+ * @immutable
819
+ * @readonly
820
+ */
821
+ override?: boolean | null;
822
+ }
823
+ export interface AutomationSettings {
824
+ /**
825
+ * Whether the automation is hidden from users.
826
+ * Default: `false`
827
+ */
828
+ hidden?: boolean;
829
+ /**
830
+ * Whether the automation is read-only.
831
+ * Default: `false`
832
+ */
833
+ readonly?: boolean;
834
+ /**
835
+ * Whether the option to delete the automation from the site is disabled.
836
+ * Default: `false`
837
+ */
838
+ disableDelete?: boolean;
839
+ /**
840
+ * Whether the option to change the automation status (from active to inactive and vice versa) is disabled.
841
+ * Default: `false`
842
+ */
843
+ disableStatusChange?: boolean;
844
+ /** Automation action settings. */
845
+ actionSettings?: ActionSettings;
846
+ }
847
+ export interface DraftInfo {
848
+ /**
849
+ * Optional - automationId of the original automation.
850
+ * @format GUID
851
+ * @readonly
852
+ */
853
+ originalAutomationId?: string | null;
854
+ }
855
+ export interface Enrichments {
856
+ /** Whether the studio site enrichment is wanted. */
857
+ studioSite?: Enrichment;
858
+ }
859
+ export interface ExtendedFields {
860
+ /**
861
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
862
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
863
+ *
864
+ * You can only access fields for which you have the appropriate permissions.
865
+ *
866
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
867
+ */
868
+ namespaces?: Record<string, Record<string, any>>;
869
+ }
870
+ export interface UouDeleteRequest {
871
+ /** Original UouRightToBeDeletedRequest request */
872
+ originalRequest?: Record<string, any> | null;
873
+ /**
874
+ * Found client ids
875
+ * @maxSize 100
876
+ */
877
+ foundClientEntityIdsByNamespace?: ClientEntityIdsByNamespace[];
878
+ }
879
+ export interface ClientEntityIdsByNamespace {
880
+ /**
881
+ * Client namespace
882
+ * @minLength 5
883
+ * @maxLength 50
884
+ */
885
+ namespace?: string;
886
+ /**
887
+ * Client entity IDs
888
+ * @minLength 5
889
+ * @maxLength 50
890
+ * @maxSize 100
891
+ */
892
+ clientEntityIds?: string[];
893
+ }
894
+ export interface GetActivationLogRequest {
895
+ /**
896
+ * Activation log ID
897
+ * @format GUID
898
+ */
899
+ activationId: string;
900
+ }
901
+ export interface GetActivationLogResponse {
902
+ /** Activation log */
903
+ activationLog?: ActivationLog;
904
+ }
905
+ export interface ListActivationLogsRequest extends ListActivationLogsRequestIdentifierOneOf {
906
+ /** Look up activations by automation id */
907
+ automationIdInfo?: AutomationIdInfo;
908
+ /** Look up activations by preinstalled identifier */
909
+ preinstalledIdentifierInfo?: PreinstalledIdentifierInfo;
910
+ /** From created date, If not specified, defaults to 30 days before the current time. */
911
+ fromCreatedDate?: Date | null;
912
+ /** To created date, If not specified, defaults to current time. */
913
+ toCreatedDate?: Date | null;
914
+ /** Paging */
915
+ cursorPaging?: CursorPaging;
916
+ /** Should return payload in the response */
917
+ includePayload?: boolean | null;
918
+ /** identifier type for the activations to list */
919
+ identifierType?: IdentifierType;
920
+ }
921
+ /** @oneof */
922
+ export interface ListActivationLogsRequestIdentifierOneOf {
923
+ /** Look up activations by automation id */
924
+ automationIdInfo?: AutomationIdInfo;
925
+ /** Look up activations by preinstalled identifier */
926
+ preinstalledIdentifierInfo?: PreinstalledIdentifierInfo;
927
+ }
928
+ export interface CursorPaging {
929
+ /**
930
+ * Maximum number of items to return in the results.
931
+ * @max 500
932
+ */
933
+ limit?: number | null;
934
+ /**
935
+ * Pointer to the next or previous page in the list of results.
936
+ *
937
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
938
+ * Not relevant for the first request.
939
+ * @maxLength 16000
940
+ */
941
+ cursor?: string | null;
942
+ }
943
+ /** Type of identifier used to look up activation logs */
944
+ export declare enum IdentifierType {
945
+ UNKNOWN_TYPE = "UNKNOWN_TYPE"
946
+ }
947
+ export interface AutomationIdInfo {
948
+ /**
949
+ * Automation ID
950
+ * @format GUID
951
+ */
952
+ automationId?: string;
953
+ }
954
+ export interface PreinstalledIdentifierInfo {
955
+ /**
956
+ * ID of the app that defines the preinstalled automation.
957
+ * @format GUID
958
+ */
959
+ appId?: string;
960
+ /**
961
+ * Application component ID.
962
+ * @format GUID
963
+ */
964
+ componentId?: string;
965
+ }
966
+ export interface ListActivationLogsResponse {
967
+ /** List of activation logs */
968
+ activationLogs?: ActivationLog[];
969
+ /** Paging metadata */
970
+ pagingMetadata?: CursorPagingMetadata;
971
+ }
972
+ export interface CursorPagingMetadata {
973
+ /** Number of items returned in the response. */
974
+ count?: number | null;
975
+ /** Cursor string that point to the next page */
976
+ cursors?: Cursors;
977
+ /**
978
+ * Whether there are more pages to retrieve following the current page.
979
+ *
980
+ * + `true`: Another page of results can be retrieved.
981
+ * + `false`: This is the last page.
982
+ */
983
+ hasNext?: boolean | null;
984
+ }
985
+ export interface Cursors {
986
+ /**
987
+ * Cursor string pointing to the next page in the list of results.
988
+ * @maxLength 16000
989
+ */
990
+ next?: string | null;
991
+ }
992
+ export interface SearchActivationLogsByPayloadPiiValueRequest extends SearchActivationLogsByPayloadPiiValueRequestFilterOptionOneOf {
993
+ /** Filter activations by value and automation id */
994
+ automationIdInfo?: AutomationIdInfo;
995
+ /** Filter activations by value and preinstalled */
996
+ preinstalledIdentifierInfo?: PreinstalledIdentifierInfo;
997
+ /**
998
+ * Value to search in the payload
999
+ * @minLength 1
1000
+ * @maxLength 50
1001
+ */
1002
+ value: string;
1003
+ /** Paging */
1004
+ cursorPaging?: CursorPaging;
1005
+ /** Should return payload in the response */
1006
+ includePayload?: boolean | null;
1007
+ /** Filter by */
1008
+ filterBy?: FilterBy;
1009
+ /** From created date */
1010
+ fromCreatedDate?: Date | null;
1011
+ /** To created date */
1012
+ toCreatedDate?: Date | null;
1013
+ }
1014
+ /** @oneof */
1015
+ export interface SearchActivationLogsByPayloadPiiValueRequestFilterOptionOneOf {
1016
+ /** Filter activations by value and automation id */
1017
+ automationIdInfo?: AutomationIdInfo;
1018
+ /** Filter activations by value and preinstalled */
1019
+ preinstalledIdentifierInfo?: PreinstalledIdentifierInfo;
1020
+ }
1021
+ /** FilterBy */
1022
+ export declare enum FilterBy {
1023
+ UNKNOWN_TYPE = "UNKNOWN_TYPE"
1024
+ }
1025
+ export interface SearchActivationLogsByPayloadPiiValueResponse {
1026
+ /** List of activation logs */
1027
+ activationLogs?: ActivationLog[];
1028
+ /** Paging metadata */
1029
+ pagingMetadata?: CursorPagingMetadata;
1030
+ }
1031
+ export interface MessageEnvelope {
1032
+ /**
1033
+ * App instance ID.
1034
+ * @format GUID
1035
+ */
1036
+ instanceId?: string | null;
1037
+ /**
1038
+ * Event type.
1039
+ * @maxLength 150
1040
+ */
1041
+ eventType?: string;
1042
+ /** The identification type and identity data. */
1043
+ identity?: IdentificationData;
1044
+ /** Stringify payload. */
1045
+ data?: string;
1046
+ }
1047
+ export interface IdentificationData extends IdentificationDataIdOneOf {
1048
+ /**
1049
+ * ID of a site visitor that has not logged in to the site.
1050
+ * @format GUID
1051
+ */
1052
+ anonymousVisitorId?: string;
1053
+ /**
1054
+ * ID of a site visitor that has logged in to the site.
1055
+ * @format GUID
1056
+ */
1057
+ memberId?: string;
1058
+ /**
1059
+ * ID of a Wix user (site owner, contributor, etc.).
1060
+ * @format GUID
1061
+ */
1062
+ wixUserId?: string;
1063
+ /**
1064
+ * ID of an app.
1065
+ * @format GUID
1066
+ */
1067
+ appId?: string;
1068
+ /** @readonly */
1069
+ identityType?: WebhookIdentityType;
1070
+ }
1071
+ /** @oneof */
1072
+ export interface IdentificationDataIdOneOf {
1073
+ /**
1074
+ * ID of a site visitor that has not logged in to the site.
1075
+ * @format GUID
1076
+ */
1077
+ anonymousVisitorId?: string;
1078
+ /**
1079
+ * ID of a site visitor that has logged in to the site.
1080
+ * @format GUID
1081
+ */
1082
+ memberId?: string;
1083
+ /**
1084
+ * ID of a Wix user (site owner, contributor, etc.).
1085
+ * @format GUID
1086
+ */
1087
+ wixUserId?: string;
1088
+ /**
1089
+ * ID of an app.
1090
+ * @format GUID
1091
+ */
1092
+ appId?: string;
1093
+ }
1094
+ export declare enum WebhookIdentityType {
1095
+ UNKNOWN = "UNKNOWN",
1096
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1097
+ MEMBER = "MEMBER",
1098
+ WIX_USER = "WIX_USER",
1099
+ APP = "APP"
1100
+ }
1101
+ interface InitiatedStatusInfoNonNullableFields {
1102
+ target: Target;
1103
+ }
1104
+ interface ScheduledStatusInfoNonNullableFields {
1105
+ scheduleId: string;
1106
+ }
1107
+ interface CancelledStatusInfoNonNullableFields {
1108
+ reason: CancellationReason;
1109
+ }
1110
+ interface FailedStatusInfoNonNullableFields {
1111
+ errorDescription: string;
1112
+ errorReason: ErrorReason;
1113
+ }
1114
+ interface SkippedStatusInfoNonNullableFields {
1115
+ reason: SkipReason;
1116
+ }
1117
+ interface WarningNonNullableFields {
1118
+ errorDescription: string;
1119
+ reason: WarningReason;
1120
+ }
1121
+ export interface ActivationLogNonNullableFields {
1122
+ _id: string;
1123
+ automationId: string;
1124
+ automationRevision: string;
1125
+ status: Status;
1126
+ initiatedInfo?: InitiatedStatusInfoNonNullableFields;
1127
+ scheduledInfo?: ScheduledStatusInfoNonNullableFields;
1128
+ cancelledInfo?: CancelledStatusInfoNonNullableFields;
1129
+ failedInfo?: FailedStatusInfoNonNullableFields;
1130
+ skippedInfo?: SkippedStatusInfoNonNullableFields;
1131
+ warnings: WarningNonNullableFields[];
1132
+ }
1133
+ export interface GetActivationLogResponseNonNullableFields {
1134
+ activationLog?: ActivationLogNonNullableFields;
1135
+ }
1136
+ export interface ListActivationLogsResponseNonNullableFields {
1137
+ activationLogs: ActivationLogNonNullableFields[];
1138
+ }
1139
+ export interface SearchActivationLogsByPayloadPiiValueResponseNonNullableFields {
1140
+ activationLogs: ActivationLogNonNullableFields[];
1141
+ }
1142
+ /**
1143
+ * Get activation log by ID
1144
+ * @param activationId - Activation log ID
1145
+ * @public
1146
+ * @documentationMaturity preview
1147
+ * @requiredField activationId
1148
+ * @permissionId AUTOMATIONS.ACTIVATION_LOG_READ
1149
+ * @permissionScope Set Up Automations
1150
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1151
+ * @applicableIdentity APP
1152
+ * @returns Activation log
1153
+ * @fqn wix.automations.activation_logs.v1.ActivationLogsService.GetActivationLog
1154
+ */
1155
+ export declare function getActivationLog(activationId: string): Promise<ActivationLog & ActivationLogNonNullableFields>;
1156
+ /**
1157
+ * List activation logs
1158
+ * @public
1159
+ * @documentationMaturity preview
1160
+ * @permissionId AUTOMATIONS.ACTIVATION_LOG_READ
1161
+ * @permissionScope Set Up Automations
1162
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1163
+ * @applicableIdentity APP
1164
+ * @fqn wix.automations.activation_logs.v1.ActivationLogsService.ListActivationLogs
1165
+ */
1166
+ export declare function listActivationLogs(options?: ListActivationLogsOptions): Promise<ListActivationLogsResponse & ListActivationLogsResponseNonNullableFields>;
1167
+ export interface ListActivationLogsOptions extends ListActivationLogsOptionsIdentifierOneOf {
1168
+ /** From created date, If not specified, defaults to 30 days before the current time. */
1169
+ fromCreatedDate?: Date | null;
1170
+ /** To created date, If not specified, defaults to current time. */
1171
+ toCreatedDate?: Date | null;
1172
+ /** Paging */
1173
+ cursorPaging?: CursorPaging;
1174
+ /** Should return payload in the response */
1175
+ includePayload?: boolean | null;
1176
+ /** identifier type for the activations to list */
1177
+ identifierType?: IdentifierType;
1178
+ /** Look up activations by automation id */
1179
+ automationIdInfo?: AutomationIdInfo;
1180
+ /** Look up activations by preinstalled identifier */
1181
+ preinstalledIdentifierInfo?: PreinstalledIdentifierInfo;
1182
+ }
1183
+ /** @oneof */
1184
+ export interface ListActivationLogsOptionsIdentifierOneOf {
1185
+ /** Look up activations by automation id */
1186
+ automationIdInfo?: AutomationIdInfo;
1187
+ /** Look up activations by preinstalled identifier */
1188
+ preinstalledIdentifierInfo?: PreinstalledIdentifierInfo;
1189
+ }
1190
+ /**
1191
+ * Search activation logs by payload pii value
1192
+ * Entire field value match is supported
1193
+ * Supported are emails, phones and guids
1194
+ * @param value - Value to search in the payload
1195
+ * @public
1196
+ * @documentationMaturity preview
1197
+ * @requiredField value
1198
+ * @permissionId AUTOMATIONS.ACTIVATION_LOG_READ
1199
+ * @permissionScope Set Up Automations
1200
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1201
+ * @applicableIdentity APP
1202
+ * @fqn wix.automations.activation_logs.v1.ActivationLogsService.SearchActivationLogsByPayloadPiiValue
1203
+ */
1204
+ export declare function searchActivationLogsByPayloadPiiValue(value: string, options?: SearchActivationLogsByPayloadPiiValueOptions): Promise<SearchActivationLogsByPayloadPiiValueResponse & SearchActivationLogsByPayloadPiiValueResponseNonNullableFields>;
1205
+ export interface SearchActivationLogsByPayloadPiiValueOptions extends SearchActivationLogsByPayloadPiiValueOptionsFilterOptionOneOf {
1206
+ /** Paging */
1207
+ cursorPaging?: CursorPaging;
1208
+ /** Should return payload in the response */
1209
+ includePayload?: boolean | null;
1210
+ /** Filter by */
1211
+ filterBy?: FilterBy;
1212
+ /** Filter activations by value and automation id */
1213
+ automationIdInfo?: AutomationIdInfo;
1214
+ /** Filter activations by value and preinstalled */
1215
+ preinstalledIdentifierInfo?: PreinstalledIdentifierInfo;
1216
+ /** From created date */
1217
+ fromCreatedDate?: Date | null;
1218
+ /** To created date */
1219
+ toCreatedDate?: Date | null;
1220
+ }
1221
+ /** @oneof */
1222
+ export interface SearchActivationLogsByPayloadPiiValueOptionsFilterOptionOneOf {
1223
+ /** Filter activations by value and automation id */
1224
+ automationIdInfo?: AutomationIdInfo;
1225
+ /** Filter activations by value and preinstalled */
1226
+ preinstalledIdentifierInfo?: PreinstalledIdentifierInfo;
1227
+ }
1228
+ export {};