@wix/auto_sdk_automations_activation-log 1.0.5 → 1.0.6

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