@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.
- 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
- 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
- package/build/index.d.mts +36 -0
- package/build/index.d.ts +36 -0
- package/build/index.js +487 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +445 -0
- package/build/index.mjs.map +1 -0
- 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
- 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
- package/build/internal/index.d.mts +36 -0
- package/build/internal/index.d.ts +36 -0
- package/build/internal/index.js +487 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +445 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +405 -0
- package/build/internal/meta.d.ts +405 -0
- package/build/internal/meta.js +260 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +231 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +405 -0
- package/build/meta.d.ts +405 -0
- package/build/meta.js +260 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +231 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.context.d.ts +0 -7
- package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.context.js +0 -26
- package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.context.js.map +0 -1
- package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.http.d.ts +0 -11
- package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.http.js +0 -176
- package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.http.js.map +0 -1
- package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.meta.d.ts +0 -17
- package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.meta.js +0 -85
- package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.meta.js.map +0 -1
- package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.public.d.ts +0 -32
- package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.public.js +0 -41
- package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.public.js.map +0 -1
- package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.types.d.ts +0 -1206
- package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.types.js +0 -169
- package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.types.js.map +0 -1
- package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.universal.js +0 -341
- package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.context.d.ts +0 -7
- package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.context.js +0 -7
- package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.context.js.map +0 -1
- package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.http.d.ts +0 -11
- package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.http.js +0 -170
- package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.http.js.map +0 -1
- package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.meta.d.ts +0 -17
- package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.meta.js +0 -56
- package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.meta.js.map +0 -1
- package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.public.d.ts +0 -32
- package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.public.js +0 -19
- package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.public.js.map +0 -1
- package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.types.d.ts +0 -1206
- package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.types.js +0 -166
- package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.types.js.map +0 -1
- package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.universal.js +0 -312
- package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.context.d.ts +0 -7
- package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.context.js +0 -26
- package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.context.js.map +0 -1
- package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.http.d.ts +0 -11
- package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.http.js +0 -176
- package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.http.js.map +0 -1
- package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.meta.d.ts +0 -17
- package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.meta.js +0 -85
- package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.meta.js.map +0 -1
- package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.public.d.ts +0 -32
- package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.public.js +0 -41
- package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.public.js.map +0 -1
- package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.types.d.ts +0 -1206
- package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.types.js +0 -169
- package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.types.js.map +0 -1
- package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.universal.js +0 -341
- package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.context.d.ts +0 -7
- package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.context.js +0 -7
- package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.context.js.map +0 -1
- package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.http.d.ts +0 -11
- package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.http.js +0 -170
- package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.http.js.map +0 -1
- package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.meta.d.ts +0 -17
- package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.meta.js +0 -56
- package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.meta.js.map +0 -1
- package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.public.d.ts +0 -32
- package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.public.js +0 -19
- package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.public.js.map +0 -1
- package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.types.d.ts +0 -1206
- package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.types.js +0 -166
- package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.types.js.map +0 -1
- package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.universal.js +0 -312
- package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.universal.js.map +0 -1
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
export interface ActivationLog {
|
|
1
|
+
interface ActivationLog {
|
|
3
2
|
/**
|
|
4
3
|
* Activation ID
|
|
5
4
|
* @format GUID
|
|
@@ -36,14 +35,14 @@ export interface ActivationLog {
|
|
|
36
35
|
/** Created date */
|
|
37
36
|
_createdDate?: Date | null;
|
|
38
37
|
}
|
|
39
|
-
|
|
38
|
+
declare enum Target {
|
|
40
39
|
UNKNOWN_TARGET = "UNKNOWN_TARGET",
|
|
41
40
|
SCHEDULE = "SCHEDULE",
|
|
42
41
|
IMMEDIATE = "IMMEDIATE"
|
|
43
42
|
}
|
|
44
43
|
/** @enumType */
|
|
45
|
-
|
|
46
|
-
|
|
44
|
+
type TargetWithLiterals = Target | 'UNKNOWN_TARGET' | 'SCHEDULE' | 'IMMEDIATE';
|
|
45
|
+
declare enum CancellationReason {
|
|
47
46
|
UNKNOWN_CANCELLATION_REASON = "UNKNOWN_CANCELLATION_REASON",
|
|
48
47
|
/** Indicating that the activation was cancelled directly */
|
|
49
48
|
EVENT_CANCELLED = "EVENT_CANCELLED",
|
|
@@ -57,8 +56,8 @@ export declare enum CancellationReason {
|
|
|
57
56
|
CANCELLED_BY_GDPR_REQUEST = "CANCELLED_BY_GDPR_REQUEST"
|
|
58
57
|
}
|
|
59
58
|
/** @enumType */
|
|
60
|
-
|
|
61
|
-
|
|
59
|
+
type CancellationReasonWithLiterals = CancellationReason | 'UNKNOWN_CANCELLATION_REASON' | 'EVENT_CANCELLED' | 'AUTOMATION_DEACTIVATED' | 'AUTOMATION_DELETED' | 'CANCELLED_BY_REFRESH_PAYLOAD' | 'CANCELLED_BY_GDPR_REQUEST';
|
|
60
|
+
interface Identity {
|
|
62
61
|
/**
|
|
63
62
|
* User ID
|
|
64
63
|
* @format GUID
|
|
@@ -70,15 +69,15 @@ export interface Identity {
|
|
|
70
69
|
*/
|
|
71
70
|
appId?: string | null;
|
|
72
71
|
}
|
|
73
|
-
|
|
72
|
+
declare enum ErrorReason {
|
|
74
73
|
/** Unexpected error reason */
|
|
75
74
|
UNEXPECTED_ERROR_REASON = "UNEXPECTED_ERROR_REASON",
|
|
76
75
|
/** Failed to evaluate the schedule date expression */
|
|
77
76
|
SCHEDULE_DATE_EVALUATION_FAILED = "SCHEDULE_DATE_EVALUATION_FAILED"
|
|
78
77
|
}
|
|
79
78
|
/** @enumType */
|
|
80
|
-
|
|
81
|
-
|
|
79
|
+
type ErrorReasonWithLiterals = ErrorReason | 'UNEXPECTED_ERROR_REASON' | 'SCHEDULE_DATE_EVALUATION_FAILED';
|
|
80
|
+
declare enum SkipReason {
|
|
82
81
|
UNKNOWN_SKIP_REASON = "UNKNOWN_SKIP_REASON",
|
|
83
82
|
/** Activation was skipped because the scheduled execution time had already passed at the time of execution */
|
|
84
83
|
SCHEDULE_DATE_EXPIRED = "SCHEDULE_DATE_EXPIRED",
|
|
@@ -90,8 +89,8 @@ export declare enum SkipReason {
|
|
|
90
89
|
EVENT_ALREADY_PROCESSED = "EVENT_ALREADY_PROCESSED"
|
|
91
90
|
}
|
|
92
91
|
/** @enumType */
|
|
93
|
-
|
|
94
|
-
|
|
92
|
+
type SkipReasonWithLiterals = SkipReason | 'UNKNOWN_SKIP_REASON' | 'SCHEDULE_DATE_EXPIRED' | 'TRIGGER_FILTERS_NOT_PASSED' | 'RATE_LIMIT_EXCEEDED' | 'EVENT_ALREADY_PROCESSED';
|
|
93
|
+
declare enum Status {
|
|
95
94
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
96
95
|
/** This indicates activation is not started yet (no action has run yet) */
|
|
97
96
|
INITIATED = "INITIATED",
|
|
@@ -115,8 +114,8 @@ export declare enum Status {
|
|
|
115
114
|
SKIPPED = "SKIPPED"
|
|
116
115
|
}
|
|
117
116
|
/** @enumType */
|
|
118
|
-
|
|
119
|
-
|
|
117
|
+
type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'INITIATED' | 'SCHEDULED' | 'STARTED' | 'ENDED' | 'CANCELLED' | 'FAILED' | 'SKIPPED';
|
|
118
|
+
interface InitiatedStatusInfo {
|
|
120
119
|
/** Created date */
|
|
121
120
|
statusChangedDate?: Date | null;
|
|
122
121
|
/** Target */
|
|
@@ -134,7 +133,7 @@ export interface InitiatedStatusInfo {
|
|
|
134
133
|
*/
|
|
135
134
|
requestId?: string | null;
|
|
136
135
|
}
|
|
137
|
-
|
|
136
|
+
interface ScheduledStatusInfo {
|
|
138
137
|
/** Created date */
|
|
139
138
|
statusChangedDate?: Date | null;
|
|
140
139
|
/**
|
|
@@ -145,19 +144,19 @@ export interface ScheduledStatusInfo {
|
|
|
145
144
|
/** Indicating when the activation should start */
|
|
146
145
|
date?: Date | null;
|
|
147
146
|
}
|
|
148
|
-
|
|
147
|
+
interface StartedStatusInfo {
|
|
149
148
|
/** Created date */
|
|
150
149
|
statusChangedDate?: Date | null;
|
|
151
150
|
/** Enriched and refreshed payload */
|
|
152
151
|
payload?: Record<string, any> | null;
|
|
153
152
|
}
|
|
154
|
-
|
|
153
|
+
interface EndedStatusInfo {
|
|
155
154
|
/** Created date */
|
|
156
155
|
statusChangedDate?: Date | null;
|
|
157
156
|
/** Indicates if the activation failed with errors in one or more actions. Actions that failed but eventually ended are not included */
|
|
158
157
|
withFailedActions?: boolean | null;
|
|
159
158
|
}
|
|
160
|
-
|
|
159
|
+
interface CancelledStatusInfo {
|
|
161
160
|
/** Created date */
|
|
162
161
|
statusChangedDate?: Date | null;
|
|
163
162
|
/** Cancellation reason */
|
|
@@ -165,7 +164,7 @@ export interface CancelledStatusInfo {
|
|
|
165
164
|
/** The identity (such as user, app etc.) that caused the cancellation */
|
|
166
165
|
initiator?: Identity;
|
|
167
166
|
}
|
|
168
|
-
|
|
167
|
+
interface FailedStatusInfo {
|
|
169
168
|
/** Created date */
|
|
170
169
|
statusChangedDate?: Date | null;
|
|
171
170
|
/**
|
|
@@ -194,7 +193,7 @@ export interface FailedStatusInfo {
|
|
|
194
193
|
*/
|
|
195
194
|
requestId?: string | null;
|
|
196
195
|
}
|
|
197
|
-
|
|
196
|
+
interface SkippedStatusInfo {
|
|
198
197
|
/** Created date */
|
|
199
198
|
statusChangedDate?: Date | null;
|
|
200
199
|
/** The reason why the automation activation was skipped */
|
|
@@ -212,7 +211,7 @@ export interface SkippedStatusInfo {
|
|
|
212
211
|
*/
|
|
213
212
|
requestId?: string | null;
|
|
214
213
|
}
|
|
215
|
-
|
|
214
|
+
interface Warning {
|
|
216
215
|
/** Event date */
|
|
217
216
|
warningDate?: Date | null;
|
|
218
217
|
/**
|
|
@@ -230,7 +229,7 @@ export interface Warning {
|
|
|
230
229
|
/** The reason for the warning */
|
|
231
230
|
reason?: WarningReasonWithLiterals;
|
|
232
231
|
}
|
|
233
|
-
|
|
232
|
+
declare enum WarningReason {
|
|
234
233
|
UNKNOWN_WARNING_REASON = "UNKNOWN_WARNING_REASON",
|
|
235
234
|
/** Failed to enrich payload with studio site enrichment */
|
|
236
235
|
STUDIO_SITE_ENRICHMENT_FAILED = "STUDIO_SITE_ENRICHMENT_FAILED",
|
|
@@ -242,8 +241,8 @@ export declare enum WarningReason {
|
|
|
242
241
|
GET_MEMBER_ENRICHMENT_FAILED = "GET_MEMBER_ENRICHMENT_FAILED"
|
|
243
242
|
}
|
|
244
243
|
/** @enumType */
|
|
245
|
-
|
|
246
|
-
|
|
244
|
+
type WarningReasonWithLiterals = WarningReason | 'UNKNOWN_WARNING_REASON' | 'STUDIO_SITE_ENRICHMENT_FAILED' | 'REFRESH_PAYLOAD_FAILED' | 'GET_CONTACT_ENRICHMENT_FAILED' | 'GET_MEMBER_ENRICHMENT_FAILED';
|
|
245
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
247
246
|
createdEvent?: EntityCreatedEvent;
|
|
248
247
|
updatedEvent?: EntityUpdatedEvent;
|
|
249
248
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -278,19 +277,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
278
277
|
entityEventSequence?: string | null;
|
|
279
278
|
}
|
|
280
279
|
/** @oneof */
|
|
281
|
-
|
|
280
|
+
interface DomainEventBodyOneOf {
|
|
282
281
|
createdEvent?: EntityCreatedEvent;
|
|
283
282
|
updatedEvent?: EntityUpdatedEvent;
|
|
284
283
|
deletedEvent?: EntityDeletedEvent;
|
|
285
284
|
actionEvent?: ActionEvent;
|
|
286
285
|
}
|
|
287
|
-
|
|
286
|
+
interface EntityCreatedEvent {
|
|
288
287
|
entity?: string;
|
|
289
288
|
}
|
|
290
|
-
|
|
289
|
+
interface RestoreInfo {
|
|
291
290
|
deletedDate?: Date | null;
|
|
292
291
|
}
|
|
293
|
-
|
|
292
|
+
interface EntityUpdatedEvent {
|
|
294
293
|
/**
|
|
295
294
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
296
295
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -298,16 +297,16 @@ export interface EntityUpdatedEvent {
|
|
|
298
297
|
*/
|
|
299
298
|
currentEntity?: string;
|
|
300
299
|
}
|
|
301
|
-
|
|
300
|
+
interface EntityDeletedEvent {
|
|
302
301
|
/** Entity that was deleted. */
|
|
303
302
|
deletedEntity?: string | null;
|
|
304
303
|
}
|
|
305
|
-
|
|
304
|
+
interface ActionEvent {
|
|
306
305
|
body?: string;
|
|
307
306
|
}
|
|
308
|
-
|
|
307
|
+
interface Empty {
|
|
309
308
|
}
|
|
310
|
-
|
|
309
|
+
interface ActivationContinuedAfterSchedule {
|
|
311
310
|
/**
|
|
312
311
|
* Activation identifier
|
|
313
312
|
* @format GUID
|
|
@@ -316,7 +315,7 @@ export interface ActivationContinuedAfterSchedule {
|
|
|
316
315
|
/** Activation Automation */
|
|
317
316
|
automation?: Automation;
|
|
318
317
|
}
|
|
319
|
-
|
|
318
|
+
interface Automation extends AutomationOriginInfoOneOf {
|
|
320
319
|
/** When the origin of the automation is `APPLICATION`, the details of the app that created it. */
|
|
321
320
|
applicationInfo?: ApplicationOrigin;
|
|
322
321
|
/** When the origin of the automation is `PREINSTALLED`, the details of the preinstalled automation. */
|
|
@@ -386,13 +385,13 @@ export interface Automation extends AutomationOriginInfoOneOf {
|
|
|
386
385
|
archived?: boolean;
|
|
387
386
|
}
|
|
388
387
|
/** @oneof */
|
|
389
|
-
|
|
388
|
+
interface AutomationOriginInfoOneOf {
|
|
390
389
|
/** When the origin of the automation is `APPLICATION`, the details of the app that created it. */
|
|
391
390
|
applicationInfo?: ApplicationOrigin;
|
|
392
391
|
/** When the origin of the automation is `PREINSTALLED`, the details of the preinstalled automation. */
|
|
393
392
|
preinstalledInfo?: PreinstalledOrigin;
|
|
394
393
|
}
|
|
395
|
-
|
|
394
|
+
interface ActionSettings {
|
|
396
395
|
/**
|
|
397
396
|
* Permanent actions. Permanent actions cannot be deleted.
|
|
398
397
|
*
|
|
@@ -422,7 +421,7 @@ export interface ActionSettings {
|
|
|
422
421
|
*/
|
|
423
422
|
disableConditionAddition?: boolean;
|
|
424
423
|
}
|
|
425
|
-
|
|
424
|
+
declare enum Domain {
|
|
426
425
|
/** User domain (default). */
|
|
427
426
|
USER = "USER",
|
|
428
427
|
/** Wix domain. */
|
|
@@ -430,16 +429,14 @@ export declare enum Domain {
|
|
|
430
429
|
/** Wix account-level domain. */
|
|
431
430
|
WIX_ACCOUNT = "WIX_ACCOUNT"
|
|
432
431
|
}
|
|
433
|
-
|
|
434
|
-
export type DomainWithLiterals = Domain | 'USER' | 'WIX' | 'WIX_ACCOUNT';
|
|
435
|
-
export interface Enrichment {
|
|
432
|
+
interface Enrichment {
|
|
436
433
|
/**
|
|
437
434
|
* Enrichment input mappings.
|
|
438
435
|
* @maxSize 2
|
|
439
436
|
*/
|
|
440
437
|
inputMappings?: Record<string, any>[] | null;
|
|
441
438
|
}
|
|
442
|
-
|
|
439
|
+
interface AuditInfo extends AuditInfoIdOneOf {
|
|
443
440
|
/**
|
|
444
441
|
* [User ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#user-id).
|
|
445
442
|
* @format GUID
|
|
@@ -454,7 +451,7 @@ export interface AuditInfo extends AuditInfoIdOneOf {
|
|
|
454
451
|
appId?: string;
|
|
455
452
|
}
|
|
456
453
|
/** @oneof */
|
|
457
|
-
|
|
454
|
+
interface AuditInfoIdOneOf {
|
|
458
455
|
/**
|
|
459
456
|
* [User ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#user-id).
|
|
460
457
|
* @format GUID
|
|
@@ -468,7 +465,7 @@ export interface AuditInfoIdOneOf {
|
|
|
468
465
|
*/
|
|
469
466
|
appId?: string;
|
|
470
467
|
}
|
|
471
|
-
|
|
468
|
+
interface AutomationConfiguration {
|
|
472
469
|
/** Status of the automation on the site. */
|
|
473
470
|
status?: AutomationConfigurationStatusWithLiterals;
|
|
474
471
|
/** Trigger configuration. */
|
|
@@ -484,7 +481,7 @@ export interface AutomationConfiguration {
|
|
|
484
481
|
/** 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. */
|
|
485
482
|
actions?: Record<string, Action>;
|
|
486
483
|
}
|
|
487
|
-
|
|
484
|
+
declare enum TimeUnit {
|
|
488
485
|
UNKNOWN_TIME_UNIT = "UNKNOWN_TIME_UNIT",
|
|
489
486
|
/** Minutes. */
|
|
490
487
|
MINUTES = "MINUTES",
|
|
@@ -498,8 +495,8 @@ export declare enum TimeUnit {
|
|
|
498
495
|
MONTHS = "MONTHS"
|
|
499
496
|
}
|
|
500
497
|
/** @enumType */
|
|
501
|
-
|
|
502
|
-
|
|
498
|
+
type TimeUnitWithLiterals = TimeUnit | 'UNKNOWN_TIME_UNIT' | 'MINUTES' | 'HOURS' | 'DAYS' | 'WEEKS' | 'MONTHS';
|
|
499
|
+
interface Filter {
|
|
503
500
|
/**
|
|
504
501
|
* Filter ID.
|
|
505
502
|
* @format GUID
|
|
@@ -521,7 +518,7 @@ export interface Filter {
|
|
|
521
518
|
*/
|
|
522
519
|
filterExpression?: string;
|
|
523
520
|
}
|
|
524
|
-
|
|
521
|
+
interface FutureDateActivationOffset {
|
|
525
522
|
/**
|
|
526
523
|
* Amount of time before the trigger to run the automation.
|
|
527
524
|
*
|
|
@@ -532,7 +529,7 @@ export interface FutureDateActivationOffset {
|
|
|
532
529
|
/** Unit in which to set the action offset. */
|
|
533
530
|
scheduledEventOffsetTimeUnit?: TimeUnitWithLiterals;
|
|
534
531
|
}
|
|
535
|
-
|
|
532
|
+
interface RateLimit {
|
|
536
533
|
/**
|
|
537
534
|
* Maximum number of times the trigger can be activated.
|
|
538
535
|
* @maxLength 1000
|
|
@@ -554,7 +551,7 @@ export interface RateLimit {
|
|
|
554
551
|
*/
|
|
555
552
|
uniqueIdentifierExpression?: string | null;
|
|
556
553
|
}
|
|
557
|
-
|
|
554
|
+
interface FilterValueSelection {
|
|
558
555
|
/**
|
|
559
556
|
* Values that can help the user filter certain automations. Specify values in the following format: `<filter_id>__<selected_value>`.
|
|
560
557
|
* @maxLength 80
|
|
@@ -562,7 +559,7 @@ export interface FilterValueSelection {
|
|
|
562
559
|
*/
|
|
563
560
|
selectedFilterValues?: string[];
|
|
564
561
|
}
|
|
565
|
-
|
|
562
|
+
interface ConditionExpressionGroup {
|
|
566
563
|
/** Logical operator used to evaluate the condition expressions. */
|
|
567
564
|
operator?: OperatorWithLiterals;
|
|
568
565
|
/**
|
|
@@ -573,7 +570,7 @@ export interface ConditionExpressionGroup {
|
|
|
573
570
|
*/
|
|
574
571
|
booleanExpressions?: string[];
|
|
575
572
|
}
|
|
576
|
-
|
|
573
|
+
declare enum Operator {
|
|
577
574
|
/** Unknown. */
|
|
578
575
|
UNKNOWN_OPERATOR = "UNKNOWN_OPERATOR",
|
|
579
576
|
/** `OR` operator. */
|
|
@@ -582,8 +579,8 @@ export declare enum Operator {
|
|
|
582
579
|
AND = "AND"
|
|
583
580
|
}
|
|
584
581
|
/** @enumType */
|
|
585
|
-
|
|
586
|
-
|
|
582
|
+
type OperatorWithLiterals = Operator | 'UNKNOWN_OPERATOR' | 'OR' | 'AND';
|
|
583
|
+
interface CodeSnippet {
|
|
587
584
|
/** Logical operator used to evaluate the condition expressions. */
|
|
588
585
|
language?: LanguageWithLiterals;
|
|
589
586
|
/**
|
|
@@ -592,16 +589,16 @@ export interface CodeSnippet {
|
|
|
592
589
|
*/
|
|
593
590
|
code?: string;
|
|
594
591
|
}
|
|
595
|
-
|
|
592
|
+
declare enum Language {
|
|
596
593
|
/** Unknown. */
|
|
597
594
|
UNKNOWN_LANGUAGE = "UNKNOWN_LANGUAGE",
|
|
598
595
|
/** `JAVASCRIPT` language. */
|
|
599
596
|
JAVASCRIPT = "JAVASCRIPT"
|
|
600
597
|
}
|
|
601
598
|
/** @enumType */
|
|
602
|
-
|
|
599
|
+
type LanguageWithLiterals = Language | 'UNKNOWN_LANGUAGE' | 'JAVASCRIPT';
|
|
603
600
|
/** Path definition */
|
|
604
|
-
|
|
601
|
+
interface Path {
|
|
605
602
|
/**
|
|
606
603
|
* Unique path ID.
|
|
607
604
|
* @format GUID
|
|
@@ -619,7 +616,7 @@ export interface Path {
|
|
|
619
616
|
*/
|
|
620
617
|
postActionId?: string | null;
|
|
621
618
|
}
|
|
622
|
-
|
|
619
|
+
declare enum Type {
|
|
623
620
|
/** Based on the trigger. */
|
|
624
621
|
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
625
622
|
/** 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. */
|
|
@@ -632,8 +629,8 @@ export declare enum Type {
|
|
|
632
629
|
RATE_LIMIT = "RATE_LIMIT"
|
|
633
630
|
}
|
|
634
631
|
/** @enumType */
|
|
635
|
-
|
|
636
|
-
|
|
632
|
+
type TypeWithLiterals = Type | 'UNKNOWN_ACTION_TYPE' | 'APP_DEFINED' | 'CONDITION' | 'DELAY' | 'RATE_LIMIT';
|
|
633
|
+
interface AppDefinedAction {
|
|
637
634
|
/**
|
|
638
635
|
* ID of the app that defines the action.
|
|
639
636
|
* @format GUID
|
|
@@ -663,7 +660,7 @@ export interface AppDefinedAction {
|
|
|
663
660
|
/** Action output schema. When specified, this replaces the action schema. */
|
|
664
661
|
overrideOutputSchema?: Record<string, any> | null;
|
|
665
662
|
}
|
|
666
|
-
|
|
663
|
+
interface ConditionAction {
|
|
667
664
|
/**
|
|
668
665
|
* Condition is `true` if one or more of the expression groups evaluates to `true`.
|
|
669
666
|
* @minSize 1
|
|
@@ -683,7 +680,7 @@ export interface ConditionAction {
|
|
|
683
680
|
*/
|
|
684
681
|
falsePostActionIds?: string[];
|
|
685
682
|
}
|
|
686
|
-
|
|
683
|
+
interface CodeConditionAction {
|
|
687
684
|
/** 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. */
|
|
688
685
|
snippet?: CodeSnippet;
|
|
689
686
|
/**
|
|
@@ -699,7 +696,7 @@ export interface CodeConditionAction {
|
|
|
699
696
|
*/
|
|
700
697
|
falsePostActionIds?: string[];
|
|
701
698
|
}
|
|
702
|
-
|
|
699
|
+
interface DelayAction {
|
|
703
700
|
/**
|
|
704
701
|
* Time to wait before running the action. The wait time starts from when the current action completes.
|
|
705
702
|
*
|
|
@@ -723,7 +720,7 @@ export interface DelayAction {
|
|
|
723
720
|
*/
|
|
724
721
|
postActionIds?: string[];
|
|
725
722
|
}
|
|
726
|
-
|
|
723
|
+
interface RateLimitAction {
|
|
727
724
|
/**
|
|
728
725
|
* Maximum number of times the action can run.
|
|
729
726
|
* @maxLength 1000
|
|
@@ -751,7 +748,7 @@ export interface RateLimitAction {
|
|
|
751
748
|
*/
|
|
752
749
|
postActionIds?: string[];
|
|
753
750
|
}
|
|
754
|
-
|
|
751
|
+
interface SetVariablesAction {
|
|
755
752
|
/** Output mapping. For example: `{"someField": "{{10}}", "someOtherField": "{{multiply( var('account.points.balance') ;2 )}}" }`. */
|
|
756
753
|
outputMapping?: Record<string, any> | null;
|
|
757
754
|
/**
|
|
@@ -767,11 +764,11 @@ export interface SetVariablesAction {
|
|
|
767
764
|
*/
|
|
768
765
|
postActionIds?: string[];
|
|
769
766
|
}
|
|
770
|
-
|
|
767
|
+
interface OutputAction {
|
|
771
768
|
/** Output action output mapping. */
|
|
772
769
|
outputMapping?: Record<string, any> | null;
|
|
773
770
|
}
|
|
774
|
-
|
|
771
|
+
interface SplitAction {
|
|
775
772
|
/**
|
|
776
773
|
* List of paths to split execution into.
|
|
777
774
|
* @minSize 2
|
|
@@ -779,7 +776,7 @@ export interface SplitAction {
|
|
|
779
776
|
*/
|
|
780
777
|
paths?: Path[];
|
|
781
778
|
}
|
|
782
|
-
|
|
779
|
+
declare enum AutomationConfigurationStatus {
|
|
783
780
|
/** Unknown. */
|
|
784
781
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
785
782
|
/** Active. Active automations can be triggered. */
|
|
@@ -788,8 +785,8 @@ export declare enum AutomationConfigurationStatus {
|
|
|
788
785
|
INACTIVE = "INACTIVE"
|
|
789
786
|
}
|
|
790
787
|
/** @enumType */
|
|
791
|
-
|
|
792
|
-
|
|
788
|
+
type AutomationConfigurationStatusWithLiterals = AutomationConfigurationStatus | 'UNKNOWN_STATUS' | 'ACTIVE' | 'INACTIVE';
|
|
789
|
+
interface Trigger {
|
|
793
790
|
/**
|
|
794
791
|
* ID of the app that defines the trigger.
|
|
795
792
|
* @format GUID
|
|
@@ -821,7 +818,7 @@ export interface Trigger {
|
|
|
821
818
|
/** Trigger schema override. When specified, this replaces the trigger schema. */
|
|
822
819
|
overrideSchema?: Record<string, any> | null;
|
|
823
820
|
}
|
|
824
|
-
|
|
821
|
+
interface Action extends ActionInfoOneOf {
|
|
825
822
|
/** Details of the action when its `type` is `APP_DEFINED`. */
|
|
826
823
|
appDefinedInfo?: AppDefinedAction;
|
|
827
824
|
/** Details of the action when its `type` is `CONDITION`. */
|
|
@@ -851,7 +848,7 @@ export interface Action extends ActionInfoOneOf {
|
|
|
851
848
|
namespace?: string | null;
|
|
852
849
|
}
|
|
853
850
|
/** @oneof */
|
|
854
|
-
|
|
851
|
+
interface ActionInfoOneOf {
|
|
855
852
|
/** Details of the action when its `type` is `APP_DEFINED`. */
|
|
856
853
|
appDefinedInfo?: AppDefinedAction;
|
|
857
854
|
/** Details of the action when its `type` is `CONDITION`. */
|
|
@@ -863,7 +860,7 @@ export interface ActionInfoOneOf {
|
|
|
863
860
|
/** Details of the action when its `type` is `RATE_LIMIT`. */
|
|
864
861
|
rateLimitInfo?: RateLimitAction;
|
|
865
862
|
}
|
|
866
|
-
|
|
863
|
+
interface FilterableAppDefinedActions {
|
|
867
864
|
/**
|
|
868
865
|
* App-defined action identifiers. Identifiers have the following format: `${appId}_${actionKey}`.
|
|
869
866
|
* @minSize 1
|
|
@@ -873,7 +870,7 @@ export interface FilterableAppDefinedActions {
|
|
|
873
870
|
*/
|
|
874
871
|
actionIdentifiers?: string[];
|
|
875
872
|
}
|
|
876
|
-
|
|
873
|
+
declare enum Origin {
|
|
877
874
|
/** Default value. */
|
|
878
875
|
UNKNOWN_ORIGIN = "UNKNOWN_ORIGIN",
|
|
879
876
|
/** Created by a [Wix user](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#wix-user). */
|
|
@@ -884,8 +881,8 @@ export declare enum Origin {
|
|
|
884
881
|
PREINSTALLED = "PREINSTALLED"
|
|
885
882
|
}
|
|
886
883
|
/** @enumType */
|
|
887
|
-
|
|
888
|
-
|
|
884
|
+
type OriginWithLiterals = Origin | 'UNKNOWN_ORIGIN' | 'USER' | 'APPLICATION' | 'PREINSTALLED';
|
|
885
|
+
interface ApplicationOrigin {
|
|
889
886
|
/**
|
|
890
887
|
* [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
|
|
891
888
|
*
|
|
@@ -894,7 +891,7 @@ export interface ApplicationOrigin {
|
|
|
894
891
|
*/
|
|
895
892
|
appId?: string;
|
|
896
893
|
}
|
|
897
|
-
|
|
894
|
+
interface PreinstalledOrigin {
|
|
898
895
|
/**
|
|
899
896
|
* 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).
|
|
900
897
|
* @format GUID
|
|
@@ -915,7 +912,7 @@ export interface PreinstalledOrigin {
|
|
|
915
912
|
*/
|
|
916
913
|
override?: boolean | null;
|
|
917
914
|
}
|
|
918
|
-
|
|
915
|
+
interface AutomationSettings {
|
|
919
916
|
/**
|
|
920
917
|
* Whether the automation is hidden from users.
|
|
921
918
|
*
|
|
@@ -943,7 +940,7 @@ export interface AutomationSettings {
|
|
|
943
940
|
/** Automation action settings. */
|
|
944
941
|
actionSettings?: ActionSettings;
|
|
945
942
|
}
|
|
946
|
-
|
|
943
|
+
interface DraftInfo {
|
|
947
944
|
/**
|
|
948
945
|
* ID of the original automation.
|
|
949
946
|
* @format GUID
|
|
@@ -951,11 +948,11 @@ export interface DraftInfo {
|
|
|
951
948
|
*/
|
|
952
949
|
originalAutomationId?: string | null;
|
|
953
950
|
}
|
|
954
|
-
|
|
951
|
+
interface Enrichments {
|
|
955
952
|
/** Whether the studio site enrichment is wanted. */
|
|
956
953
|
studioSite?: Enrichment;
|
|
957
954
|
}
|
|
958
|
-
|
|
955
|
+
interface ExtendedFields {
|
|
959
956
|
/**
|
|
960
957
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
961
958
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -966,7 +963,7 @@ export interface ExtendedFields {
|
|
|
966
963
|
*/
|
|
967
964
|
namespaces?: Record<string, Record<string, any>>;
|
|
968
965
|
}
|
|
969
|
-
|
|
966
|
+
interface UouDeleteRequest {
|
|
970
967
|
/** Original UouRightToBeDeletedRequest request */
|
|
971
968
|
originalRequest?: Record<string, any> | null;
|
|
972
969
|
/**
|
|
@@ -975,7 +972,7 @@ export interface UouDeleteRequest {
|
|
|
975
972
|
*/
|
|
976
973
|
foundClientEntityIdsByNamespace?: ClientEntityIdsByNamespace[];
|
|
977
974
|
}
|
|
978
|
-
|
|
975
|
+
interface ClientEntityIdsByNamespace {
|
|
979
976
|
/**
|
|
980
977
|
* Client namespace
|
|
981
978
|
* @minLength 5
|
|
@@ -990,18 +987,18 @@ export interface ClientEntityIdsByNamespace {
|
|
|
990
987
|
*/
|
|
991
988
|
clientEntityIds?: string[];
|
|
992
989
|
}
|
|
993
|
-
|
|
990
|
+
interface GetActivationLogRequest {
|
|
994
991
|
/**
|
|
995
992
|
* Activation log ID
|
|
996
993
|
* @format GUID
|
|
997
994
|
*/
|
|
998
995
|
activationId: string;
|
|
999
996
|
}
|
|
1000
|
-
|
|
997
|
+
interface GetActivationLogResponse {
|
|
1001
998
|
/** Activation log */
|
|
1002
999
|
activationLog?: ActivationLog;
|
|
1003
1000
|
}
|
|
1004
|
-
|
|
1001
|
+
interface ListActivationLogsRequest extends ListActivationLogsRequestIdentifierOneOf {
|
|
1005
1002
|
/** Look up activations by automation id */
|
|
1006
1003
|
automationIdInfo?: AutomationIdInfo;
|
|
1007
1004
|
/** Look up activations by preinstalled identifier */
|
|
@@ -1018,13 +1015,13 @@ export interface ListActivationLogsRequest extends ListActivationLogsRequestIden
|
|
|
1018
1015
|
identifierType: IdentifierTypeWithLiterals;
|
|
1019
1016
|
}
|
|
1020
1017
|
/** @oneof */
|
|
1021
|
-
|
|
1018
|
+
interface ListActivationLogsRequestIdentifierOneOf {
|
|
1022
1019
|
/** Look up activations by automation id */
|
|
1023
1020
|
automationIdInfo?: AutomationIdInfo;
|
|
1024
1021
|
/** Look up activations by preinstalled identifier */
|
|
1025
1022
|
preinstalledIdentifierInfo?: PreinstalledIdentifierInfo;
|
|
1026
1023
|
}
|
|
1027
|
-
|
|
1024
|
+
interface CursorPaging {
|
|
1028
1025
|
/**
|
|
1029
1026
|
* Maximum number of items to return in the results.
|
|
1030
1027
|
* @max 500
|
|
@@ -1040,19 +1037,19 @@ export interface CursorPaging {
|
|
|
1040
1037
|
cursor?: string | null;
|
|
1041
1038
|
}
|
|
1042
1039
|
/** Type of identifier used to look up activation logs */
|
|
1043
|
-
|
|
1040
|
+
declare enum IdentifierType {
|
|
1044
1041
|
UNKNOWN_TYPE = "UNKNOWN_TYPE"
|
|
1045
1042
|
}
|
|
1046
1043
|
/** @enumType */
|
|
1047
|
-
|
|
1048
|
-
|
|
1044
|
+
type IdentifierTypeWithLiterals = IdentifierType | 'UNKNOWN_TYPE';
|
|
1045
|
+
interface AutomationIdInfo {
|
|
1049
1046
|
/**
|
|
1050
1047
|
* Automation ID
|
|
1051
1048
|
* @format GUID
|
|
1052
1049
|
*/
|
|
1053
1050
|
automationId?: string;
|
|
1054
1051
|
}
|
|
1055
|
-
|
|
1052
|
+
interface PreinstalledIdentifierInfo {
|
|
1056
1053
|
/**
|
|
1057
1054
|
* ID of the app that defines the preinstalled automation.
|
|
1058
1055
|
* @format GUID
|
|
@@ -1064,13 +1061,13 @@ export interface PreinstalledIdentifierInfo {
|
|
|
1064
1061
|
*/
|
|
1065
1062
|
componentId?: string;
|
|
1066
1063
|
}
|
|
1067
|
-
|
|
1064
|
+
interface ListActivationLogsResponse {
|
|
1068
1065
|
/** List of activation logs */
|
|
1069
1066
|
activationLogs?: ActivationLog[];
|
|
1070
1067
|
/** Paging metadata */
|
|
1071
1068
|
pagingMetadata?: CursorPagingMetadata;
|
|
1072
1069
|
}
|
|
1073
|
-
|
|
1070
|
+
interface CursorPagingMetadata {
|
|
1074
1071
|
/** Number of items returned in the response. */
|
|
1075
1072
|
count?: number | null;
|
|
1076
1073
|
/** Cursor string that point to the next page */
|
|
@@ -1083,14 +1080,14 @@ export interface CursorPagingMetadata {
|
|
|
1083
1080
|
*/
|
|
1084
1081
|
hasNext?: boolean | null;
|
|
1085
1082
|
}
|
|
1086
|
-
|
|
1083
|
+
interface Cursors {
|
|
1087
1084
|
/**
|
|
1088
1085
|
* Cursor string pointing to the next page in the list of results.
|
|
1089
1086
|
* @maxLength 16000
|
|
1090
1087
|
*/
|
|
1091
1088
|
next?: string | null;
|
|
1092
1089
|
}
|
|
1093
|
-
|
|
1090
|
+
interface SearchActivationLogsByPayloadPiiValueRequest extends SearchActivationLogsByPayloadPiiValueRequestFilterOptionOneOf {
|
|
1094
1091
|
/** Filter activations by value and automation id */
|
|
1095
1092
|
automationIdInfo?: AutomationIdInfo;
|
|
1096
1093
|
/** Filter activations by value and preinstalled */
|
|
@@ -1113,25 +1110,25 @@ export interface SearchActivationLogsByPayloadPiiValueRequest extends SearchActi
|
|
|
1113
1110
|
toCreatedDate?: Date | null;
|
|
1114
1111
|
}
|
|
1115
1112
|
/** @oneof */
|
|
1116
|
-
|
|
1113
|
+
interface SearchActivationLogsByPayloadPiiValueRequestFilterOptionOneOf {
|
|
1117
1114
|
/** Filter activations by value and automation id */
|
|
1118
1115
|
automationIdInfo?: AutomationIdInfo;
|
|
1119
1116
|
/** Filter activations by value and preinstalled */
|
|
1120
1117
|
preinstalledIdentifierInfo?: PreinstalledIdentifierInfo;
|
|
1121
1118
|
}
|
|
1122
1119
|
/** FilterBy */
|
|
1123
|
-
|
|
1120
|
+
declare enum FilterBy {
|
|
1124
1121
|
UNKNOWN_TYPE = "UNKNOWN_TYPE"
|
|
1125
1122
|
}
|
|
1126
1123
|
/** @enumType */
|
|
1127
|
-
|
|
1128
|
-
|
|
1124
|
+
type FilterByWithLiterals = FilterBy | 'UNKNOWN_TYPE';
|
|
1125
|
+
interface SearchActivationLogsByPayloadPiiValueResponse {
|
|
1129
1126
|
/** List of activation logs */
|
|
1130
1127
|
activationLogs?: ActivationLog[];
|
|
1131
1128
|
/** Paging metadata */
|
|
1132
1129
|
pagingMetadata?: CursorPagingMetadata;
|
|
1133
1130
|
}
|
|
1134
|
-
|
|
1131
|
+
interface MessageEnvelope {
|
|
1135
1132
|
/**
|
|
1136
1133
|
* App instance ID.
|
|
1137
1134
|
* @format GUID
|
|
@@ -1147,7 +1144,7 @@ export interface MessageEnvelope {
|
|
|
1147
1144
|
/** Stringify payload. */
|
|
1148
1145
|
data?: string;
|
|
1149
1146
|
}
|
|
1150
|
-
|
|
1147
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1151
1148
|
/**
|
|
1152
1149
|
* ID of a site visitor that has not logged in to the site.
|
|
1153
1150
|
* @format GUID
|
|
@@ -1172,7 +1169,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1172
1169
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1173
1170
|
}
|
|
1174
1171
|
/** @oneof */
|
|
1175
|
-
|
|
1172
|
+
interface IdentificationDataIdOneOf {
|
|
1176
1173
|
/**
|
|
1177
1174
|
* ID of a site visitor that has not logged in to the site.
|
|
1178
1175
|
* @format GUID
|
|
@@ -1194,7 +1191,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
1194
1191
|
*/
|
|
1195
1192
|
appId?: string;
|
|
1196
1193
|
}
|
|
1197
|
-
|
|
1194
|
+
declare enum WebhookIdentityType {
|
|
1198
1195
|
UNKNOWN = "UNKNOWN",
|
|
1199
1196
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1200
1197
|
MEMBER = "MEMBER",
|
|
@@ -1202,41 +1199,8 @@ export declare enum WebhookIdentityType {
|
|
|
1202
1199
|
APP = "APP"
|
|
1203
1200
|
}
|
|
1204
1201
|
/** @enumType */
|
|
1205
|
-
|
|
1206
|
-
|
|
1207
|
-
/**
|
|
1208
|
-
* Get activation log by ID
|
|
1209
|
-
* @param activationId - Activation log ID
|
|
1210
|
-
* @public
|
|
1211
|
-
* @documentationMaturity preview
|
|
1212
|
-
* @requiredField activationId
|
|
1213
|
-
* @permissionId AUTOMATIONS.ACTIVATION_LOG_READ
|
|
1214
|
-
* @permissionScope Manage Stores
|
|
1215
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1216
|
-
* @permissionScope Set Up Automations
|
|
1217
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1218
|
-
* @applicableIdentity APP
|
|
1219
|
-
* @returns Activation log
|
|
1220
|
-
* @fqn wix.automations.activation_logs.v1.ActivationLogsService.GetActivationLog
|
|
1221
|
-
*/
|
|
1222
|
-
export declare function getActivationLog(activationId: string): Promise<NonNullablePaths<ActivationLog, ActivationLogNonNullablePaths>>;
|
|
1223
|
-
/**
|
|
1224
|
-
* List activation logs
|
|
1225
|
-
* @public
|
|
1226
|
-
* @documentationMaturity preview
|
|
1227
|
-
* @requiredField options.identifierType
|
|
1228
|
-
* @permissionId AUTOMATIONS.ACTIVATION_LOG_READ
|
|
1229
|
-
* @permissionScope Manage Stores
|
|
1230
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1231
|
-
* @permissionScope Set Up Automations
|
|
1232
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1233
|
-
* @applicableIdentity APP
|
|
1234
|
-
* @fqn wix.automations.activation_logs.v1.ActivationLogsService.ListActivationLogs
|
|
1235
|
-
*/
|
|
1236
|
-
export declare function listActivationLogs(options?: NonNullablePaths<ListActivationLogsOptions, `identifierType`>): Promise<NonNullablePaths<ListActivationLogsResponse, {
|
|
1237
|
-
[P in ActivationLogNonNullablePaths]: `activationLogs.${number}.${P}`;
|
|
1238
|
-
}[ActivationLogNonNullablePaths]>>;
|
|
1239
|
-
export interface ListActivationLogsOptions extends ListActivationLogsOptionsIdentifierOneOf {
|
|
1202
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1203
|
+
interface ListActivationLogsOptions extends ListActivationLogsOptionsIdentifierOneOf {
|
|
1240
1204
|
/** From created date, If not specified, defaults to 30 days before the current time. */
|
|
1241
1205
|
fromCreatedDate?: Date | null;
|
|
1242
1206
|
/** To created date, If not specified, defaults to current time. */
|
|
@@ -1253,32 +1217,13 @@ export interface ListActivationLogsOptions extends ListActivationLogsOptionsIden
|
|
|
1253
1217
|
preinstalledIdentifierInfo?: PreinstalledIdentifierInfo;
|
|
1254
1218
|
}
|
|
1255
1219
|
/** @oneof */
|
|
1256
|
-
|
|
1220
|
+
interface ListActivationLogsOptionsIdentifierOneOf {
|
|
1257
1221
|
/** Look up activations by automation id */
|
|
1258
1222
|
automationIdInfo?: AutomationIdInfo;
|
|
1259
1223
|
/** Look up activations by preinstalled identifier */
|
|
1260
1224
|
preinstalledIdentifierInfo?: PreinstalledIdentifierInfo;
|
|
1261
1225
|
}
|
|
1262
|
-
|
|
1263
|
-
* Search activation logs by payload pii value
|
|
1264
|
-
* Entire field value match is supported
|
|
1265
|
-
* Supported are emails, phones and guids
|
|
1266
|
-
* @param value - Value to search in the payload
|
|
1267
|
-
* @public
|
|
1268
|
-
* @documentationMaturity preview
|
|
1269
|
-
* @requiredField value
|
|
1270
|
-
* @permissionId AUTOMATIONS.ACTIVATION_LOG_READ
|
|
1271
|
-
* @permissionScope Manage Stores
|
|
1272
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1273
|
-
* @permissionScope Set Up Automations
|
|
1274
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1275
|
-
* @applicableIdentity APP
|
|
1276
|
-
* @fqn wix.automations.activation_logs.v1.ActivationLogsService.SearchActivationLogsByPayloadPiiValue
|
|
1277
|
-
*/
|
|
1278
|
-
export declare function searchActivationLogsByPayloadPiiValue(value: string, options?: SearchActivationLogsByPayloadPiiValueOptions): Promise<NonNullablePaths<SearchActivationLogsByPayloadPiiValueResponse, {
|
|
1279
|
-
[P in ActivationLogNonNullablePaths]: `activationLogs.${number}.${P}`;
|
|
1280
|
-
}[ActivationLogNonNullablePaths]>>;
|
|
1281
|
-
export interface SearchActivationLogsByPayloadPiiValueOptions extends SearchActivationLogsByPayloadPiiValueOptionsFilterOptionOneOf {
|
|
1226
|
+
interface SearchActivationLogsByPayloadPiiValueOptions extends SearchActivationLogsByPayloadPiiValueOptionsFilterOptionOneOf {
|
|
1282
1227
|
/** Paging */
|
|
1283
1228
|
cursorPaging?: CursorPaging;
|
|
1284
1229
|
/** Should return payload in the response */
|
|
@@ -1295,10 +1240,11 @@ export interface SearchActivationLogsByPayloadPiiValueOptions extends SearchActi
|
|
|
1295
1240
|
toCreatedDate?: Date | null;
|
|
1296
1241
|
}
|
|
1297
1242
|
/** @oneof */
|
|
1298
|
-
|
|
1243
|
+
interface SearchActivationLogsByPayloadPiiValueOptionsFilterOptionOneOf {
|
|
1299
1244
|
/** Filter activations by value and automation id */
|
|
1300
1245
|
automationIdInfo?: AutomationIdInfo;
|
|
1301
1246
|
/** Filter activations by value and preinstalled */
|
|
1302
1247
|
preinstalledIdentifierInfo?: PreinstalledIdentifierInfo;
|
|
1303
1248
|
}
|
|
1304
|
-
|
|
1249
|
+
|
|
1250
|
+
export { type AppDefinedAction as $, type ActivationLog as A, type ActivationContinuedAfterSchedule as B, CancellationReason as C, Domain as D, ErrorReason as E, FilterBy as F, type Automation as G, type AutomationOriginInfoOneOf as H, IdentifierType as I, type ActionSettings as J, type Enrichment as K, type ListActivationLogsOptions as L, type AuditInfo as M, type AuditInfoIdOneOf as N, Operator as O, type AutomationConfiguration as P, type Filter as Q, type RestoreInfo as R, type SearchActivationLogsByPayloadPiiValueOptions as S, Target as T, type FutureDateActivationOffset as U, type RateLimit as V, WarningReason as W, type FilterValueSelection as X, type ConditionExpressionGroup as Y, type CodeSnippet as Z, type Path as _, type ListActivationLogsResponse as a, type ConditionAction as a0, type CodeConditionAction as a1, type DelayAction as a2, type RateLimitAction as a3, type SetVariablesAction as a4, type OutputAction as a5, type SplitAction as a6, type Trigger as a7, type Action as a8, type ActionInfoOneOf as a9, type FilterableAppDefinedActions as aa, type ApplicationOrigin as ab, type PreinstalledOrigin as ac, type AutomationSettings as ad, type DraftInfo as ae, type Enrichments as af, type ExtendedFields as ag, type UouDeleteRequest as ah, type ClientEntityIdsByNamespace as ai, type GetActivationLogRequest as aj, type GetActivationLogResponse as ak, type ListActivationLogsRequest as al, type ListActivationLogsRequestIdentifierOneOf as am, type CursorPaging as an, type AutomationIdInfo as ao, type PreinstalledIdentifierInfo as ap, type CursorPagingMetadata as aq, type Cursors as ar, type SearchActivationLogsByPayloadPiiValueRequest as as, type SearchActivationLogsByPayloadPiiValueRequestFilterOptionOneOf as at, type MessageEnvelope as au, type IdentificationData as av, type IdentificationDataIdOneOf as aw, type ListActivationLogsOptionsIdentifierOneOf as ax, type SearchActivationLogsByPayloadPiiValueOptionsFilterOptionOneOf as ay, type SearchActivationLogsByPayloadPiiValueResponse as b, SkipReason as c, Status as d, TimeUnit as e, Language as f, Type as g, AutomationConfigurationStatus as h, Origin as i, WebhookIdentityType as j, type Identity as k, type InitiatedStatusInfo as l, type ScheduledStatusInfo as m, type StartedStatusInfo as n, type EndedStatusInfo as o, type CancelledStatusInfo as p, type FailedStatusInfo as q, type SkippedStatusInfo as r, type Warning as s, type DomainEvent as t, type DomainEventBodyOneOf as u, type EntityCreatedEvent as v, type EntityUpdatedEvent as w, type EntityDeletedEvent as x, type ActionEvent as y, type Empty as z };
|