@wix/auto_sdk_automations_automations-v-2 1.0.4 → 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-v2-automation-automations-v-2.universal.d.ts → cjs/automations-v2-automation-automations-v-2.universal-CUoGClWF.d.ts} +220 -567
- package/build/cjs/index.d.ts +202 -1
- package/build/cjs/index.js +1555 -15
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/meta.d.ts +1167 -1
- package/build/cjs/meta.js +960 -15
- package/build/cjs/meta.js.map +1 -1
- package/build/{cjs/src/automations-v2-automation-automations-v-2.universal.d.ts → es/automations-v2-automation-automations-v-2.universal-CUoGClWF.d.mts} +220 -567
- package/build/es/index.d.mts +202 -0
- package/build/es/index.mjs +1494 -0
- package/build/es/index.mjs.map +1 -0
- package/build/es/meta.d.mts +1167 -0
- package/build/es/meta.mjs +920 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/internal/{es/src/automations-v2-automation-automations-v-2.universal.d.ts → cjs/automations-v2-automation-automations-v-2.universal-CUoGClWF.d.ts} +220 -567
- package/build/internal/cjs/index.d.ts +202 -1
- package/build/internal/cjs/index.js +1555 -15
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +1167 -1
- package/build/internal/cjs/meta.js +960 -15
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/{es/src/automations-v2-automation-automations-v-2.universal.d.ts → internal/es/automations-v2-automation-automations-v-2.universal-CUoGClWF.d.mts} +220 -567
- package/build/internal/es/index.d.mts +202 -0
- package/build/internal/es/index.mjs +1494 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +1167 -0
- package/build/internal/es/meta.mjs +920 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/package.json +9 -8
- 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/src/automations-v2-automation-automations-v-2.context.d.ts +0 -37
- package/build/cjs/src/automations-v2-automation-automations-v-2.context.js +0 -61
- package/build/cjs/src/automations-v2-automation-automations-v-2.context.js.map +0 -1
- package/build/cjs/src/automations-v2-automation-automations-v-2.http.d.ts +0 -74
- package/build/cjs/src/automations-v2-automation-automations-v-2.http.js +0 -666
- package/build/cjs/src/automations-v2-automation-automations-v-2.http.js.map +0 -1
- package/build/cjs/src/automations-v2-automation-automations-v-2.meta.d.ts +0 -49
- package/build/cjs/src/automations-v2-automation-automations-v-2.meta.js +0 -351
- package/build/cjs/src/automations-v2-automation-automations-v-2.meta.js.map +0 -1
- package/build/cjs/src/automations-v2-automation-automations-v-2.public.d.ts +0 -172
- package/build/cjs/src/automations-v2-automation-automations-v-2.public.js +0 -167
- package/build/cjs/src/automations-v2-automation-automations-v-2.public.js.map +0 -1
- package/build/cjs/src/automations-v2-automation-automations-v-2.types.d.ts +0 -2223
- package/build/cjs/src/automations-v2-automation-automations-v-2.types.js +0 -276
- package/build/cjs/src/automations-v2-automation-automations-v-2.types.js.map +0 -1
- package/build/cjs/src/automations-v2-automation-automations-v-2.universal.js +0 -1025
- package/build/cjs/src/automations-v2-automation-automations-v-2.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/src/automations-v2-automation-automations-v-2.context.d.ts +0 -37
- package/build/es/src/automations-v2-automation-automations-v-2.context.js +0 -37
- package/build/es/src/automations-v2-automation-automations-v-2.context.js.map +0 -1
- package/build/es/src/automations-v2-automation-automations-v-2.http.d.ts +0 -74
- package/build/es/src/automations-v2-automation-automations-v-2.http.js +0 -646
- package/build/es/src/automations-v2-automation-automations-v-2.http.js.map +0 -1
- package/build/es/src/automations-v2-automation-automations-v-2.meta.d.ts +0 -49
- package/build/es/src/automations-v2-automation-automations-v-2.meta.js +0 -308
- package/build/es/src/automations-v2-automation-automations-v-2.meta.js.map +0 -1
- package/build/es/src/automations-v2-automation-automations-v-2.public.d.ts +0 -172
- package/build/es/src/automations-v2-automation-automations-v-2.public.js +0 -126
- package/build/es/src/automations-v2-automation-automations-v-2.public.js.map +0 -1
- package/build/es/src/automations-v2-automation-automations-v-2.types.d.ts +0 -2223
- package/build/es/src/automations-v2-automation-automations-v-2.types.js +0 -273
- package/build/es/src/automations-v2-automation-automations-v-2.types.js.map +0 -1
- package/build/es/src/automations-v2-automation-automations-v-2.universal.js +0 -982
- package/build/es/src/automations-v2-automation-automations-v-2.universal.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/src/automations-v2-automation-automations-v-2.context.d.ts +0 -37
- package/build/internal/cjs/src/automations-v2-automation-automations-v-2.context.js +0 -61
- package/build/internal/cjs/src/automations-v2-automation-automations-v-2.context.js.map +0 -1
- package/build/internal/cjs/src/automations-v2-automation-automations-v-2.http.d.ts +0 -74
- package/build/internal/cjs/src/automations-v2-automation-automations-v-2.http.js +0 -666
- package/build/internal/cjs/src/automations-v2-automation-automations-v-2.http.js.map +0 -1
- package/build/internal/cjs/src/automations-v2-automation-automations-v-2.meta.d.ts +0 -49
- package/build/internal/cjs/src/automations-v2-automation-automations-v-2.meta.js +0 -351
- package/build/internal/cjs/src/automations-v2-automation-automations-v-2.meta.js.map +0 -1
- package/build/internal/cjs/src/automations-v2-automation-automations-v-2.public.d.ts +0 -172
- package/build/internal/cjs/src/automations-v2-automation-automations-v-2.public.js +0 -167
- package/build/internal/cjs/src/automations-v2-automation-automations-v-2.public.js.map +0 -1
- package/build/internal/cjs/src/automations-v2-automation-automations-v-2.types.d.ts +0 -2223
- package/build/internal/cjs/src/automations-v2-automation-automations-v-2.types.js +0 -276
- package/build/internal/cjs/src/automations-v2-automation-automations-v-2.types.js.map +0 -1
- package/build/internal/cjs/src/automations-v2-automation-automations-v-2.universal.js +0 -1025
- package/build/internal/cjs/src/automations-v2-automation-automations-v-2.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-v2-automation-automations-v-2.context.d.ts +0 -37
- package/build/internal/es/src/automations-v2-automation-automations-v-2.context.js +0 -37
- package/build/internal/es/src/automations-v2-automation-automations-v-2.context.js.map +0 -1
- package/build/internal/es/src/automations-v2-automation-automations-v-2.http.d.ts +0 -74
- package/build/internal/es/src/automations-v2-automation-automations-v-2.http.js +0 -646
- package/build/internal/es/src/automations-v2-automation-automations-v-2.http.js.map +0 -1
- package/build/internal/es/src/automations-v2-automation-automations-v-2.meta.d.ts +0 -49
- package/build/internal/es/src/automations-v2-automation-automations-v-2.meta.js +0 -308
- package/build/internal/es/src/automations-v2-automation-automations-v-2.meta.js.map +0 -1
- package/build/internal/es/src/automations-v2-automation-automations-v-2.public.d.ts +0 -172
- package/build/internal/es/src/automations-v2-automation-automations-v-2.public.js +0 -126
- package/build/internal/es/src/automations-v2-automation-automations-v-2.public.js.map +0 -1
- package/build/internal/es/src/automations-v2-automation-automations-v-2.types.d.ts +0 -2223
- package/build/internal/es/src/automations-v2-automation-automations-v-2.types.js +0 -273
- package/build/internal/es/src/automations-v2-automation-automations-v-2.types.js.map +0 -1
- package/build/internal/es/src/automations-v2-automation-automations-v-2.universal.js +0 -982
- package/build/internal/es/src/automations-v2-automation-automations-v-2.universal.js.map +0 -1
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
export interface Automation extends AutomationOriginInfoOneOf {
|
|
1
|
+
interface Automation extends AutomationOriginInfoOneOf {
|
|
3
2
|
/** When the origin of the automation is `APPLICATION`, the details of the app that created it. */
|
|
4
3
|
applicationInfo?: ApplicationOrigin;
|
|
5
4
|
/** When the origin of the automation is `PREINSTALLED`, the details of the preinstalled automation. */
|
|
@@ -69,13 +68,13 @@ export interface Automation extends AutomationOriginInfoOneOf {
|
|
|
69
68
|
archived?: boolean;
|
|
70
69
|
}
|
|
71
70
|
/** @oneof */
|
|
72
|
-
|
|
71
|
+
interface AutomationOriginInfoOneOf {
|
|
73
72
|
/** When the origin of the automation is `APPLICATION`, the details of the app that created it. */
|
|
74
73
|
applicationInfo?: ApplicationOrigin;
|
|
75
74
|
/** When the origin of the automation is `PREINSTALLED`, the details of the preinstalled automation. */
|
|
76
75
|
preinstalledInfo?: PreinstalledOrigin;
|
|
77
76
|
}
|
|
78
|
-
|
|
77
|
+
interface ActionSettings {
|
|
79
78
|
/**
|
|
80
79
|
* Permanent actions. Permanent actions cannot be deleted.
|
|
81
80
|
*
|
|
@@ -105,7 +104,7 @@ export interface ActionSettings {
|
|
|
105
104
|
*/
|
|
106
105
|
disableConditionAddition?: boolean;
|
|
107
106
|
}
|
|
108
|
-
|
|
107
|
+
declare enum Domain {
|
|
109
108
|
/** User domain (default). */
|
|
110
109
|
USER = "USER",
|
|
111
110
|
/** Wix domain. */
|
|
@@ -113,16 +112,14 @@ export declare enum Domain {
|
|
|
113
112
|
/** Wix account-level domain. */
|
|
114
113
|
WIX_ACCOUNT = "WIX_ACCOUNT"
|
|
115
114
|
}
|
|
116
|
-
|
|
117
|
-
export type DomainWithLiterals = Domain | 'USER' | 'WIX' | 'WIX_ACCOUNT';
|
|
118
|
-
export interface Enrichment {
|
|
115
|
+
interface Enrichment {
|
|
119
116
|
/**
|
|
120
117
|
* Enrichment input mappings.
|
|
121
118
|
* @maxSize 2
|
|
122
119
|
*/
|
|
123
120
|
inputMappings?: Record<string, any>[] | null;
|
|
124
121
|
}
|
|
125
|
-
|
|
122
|
+
interface AuditInfo extends AuditInfoIdOneOf {
|
|
126
123
|
/**
|
|
127
124
|
* [User ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#user-id).
|
|
128
125
|
* @format GUID
|
|
@@ -137,7 +134,7 @@ export interface AuditInfo extends AuditInfoIdOneOf {
|
|
|
137
134
|
appId?: string;
|
|
138
135
|
}
|
|
139
136
|
/** @oneof */
|
|
140
|
-
|
|
137
|
+
interface AuditInfoIdOneOf {
|
|
141
138
|
/**
|
|
142
139
|
* [User ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#user-id).
|
|
143
140
|
* @format GUID
|
|
@@ -151,7 +148,7 @@ export interface AuditInfoIdOneOf {
|
|
|
151
148
|
*/
|
|
152
149
|
appId?: string;
|
|
153
150
|
}
|
|
154
|
-
|
|
151
|
+
interface AutomationConfiguration {
|
|
155
152
|
/** Status of the automation on the site. */
|
|
156
153
|
status?: StatusWithLiterals;
|
|
157
154
|
/** Trigger configuration. */
|
|
@@ -167,7 +164,7 @@ export interface AutomationConfiguration {
|
|
|
167
164
|
/** 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. */
|
|
168
165
|
actions?: Record<string, Action>;
|
|
169
166
|
}
|
|
170
|
-
|
|
167
|
+
declare enum TimeUnit {
|
|
171
168
|
UNKNOWN_TIME_UNIT = "UNKNOWN_TIME_UNIT",
|
|
172
169
|
/** Minutes. */
|
|
173
170
|
MINUTES = "MINUTES",
|
|
@@ -181,8 +178,8 @@ export declare enum TimeUnit {
|
|
|
181
178
|
MONTHS = "MONTHS"
|
|
182
179
|
}
|
|
183
180
|
/** @enumType */
|
|
184
|
-
|
|
185
|
-
|
|
181
|
+
type TimeUnitWithLiterals = TimeUnit | 'UNKNOWN_TIME_UNIT' | 'MINUTES' | 'HOURS' | 'DAYS' | 'WEEKS' | 'MONTHS';
|
|
182
|
+
interface Filter {
|
|
186
183
|
/**
|
|
187
184
|
* Filter ID.
|
|
188
185
|
* @format GUID
|
|
@@ -204,7 +201,7 @@ export interface Filter {
|
|
|
204
201
|
*/
|
|
205
202
|
filterExpression?: string;
|
|
206
203
|
}
|
|
207
|
-
|
|
204
|
+
interface FutureDateActivationOffset {
|
|
208
205
|
/**
|
|
209
206
|
* Amount of time before the trigger to run the automation.
|
|
210
207
|
*
|
|
@@ -215,7 +212,7 @@ export interface FutureDateActivationOffset {
|
|
|
215
212
|
/** Unit in which to set the action offset. */
|
|
216
213
|
scheduledEventOffsetTimeUnit?: TimeUnitWithLiterals;
|
|
217
214
|
}
|
|
218
|
-
|
|
215
|
+
interface RateLimit {
|
|
219
216
|
/**
|
|
220
217
|
* Maximum number of times the trigger can be activated.
|
|
221
218
|
* @maxLength 1000
|
|
@@ -237,7 +234,7 @@ export interface RateLimit {
|
|
|
237
234
|
*/
|
|
238
235
|
uniqueIdentifierExpression?: string | null;
|
|
239
236
|
}
|
|
240
|
-
|
|
237
|
+
interface FilterValueSelection {
|
|
241
238
|
/**
|
|
242
239
|
* Values that can help the user filter certain automations. Specify values in the following format: `<filter_id>__<selected_value>`.
|
|
243
240
|
* @maxLength 80
|
|
@@ -245,7 +242,7 @@ export interface FilterValueSelection {
|
|
|
245
242
|
*/
|
|
246
243
|
selectedFilterValues?: string[];
|
|
247
244
|
}
|
|
248
|
-
|
|
245
|
+
interface ConditionExpressionGroup {
|
|
249
246
|
/** Logical operator used to evaluate the condition expressions. */
|
|
250
247
|
operator?: OperatorWithLiterals;
|
|
251
248
|
/**
|
|
@@ -256,7 +253,7 @@ export interface ConditionExpressionGroup {
|
|
|
256
253
|
*/
|
|
257
254
|
booleanExpressions?: string[];
|
|
258
255
|
}
|
|
259
|
-
|
|
256
|
+
declare enum Operator {
|
|
260
257
|
/** Unknown. */
|
|
261
258
|
UNKNOWN_OPERATOR = "UNKNOWN_OPERATOR",
|
|
262
259
|
/** `OR` operator. */
|
|
@@ -265,9 +262,9 @@ export declare enum Operator {
|
|
|
265
262
|
AND = "AND"
|
|
266
263
|
}
|
|
267
264
|
/** @enumType */
|
|
268
|
-
|
|
265
|
+
type OperatorWithLiterals = Operator | 'UNKNOWN_OPERATOR' | 'OR' | 'AND';
|
|
269
266
|
/** Path definition */
|
|
270
|
-
|
|
267
|
+
interface Path {
|
|
271
268
|
/**
|
|
272
269
|
* Unique path ID.
|
|
273
270
|
* @format GUID
|
|
@@ -285,7 +282,7 @@ export interface Path {
|
|
|
285
282
|
*/
|
|
286
283
|
postActionId?: string | null;
|
|
287
284
|
}
|
|
288
|
-
|
|
285
|
+
declare enum Type {
|
|
289
286
|
/** Based on the trigger. */
|
|
290
287
|
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
291
288
|
/** 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. */
|
|
@@ -298,8 +295,8 @@ export declare enum Type {
|
|
|
298
295
|
RATE_LIMIT = "RATE_LIMIT"
|
|
299
296
|
}
|
|
300
297
|
/** @enumType */
|
|
301
|
-
|
|
302
|
-
|
|
298
|
+
type TypeWithLiterals = Type | 'UNKNOWN_ACTION_TYPE' | 'APP_DEFINED' | 'CONDITION' | 'DELAY' | 'RATE_LIMIT';
|
|
299
|
+
interface AppDefinedAction {
|
|
303
300
|
/**
|
|
304
301
|
* ID of the app that defines the action.
|
|
305
302
|
* @format GUID
|
|
@@ -329,7 +326,7 @@ export interface AppDefinedAction {
|
|
|
329
326
|
/** Action output schema. When specified, this replaces the action schema. */
|
|
330
327
|
overrideOutputSchema?: Record<string, any> | null;
|
|
331
328
|
}
|
|
332
|
-
|
|
329
|
+
interface ConditionAction {
|
|
333
330
|
/**
|
|
334
331
|
* Condition is `true` if one or more of the expression groups evaluates to `true`.
|
|
335
332
|
* @minSize 1
|
|
@@ -349,7 +346,7 @@ export interface ConditionAction {
|
|
|
349
346
|
*/
|
|
350
347
|
falsePostActionIds?: string[];
|
|
351
348
|
}
|
|
352
|
-
|
|
349
|
+
interface DelayAction {
|
|
353
350
|
/**
|
|
354
351
|
* Time to wait before running the action. The wait time starts from when the current action completes.
|
|
355
352
|
*
|
|
@@ -373,7 +370,7 @@ export interface DelayAction {
|
|
|
373
370
|
*/
|
|
374
371
|
postActionIds?: string[];
|
|
375
372
|
}
|
|
376
|
-
|
|
373
|
+
interface RateLimitAction {
|
|
377
374
|
/**
|
|
378
375
|
* Maximum number of times the action can run.
|
|
379
376
|
* @maxLength 1000
|
|
@@ -401,7 +398,7 @@ export interface RateLimitAction {
|
|
|
401
398
|
*/
|
|
402
399
|
postActionIds?: string[];
|
|
403
400
|
}
|
|
404
|
-
|
|
401
|
+
interface SetVariablesAction {
|
|
405
402
|
/** Output mapping. For example: `{"someField": "{{10}}", "someOtherField": "{{multiply( var('account.points.balance') ;2 )}}" }`. */
|
|
406
403
|
outputMapping?: Record<string, any> | null;
|
|
407
404
|
/**
|
|
@@ -417,11 +414,11 @@ export interface SetVariablesAction {
|
|
|
417
414
|
*/
|
|
418
415
|
postActionIds?: string[];
|
|
419
416
|
}
|
|
420
|
-
|
|
417
|
+
interface OutputAction {
|
|
421
418
|
/** Output action output mapping. */
|
|
422
419
|
outputMapping?: Record<string, any> | null;
|
|
423
420
|
}
|
|
424
|
-
|
|
421
|
+
interface SplitAction {
|
|
425
422
|
/**
|
|
426
423
|
* List of paths to split execution into.
|
|
427
424
|
* @minSize 2
|
|
@@ -429,7 +426,7 @@ export interface SplitAction {
|
|
|
429
426
|
*/
|
|
430
427
|
paths?: Path[];
|
|
431
428
|
}
|
|
432
|
-
|
|
429
|
+
declare enum Status {
|
|
433
430
|
/** Unknown. */
|
|
434
431
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
435
432
|
/** Active. Active automations can be triggered. */
|
|
@@ -438,8 +435,8 @@ export declare enum Status {
|
|
|
438
435
|
INACTIVE = "INACTIVE"
|
|
439
436
|
}
|
|
440
437
|
/** @enumType */
|
|
441
|
-
|
|
442
|
-
|
|
438
|
+
type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'ACTIVE' | 'INACTIVE';
|
|
439
|
+
interface Trigger {
|
|
443
440
|
/**
|
|
444
441
|
* ID of the app that defines the trigger.
|
|
445
442
|
* @format GUID
|
|
@@ -471,7 +468,7 @@ export interface Trigger {
|
|
|
471
468
|
/** Trigger schema override. When specified, this replaces the trigger schema. */
|
|
472
469
|
overrideSchema?: Record<string, any> | null;
|
|
473
470
|
}
|
|
474
|
-
|
|
471
|
+
interface Action extends ActionInfoOneOf {
|
|
475
472
|
/** Details of the action when its `type` is `APP_DEFINED`. */
|
|
476
473
|
appDefinedInfo?: AppDefinedAction;
|
|
477
474
|
/** Details of the action when its `type` is `CONDITION`. */
|
|
@@ -501,7 +498,7 @@ export interface Action extends ActionInfoOneOf {
|
|
|
501
498
|
namespace?: string | null;
|
|
502
499
|
}
|
|
503
500
|
/** @oneof */
|
|
504
|
-
|
|
501
|
+
interface ActionInfoOneOf {
|
|
505
502
|
/** Details of the action when its `type` is `APP_DEFINED`. */
|
|
506
503
|
appDefinedInfo?: AppDefinedAction;
|
|
507
504
|
/** Details of the action when its `type` is `CONDITION`. */
|
|
@@ -513,7 +510,7 @@ export interface ActionInfoOneOf {
|
|
|
513
510
|
/** Details of the action when its `type` is `RATE_LIMIT`. */
|
|
514
511
|
rateLimitInfo?: RateLimitAction;
|
|
515
512
|
}
|
|
516
|
-
|
|
513
|
+
interface FilterableAppDefinedActions {
|
|
517
514
|
/**
|
|
518
515
|
* App-defined action identifiers. Identifiers have the following format: `${appId}_${actionKey}`.
|
|
519
516
|
* @minSize 1
|
|
@@ -523,7 +520,7 @@ export interface FilterableAppDefinedActions {
|
|
|
523
520
|
*/
|
|
524
521
|
actionIdentifiers?: string[];
|
|
525
522
|
}
|
|
526
|
-
|
|
523
|
+
declare enum Origin {
|
|
527
524
|
/** Default value. */
|
|
528
525
|
UNKNOWN_ORIGIN = "UNKNOWN_ORIGIN",
|
|
529
526
|
/** Created by a [Wix user](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#wix-user). */
|
|
@@ -534,8 +531,8 @@ export declare enum Origin {
|
|
|
534
531
|
PREINSTALLED = "PREINSTALLED"
|
|
535
532
|
}
|
|
536
533
|
/** @enumType */
|
|
537
|
-
|
|
538
|
-
|
|
534
|
+
type OriginWithLiterals = Origin | 'UNKNOWN_ORIGIN' | 'USER' | 'APPLICATION' | 'PREINSTALLED';
|
|
535
|
+
interface ApplicationOrigin {
|
|
539
536
|
/**
|
|
540
537
|
* [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
|
|
541
538
|
*
|
|
@@ -544,7 +541,7 @@ export interface ApplicationOrigin {
|
|
|
544
541
|
*/
|
|
545
542
|
appId?: string;
|
|
546
543
|
}
|
|
547
|
-
|
|
544
|
+
interface PreinstalledOrigin {
|
|
548
545
|
/**
|
|
549
546
|
* 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).
|
|
550
547
|
* @format GUID
|
|
@@ -565,7 +562,7 @@ export interface PreinstalledOrigin {
|
|
|
565
562
|
*/
|
|
566
563
|
override?: boolean | null;
|
|
567
564
|
}
|
|
568
|
-
|
|
565
|
+
interface AutomationSettings {
|
|
569
566
|
/**
|
|
570
567
|
* Whether the automation is hidden from users.
|
|
571
568
|
*
|
|
@@ -593,7 +590,7 @@ export interface AutomationSettings {
|
|
|
593
590
|
/** Automation action settings. */
|
|
594
591
|
actionSettings?: ActionSettings;
|
|
595
592
|
}
|
|
596
|
-
|
|
593
|
+
interface DraftInfo {
|
|
597
594
|
/**
|
|
598
595
|
* ID of the original automation.
|
|
599
596
|
* @format GUID
|
|
@@ -601,11 +598,11 @@ export interface DraftInfo {
|
|
|
601
598
|
*/
|
|
602
599
|
originalAutomationId?: string | null;
|
|
603
600
|
}
|
|
604
|
-
|
|
601
|
+
interface Enrichments {
|
|
605
602
|
/** Whether the studio site enrichment is wanted. */
|
|
606
603
|
studioSite?: Enrichment;
|
|
607
604
|
}
|
|
608
|
-
|
|
605
|
+
interface ExtendedFields {
|
|
609
606
|
/**
|
|
610
607
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
611
608
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -616,7 +613,7 @@ export interface ExtendedFields {
|
|
|
616
613
|
*/
|
|
617
614
|
namespaces?: Record<string, Record<string, any>>;
|
|
618
615
|
}
|
|
619
|
-
|
|
616
|
+
interface AutomationMigrationRequest {
|
|
620
617
|
/**
|
|
621
618
|
* Automation id
|
|
622
619
|
* @format GUID
|
|
@@ -641,17 +638,17 @@ export interface AutomationMigrationRequest {
|
|
|
641
638
|
*/
|
|
642
639
|
jobId?: string;
|
|
643
640
|
}
|
|
644
|
-
|
|
641
|
+
interface UpdatedWithPreviousEntity {
|
|
645
642
|
/** Previous automation. */
|
|
646
643
|
previousAutomation?: Automation;
|
|
647
644
|
/** Updated automation. */
|
|
648
645
|
currentAutomation?: Automation;
|
|
649
646
|
}
|
|
650
|
-
|
|
647
|
+
interface DeletedWithEntity {
|
|
651
648
|
/** Deleted automation. */
|
|
652
649
|
automation?: Automation;
|
|
653
650
|
}
|
|
654
|
-
|
|
651
|
+
interface DraftPublished {
|
|
655
652
|
/**
|
|
656
653
|
* ID of the draft automation.
|
|
657
654
|
* @format GUID
|
|
@@ -666,7 +663,7 @@ export interface DraftPublished {
|
|
|
666
663
|
/** Updated, published automation. */
|
|
667
664
|
updatedAutomation?: Automation;
|
|
668
665
|
}
|
|
669
|
-
|
|
666
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
670
667
|
createdEvent?: EntityCreatedEvent;
|
|
671
668
|
updatedEvent?: EntityUpdatedEvent;
|
|
672
669
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -701,19 +698,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
701
698
|
entityEventSequence?: string | null;
|
|
702
699
|
}
|
|
703
700
|
/** @oneof */
|
|
704
|
-
|
|
701
|
+
interface DomainEventBodyOneOf {
|
|
705
702
|
createdEvent?: EntityCreatedEvent;
|
|
706
703
|
updatedEvent?: EntityUpdatedEvent;
|
|
707
704
|
deletedEvent?: EntityDeletedEvent;
|
|
708
705
|
actionEvent?: ActionEvent;
|
|
709
706
|
}
|
|
710
|
-
|
|
707
|
+
interface EntityCreatedEvent {
|
|
711
708
|
entity?: string;
|
|
712
709
|
}
|
|
713
|
-
|
|
710
|
+
interface RestoreInfo {
|
|
714
711
|
deletedDate?: Date | null;
|
|
715
712
|
}
|
|
716
|
-
|
|
713
|
+
interface EntityUpdatedEvent {
|
|
717
714
|
/**
|
|
718
715
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
719
716
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -721,16 +718,16 @@ export interface EntityUpdatedEvent {
|
|
|
721
718
|
*/
|
|
722
719
|
currentEntity?: string;
|
|
723
720
|
}
|
|
724
|
-
|
|
721
|
+
interface EntityDeletedEvent {
|
|
725
722
|
/** Entity that was deleted. */
|
|
726
723
|
deletedEntity?: string | null;
|
|
727
724
|
}
|
|
728
|
-
|
|
725
|
+
interface ActionEvent {
|
|
729
726
|
body?: string;
|
|
730
727
|
}
|
|
731
|
-
|
|
728
|
+
interface Empty {
|
|
732
729
|
}
|
|
733
|
-
|
|
730
|
+
interface UpdateApplicationAutomationsRequest {
|
|
734
731
|
/** Automation to use for updating other automations. */
|
|
735
732
|
automation?: Automation;
|
|
736
733
|
/**
|
|
@@ -752,14 +749,14 @@ export interface UpdateApplicationAutomationsRequest {
|
|
|
752
749
|
/** True if the update should override the trigger. */
|
|
753
750
|
overrideTrigger?: boolean;
|
|
754
751
|
}
|
|
755
|
-
|
|
752
|
+
interface UpdateApplicationAutomationsResponse {
|
|
756
753
|
/**
|
|
757
754
|
* Job id for the update process.
|
|
758
755
|
* @format GUID
|
|
759
756
|
*/
|
|
760
757
|
jobId?: string;
|
|
761
758
|
}
|
|
762
|
-
|
|
759
|
+
interface TestUpdateApplicationAutomationRequest {
|
|
763
760
|
/** Automation to use for updating the test automation. */
|
|
764
761
|
automation?: Automation;
|
|
765
762
|
/**
|
|
@@ -786,11 +783,11 @@ export interface TestUpdateApplicationAutomationRequest {
|
|
|
786
783
|
/** True if the update should override the trigger. */
|
|
787
784
|
overrideTrigger?: boolean;
|
|
788
785
|
}
|
|
789
|
-
|
|
786
|
+
interface TestUpdateApplicationAutomationResponse {
|
|
790
787
|
/** The automation after the update. */
|
|
791
788
|
automation?: Automation;
|
|
792
789
|
}
|
|
793
|
-
|
|
790
|
+
interface MessageEnvelope {
|
|
794
791
|
/**
|
|
795
792
|
* App instance ID.
|
|
796
793
|
* @format GUID
|
|
@@ -806,7 +803,7 @@ export interface MessageEnvelope {
|
|
|
806
803
|
/** Stringify payload. */
|
|
807
804
|
data?: string;
|
|
808
805
|
}
|
|
809
|
-
|
|
806
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
810
807
|
/**
|
|
811
808
|
* ID of a site visitor that has not logged in to the site.
|
|
812
809
|
* @format GUID
|
|
@@ -831,7 +828,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
831
828
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
832
829
|
}
|
|
833
830
|
/** @oneof */
|
|
834
|
-
|
|
831
|
+
interface IdentificationDataIdOneOf {
|
|
835
832
|
/**
|
|
836
833
|
* ID of a site visitor that has not logged in to the site.
|
|
837
834
|
* @format GUID
|
|
@@ -853,7 +850,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
853
850
|
*/
|
|
854
851
|
appId?: string;
|
|
855
852
|
}
|
|
856
|
-
|
|
853
|
+
declare enum WebhookIdentityType {
|
|
857
854
|
UNKNOWN = "UNKNOWN",
|
|
858
855
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
859
856
|
MEMBER = "MEMBER",
|
|
@@ -861,8 +858,8 @@ export declare enum WebhookIdentityType {
|
|
|
861
858
|
APP = "APP"
|
|
862
859
|
}
|
|
863
860
|
/** @enumType */
|
|
864
|
-
|
|
865
|
-
|
|
861
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
862
|
+
interface CodeSnippet {
|
|
866
863
|
/** Logical operator used to evaluate the condition expressions. */
|
|
867
864
|
language?: LanguageWithLiterals;
|
|
868
865
|
/**
|
|
@@ -871,15 +868,15 @@ export interface CodeSnippet {
|
|
|
871
868
|
*/
|
|
872
869
|
code?: string;
|
|
873
870
|
}
|
|
874
|
-
|
|
871
|
+
declare enum Language {
|
|
875
872
|
/** Unknown. */
|
|
876
873
|
UNKNOWN_LANGUAGE = "UNKNOWN_LANGUAGE",
|
|
877
874
|
/** `JAVASCRIPT` language. */
|
|
878
875
|
JAVASCRIPT = "JAVASCRIPT"
|
|
879
876
|
}
|
|
880
877
|
/** @enumType */
|
|
881
|
-
|
|
882
|
-
|
|
878
|
+
type LanguageWithLiterals = Language | 'UNKNOWN_LANGUAGE' | 'JAVASCRIPT';
|
|
879
|
+
interface CodeConditionAction {
|
|
883
880
|
/** 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. */
|
|
884
881
|
snippet?: CodeSnippet;
|
|
885
882
|
/**
|
|
@@ -895,50 +892,50 @@ export interface CodeConditionAction {
|
|
|
895
892
|
*/
|
|
896
893
|
falsePostActionIds?: string[];
|
|
897
894
|
}
|
|
898
|
-
|
|
895
|
+
interface CreateAutomationRequest {
|
|
899
896
|
/** Automation to create. */
|
|
900
897
|
automation: Automation;
|
|
901
898
|
}
|
|
902
|
-
|
|
899
|
+
declare enum RequestedFields {
|
|
903
900
|
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
904
901
|
/** whether to return in response `configuration.trigger.override_output_schema` field and in `configuration.actions` the `override_output_schema` field */
|
|
905
902
|
OVERRIDE_SCHEMA = "OVERRIDE_SCHEMA"
|
|
906
903
|
}
|
|
907
904
|
/** @enumType */
|
|
908
|
-
|
|
909
|
-
|
|
905
|
+
type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'OVERRIDE_SCHEMA';
|
|
906
|
+
interface CreateAutomationResponse {
|
|
910
907
|
/** Details of the created automation. */
|
|
911
908
|
automation?: Automation;
|
|
912
909
|
}
|
|
913
|
-
|
|
910
|
+
interface GetAutomationRequest {
|
|
914
911
|
/**
|
|
915
912
|
* Automation ID.
|
|
916
913
|
* @format GUID
|
|
917
914
|
*/
|
|
918
915
|
automationId: string;
|
|
919
916
|
}
|
|
920
|
-
|
|
917
|
+
interface GetAutomationResponse {
|
|
921
918
|
/** Retrieved automation. */
|
|
922
919
|
automation?: Automation;
|
|
923
920
|
}
|
|
924
|
-
|
|
921
|
+
interface UpdateAutomationRequest {
|
|
925
922
|
/** Automation to update. */
|
|
926
923
|
automation: Automation;
|
|
927
924
|
}
|
|
928
|
-
|
|
925
|
+
interface UpdateAutomationResponse {
|
|
929
926
|
/** Updated automation. */
|
|
930
927
|
automation?: Automation;
|
|
931
928
|
}
|
|
932
|
-
|
|
929
|
+
interface DeleteAutomationRequest {
|
|
933
930
|
/**
|
|
934
931
|
* Automation ID.
|
|
935
932
|
* @format GUID
|
|
936
933
|
*/
|
|
937
934
|
automationId: string;
|
|
938
935
|
}
|
|
939
|
-
|
|
936
|
+
interface DeleteAutomationResponse {
|
|
940
937
|
}
|
|
941
|
-
|
|
938
|
+
interface BulkDeleteAutomationsRequest {
|
|
942
939
|
/**
|
|
943
940
|
* IDs of the automations to delete.
|
|
944
941
|
* @format GUID
|
|
@@ -947,7 +944,7 @@ export interface BulkDeleteAutomationsRequest {
|
|
|
947
944
|
*/
|
|
948
945
|
automationIds: string[];
|
|
949
946
|
}
|
|
950
|
-
|
|
947
|
+
interface BulkDeleteAutomationsResponse {
|
|
951
948
|
/**
|
|
952
949
|
* Results of the bulk deletion.
|
|
953
950
|
* @minSize 1
|
|
@@ -957,11 +954,11 @@ export interface BulkDeleteAutomationsResponse {
|
|
|
957
954
|
/** Metadata for the API call. */
|
|
958
955
|
bulkActionMetadata?: BulkActionMetadata;
|
|
959
956
|
}
|
|
960
|
-
|
|
957
|
+
interface BulkDeleteResult {
|
|
961
958
|
/** Deleted item metadata. */
|
|
962
959
|
itemMetadata?: ItemMetadata;
|
|
963
960
|
}
|
|
964
|
-
|
|
961
|
+
interface ItemMetadata {
|
|
965
962
|
/**
|
|
966
963
|
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
967
964
|
* @format GUID
|
|
@@ -974,7 +971,7 @@ export interface ItemMetadata {
|
|
|
974
971
|
/** Details about the error in case of failure. */
|
|
975
972
|
error?: ApplicationError;
|
|
976
973
|
}
|
|
977
|
-
|
|
974
|
+
interface ApplicationError {
|
|
978
975
|
/** Error code. */
|
|
979
976
|
code?: string;
|
|
980
977
|
/** Description of the error. */
|
|
@@ -982,7 +979,7 @@ export interface ApplicationError {
|
|
|
982
979
|
/** Data related to the error. */
|
|
983
980
|
data?: Record<string, any> | null;
|
|
984
981
|
}
|
|
985
|
-
|
|
982
|
+
interface BulkActionMetadata {
|
|
986
983
|
/** Number of items that were successfully processed. */
|
|
987
984
|
totalSuccesses?: number;
|
|
988
985
|
/** Number of items that couldn't be processed. */
|
|
@@ -990,7 +987,7 @@ export interface BulkActionMetadata {
|
|
|
990
987
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
991
988
|
undetailedFailures?: number;
|
|
992
989
|
}
|
|
993
|
-
|
|
990
|
+
interface CreatePreinstalledAutomationRequest {
|
|
994
991
|
/** Preinstalled automation to create. */
|
|
995
992
|
automation?: Automation;
|
|
996
993
|
/**
|
|
@@ -1013,7 +1010,7 @@ export interface CreatePreinstalledAutomationRequest {
|
|
|
1013
1010
|
*/
|
|
1014
1011
|
appId?: string;
|
|
1015
1012
|
}
|
|
1016
|
-
|
|
1013
|
+
interface PreinstalledAutomationSpecInfo {
|
|
1017
1014
|
/**
|
|
1018
1015
|
* Spec to conduct on for the automation.
|
|
1019
1016
|
*
|
|
@@ -1033,7 +1030,7 @@ export interface PreinstalledAutomationSpecInfo {
|
|
|
1033
1030
|
*/
|
|
1034
1031
|
experimentVersion?: number;
|
|
1035
1032
|
}
|
|
1036
|
-
|
|
1033
|
+
interface OriginAutomationInfo {
|
|
1037
1034
|
/**
|
|
1038
1035
|
* ID of the original automation.
|
|
1039
1036
|
* @format GUID
|
|
@@ -1045,11 +1042,11 @@ export interface OriginAutomationInfo {
|
|
|
1045
1042
|
*/
|
|
1046
1043
|
metaSiteId?: string;
|
|
1047
1044
|
}
|
|
1048
|
-
|
|
1045
|
+
interface CreatePreinstalledAutomationResponse {
|
|
1049
1046
|
/** Details of the created preinstalled automation. */
|
|
1050
1047
|
automation?: Automation;
|
|
1051
1048
|
}
|
|
1052
|
-
|
|
1049
|
+
interface UpdatePreinstalledAutomationRequest {
|
|
1053
1050
|
/** Preinstalled automation to update. */
|
|
1054
1051
|
automation?: Automation;
|
|
1055
1052
|
/**
|
|
@@ -1064,11 +1061,11 @@ export interface UpdatePreinstalledAutomationRequest {
|
|
|
1064
1061
|
*/
|
|
1065
1062
|
appId?: string;
|
|
1066
1063
|
}
|
|
1067
|
-
|
|
1064
|
+
interface UpdatePreinstalledAutomationResponse {
|
|
1068
1065
|
/** Updated preinstalled automation. */
|
|
1069
1066
|
automation?: Automation;
|
|
1070
1067
|
}
|
|
1071
|
-
|
|
1068
|
+
interface DeletePreinstalledAutomationRequest {
|
|
1072
1069
|
/**
|
|
1073
1070
|
* ID of the preinstalled component.
|
|
1074
1071
|
* @format GUID
|
|
@@ -1087,9 +1084,9 @@ export interface DeletePreinstalledAutomationRequest {
|
|
|
1087
1084
|
*/
|
|
1088
1085
|
appId?: string;
|
|
1089
1086
|
}
|
|
1090
|
-
|
|
1087
|
+
interface DeletePreinstalledAutomationResponse {
|
|
1091
1088
|
}
|
|
1092
|
-
|
|
1089
|
+
interface GeneratePreinstalledAutomationRequest {
|
|
1093
1090
|
/** Automation. */
|
|
1094
1091
|
automation: Automation;
|
|
1095
1092
|
/**
|
|
@@ -1098,11 +1095,11 @@ export interface GeneratePreinstalledAutomationRequest {
|
|
|
1098
1095
|
*/
|
|
1099
1096
|
appId?: string;
|
|
1100
1097
|
}
|
|
1101
|
-
|
|
1098
|
+
interface GeneratePreinstalledAutomationResponse {
|
|
1102
1099
|
/** Automation. */
|
|
1103
1100
|
automation?: Automation;
|
|
1104
1101
|
}
|
|
1105
|
-
|
|
1102
|
+
interface QueryPreinstalledAutomationsForAppRequest {
|
|
1106
1103
|
/**
|
|
1107
1104
|
* Query.
|
|
1108
1105
|
*
|
|
@@ -1115,7 +1112,7 @@ export interface QueryPreinstalledAutomationsForAppRequest {
|
|
|
1115
1112
|
*/
|
|
1116
1113
|
appId?: string;
|
|
1117
1114
|
}
|
|
1118
|
-
|
|
1115
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1119
1116
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
1120
1117
|
cursorPaging?: CursorPaging;
|
|
1121
1118
|
/**
|
|
@@ -1136,11 +1133,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
1136
1133
|
sort?: Sorting[];
|
|
1137
1134
|
}
|
|
1138
1135
|
/** @oneof */
|
|
1139
|
-
|
|
1136
|
+
interface CursorQueryPagingMethodOneOf {
|
|
1140
1137
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
1141
1138
|
cursorPaging?: CursorPaging;
|
|
1142
1139
|
}
|
|
1143
|
-
|
|
1140
|
+
interface Sorting {
|
|
1144
1141
|
/**
|
|
1145
1142
|
* Name of the field to sort by.
|
|
1146
1143
|
* @maxLength 512
|
|
@@ -1149,13 +1146,13 @@ export interface Sorting {
|
|
|
1149
1146
|
/** Sort order. */
|
|
1150
1147
|
order?: SortOrderWithLiterals;
|
|
1151
1148
|
}
|
|
1152
|
-
|
|
1149
|
+
declare enum SortOrder {
|
|
1153
1150
|
ASC = "ASC",
|
|
1154
1151
|
DESC = "DESC"
|
|
1155
1152
|
}
|
|
1156
1153
|
/** @enumType */
|
|
1157
|
-
|
|
1158
|
-
|
|
1154
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1155
|
+
interface CursorPaging {
|
|
1159
1156
|
/**
|
|
1160
1157
|
* Maximum number of items to return in the results.
|
|
1161
1158
|
* @max 500
|
|
@@ -1170,13 +1167,13 @@ export interface CursorPaging {
|
|
|
1170
1167
|
*/
|
|
1171
1168
|
cursor?: string | null;
|
|
1172
1169
|
}
|
|
1173
|
-
|
|
1170
|
+
interface QueryPreinstalledAutomationsForAppResponse {
|
|
1174
1171
|
/** Automations. */
|
|
1175
1172
|
automations?: Automation[];
|
|
1176
1173
|
/** Paging metadata. */
|
|
1177
1174
|
pagingMetadata?: CursorPagingMetadata;
|
|
1178
1175
|
}
|
|
1179
|
-
|
|
1176
|
+
interface CursorPagingMetadata {
|
|
1180
1177
|
/** Number of items returned in the response. */
|
|
1181
1178
|
count?: number | null;
|
|
1182
1179
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -1189,7 +1186,7 @@ export interface CursorPagingMetadata {
|
|
|
1189
1186
|
*/
|
|
1190
1187
|
hasNext?: boolean | null;
|
|
1191
1188
|
}
|
|
1192
|
-
|
|
1189
|
+
interface Cursors {
|
|
1193
1190
|
/**
|
|
1194
1191
|
* Cursor string pointing to the next page in the list of results.
|
|
1195
1192
|
* @maxLength 64000
|
|
@@ -1201,7 +1198,7 @@ export interface Cursors {
|
|
|
1201
1198
|
*/
|
|
1202
1199
|
prev?: string | null;
|
|
1203
1200
|
}
|
|
1204
|
-
|
|
1201
|
+
interface QueryAutomationsRequest {
|
|
1205
1202
|
/**
|
|
1206
1203
|
* Query.
|
|
1207
1204
|
*
|
|
@@ -1211,13 +1208,13 @@ export interface QueryAutomationsRequest {
|
|
|
1211
1208
|
*/
|
|
1212
1209
|
query?: CursorQuery;
|
|
1213
1210
|
}
|
|
1214
|
-
|
|
1211
|
+
interface QueryAutomationsResponse {
|
|
1215
1212
|
/** Automations. */
|
|
1216
1213
|
automations?: Automation[];
|
|
1217
1214
|
/** Paging metadata. */
|
|
1218
1215
|
pagingMetadata?: CursorPagingMetadata;
|
|
1219
1216
|
}
|
|
1220
|
-
|
|
1217
|
+
interface GetAggregatedUsageInfoRequest {
|
|
1221
1218
|
/**
|
|
1222
1219
|
* Filter in the following format:
|
|
1223
1220
|
*
|
|
@@ -1231,13 +1228,13 @@ export interface GetAggregatedUsageInfoRequest {
|
|
|
1231
1228
|
*/
|
|
1232
1229
|
filter?: Record<string, any> | null;
|
|
1233
1230
|
}
|
|
1234
|
-
|
|
1231
|
+
interface GetAggregatedUsageInfoResponse {
|
|
1235
1232
|
/** Triggers in use. */
|
|
1236
1233
|
triggersUsageSummary?: TriggerUsageSummary[];
|
|
1237
1234
|
/** Actions in use */
|
|
1238
1235
|
actionsUsageSummary?: ActionUsageSummary[];
|
|
1239
1236
|
}
|
|
1240
|
-
|
|
1237
|
+
interface TriggerUsageSummary {
|
|
1241
1238
|
/**
|
|
1242
1239
|
* ID of the app that defined the trigger.
|
|
1243
1240
|
* @format GUID
|
|
@@ -1252,7 +1249,7 @@ export interface TriggerUsageSummary {
|
|
|
1252
1249
|
/** Number of automations that include this trigger. */
|
|
1253
1250
|
automationsCount?: number;
|
|
1254
1251
|
}
|
|
1255
|
-
|
|
1252
|
+
interface ActionUsageSummary {
|
|
1256
1253
|
/**
|
|
1257
1254
|
* ID of the app that defined the action.
|
|
1258
1255
|
* @format GUID
|
|
@@ -1267,7 +1264,7 @@ export interface ActionUsageSummary {
|
|
|
1267
1264
|
/** Number of automations that include this action. */
|
|
1268
1265
|
automationsCount?: number;
|
|
1269
1266
|
}
|
|
1270
|
-
|
|
1267
|
+
interface CopyAutomationRequest {
|
|
1271
1268
|
/**
|
|
1272
1269
|
* ID of the automation to copy.
|
|
1273
1270
|
* @format GUID
|
|
@@ -1278,11 +1275,11 @@ export interface CopyAutomationRequest {
|
|
|
1278
1275
|
/** Automation to copy. Skips fetching by ID. */
|
|
1279
1276
|
automation?: Automation;
|
|
1280
1277
|
}
|
|
1281
|
-
|
|
1278
|
+
interface CopyAutomationResponse {
|
|
1282
1279
|
/** Copy of the automation. */
|
|
1283
1280
|
automation?: Automation;
|
|
1284
1281
|
}
|
|
1285
|
-
|
|
1282
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
1286
1283
|
/** Emitted on a meta site creation. */
|
|
1287
1284
|
siteCreated?: SiteCreated;
|
|
1288
1285
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -1348,7 +1345,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
1348
1345
|
assets?: Asset[];
|
|
1349
1346
|
}
|
|
1350
1347
|
/** @oneof */
|
|
1351
|
-
|
|
1348
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
1352
1349
|
/** Emitted on a meta site creation. */
|
|
1353
1350
|
siteCreated?: SiteCreated;
|
|
1354
1351
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -1398,7 +1395,7 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
1398
1395
|
/** Emitted when Picasso is detached. */
|
|
1399
1396
|
picassoUnassigned?: PicassoUnassigned;
|
|
1400
1397
|
}
|
|
1401
|
-
|
|
1398
|
+
interface Asset {
|
|
1402
1399
|
/**
|
|
1403
1400
|
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
1404
1401
|
* @maxLength 36
|
|
@@ -1412,7 +1409,7 @@ export interface Asset {
|
|
|
1412
1409
|
/** An application state. */
|
|
1413
1410
|
state?: StateWithLiterals;
|
|
1414
1411
|
}
|
|
1415
|
-
|
|
1412
|
+
declare enum State {
|
|
1416
1413
|
UNKNOWN = "UNKNOWN",
|
|
1417
1414
|
ENABLED = "ENABLED",
|
|
1418
1415
|
DISABLED = "DISABLED",
|
|
@@ -1420,8 +1417,8 @@ export declare enum State {
|
|
|
1420
1417
|
DEMO = "DEMO"
|
|
1421
1418
|
}
|
|
1422
1419
|
/** @enumType */
|
|
1423
|
-
|
|
1424
|
-
|
|
1420
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
1421
|
+
interface SiteCreated {
|
|
1425
1422
|
/**
|
|
1426
1423
|
* A template identifier (empty if not created from a template).
|
|
1427
1424
|
* @maxLength 36
|
|
@@ -1450,7 +1447,7 @@ export interface SiteCreated {
|
|
|
1450
1447
|
/** A namespace. */
|
|
1451
1448
|
namespace?: NamespaceWithLiterals;
|
|
1452
1449
|
}
|
|
1453
|
-
|
|
1450
|
+
declare enum SiteCreatedContext {
|
|
1454
1451
|
/** A valid option, we don't expose all reasons why site might be created. */
|
|
1455
1452
|
OTHER = "OTHER",
|
|
1456
1453
|
/** A meta site was created from template. */
|
|
@@ -1465,8 +1462,8 @@ export declare enum SiteCreatedContext {
|
|
|
1465
1462
|
FLASH = "FLASH"
|
|
1466
1463
|
}
|
|
1467
1464
|
/** @enumType */
|
|
1468
|
-
|
|
1469
|
-
|
|
1465
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
1466
|
+
declare enum Namespace {
|
|
1470
1467
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
1471
1468
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
1472
1469
|
WIX = "WIX",
|
|
@@ -1549,9 +1546,9 @@ export declare enum Namespace {
|
|
|
1549
1546
|
MIMIR = "MIMIR"
|
|
1550
1547
|
}
|
|
1551
1548
|
/** @enumType */
|
|
1552
|
-
|
|
1549
|
+
type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR';
|
|
1553
1550
|
/** Site transferred to another user. */
|
|
1554
|
-
|
|
1551
|
+
interface SiteTransferred {
|
|
1555
1552
|
/**
|
|
1556
1553
|
* A previous owner id (user that transfers meta site).
|
|
1557
1554
|
* @format GUID
|
|
@@ -1564,11 +1561,11 @@ export interface SiteTransferred {
|
|
|
1564
1561
|
newOwnerId?: string;
|
|
1565
1562
|
}
|
|
1566
1563
|
/** Soft deletion of the meta site. Could be restored. */
|
|
1567
|
-
|
|
1564
|
+
interface SiteDeleted {
|
|
1568
1565
|
/** A deletion context. */
|
|
1569
1566
|
deleteContext?: DeleteContext;
|
|
1570
1567
|
}
|
|
1571
|
-
|
|
1568
|
+
interface DeleteContext {
|
|
1572
1569
|
/** When the meta site was deleted. */
|
|
1573
1570
|
dateDeleted?: Date | null;
|
|
1574
1571
|
/** A status. */
|
|
@@ -1584,7 +1581,7 @@ export interface DeleteContext {
|
|
|
1584
1581
|
*/
|
|
1585
1582
|
initiatorId?: string | null;
|
|
1586
1583
|
}
|
|
1587
|
-
|
|
1584
|
+
declare enum DeleteStatus {
|
|
1588
1585
|
UNKNOWN = "UNKNOWN",
|
|
1589
1586
|
TRASH = "TRASH",
|
|
1590
1587
|
DELETED = "DELETED",
|
|
@@ -1592,14 +1589,14 @@ export declare enum DeleteStatus {
|
|
|
1592
1589
|
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
1593
1590
|
}
|
|
1594
1591
|
/** @enumType */
|
|
1595
|
-
|
|
1592
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
1596
1593
|
/** Restoration of the meta site. */
|
|
1597
|
-
|
|
1594
|
+
interface SiteUndeleted {
|
|
1598
1595
|
}
|
|
1599
1596
|
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
1600
|
-
|
|
1597
|
+
interface SitePublished {
|
|
1601
1598
|
}
|
|
1602
|
-
|
|
1599
|
+
interface SiteUnpublished {
|
|
1603
1600
|
/**
|
|
1604
1601
|
* A list of URLs previously associated with the meta site.
|
|
1605
1602
|
* @maxLength 4000
|
|
@@ -1607,9 +1604,9 @@ export interface SiteUnpublished {
|
|
|
1607
1604
|
*/
|
|
1608
1605
|
urls?: string[];
|
|
1609
1606
|
}
|
|
1610
|
-
|
|
1607
|
+
interface SiteMarkedAsTemplate {
|
|
1611
1608
|
}
|
|
1612
|
-
|
|
1609
|
+
interface SiteMarkedAsWixSite {
|
|
1613
1610
|
}
|
|
1614
1611
|
/**
|
|
1615
1612
|
* Represents a service provisioned a site.
|
|
@@ -1626,7 +1623,7 @@ export interface SiteMarkedAsWixSite {
|
|
|
1626
1623
|
* changes made to the original template afterward.
|
|
1627
1624
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
1628
1625
|
*/
|
|
1629
|
-
|
|
1626
|
+
interface ServiceProvisioned {
|
|
1630
1627
|
/**
|
|
1631
1628
|
* Either UUID or EmbeddedServiceType.
|
|
1632
1629
|
* @maxLength 36
|
|
@@ -1653,7 +1650,7 @@ export interface ServiceProvisioned {
|
|
|
1653
1650
|
*/
|
|
1654
1651
|
originMetaSiteId?: string | null;
|
|
1655
1652
|
}
|
|
1656
|
-
|
|
1653
|
+
interface ServiceRemoved {
|
|
1657
1654
|
/**
|
|
1658
1655
|
* Either UUID or EmbeddedServiceType.
|
|
1659
1656
|
* @maxLength 36
|
|
@@ -1671,7 +1668,7 @@ export interface ServiceRemoved {
|
|
|
1671
1668
|
version?: string | null;
|
|
1672
1669
|
}
|
|
1673
1670
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
1674
|
-
|
|
1671
|
+
interface SiteRenamed {
|
|
1675
1672
|
/**
|
|
1676
1673
|
* A new meta site name (URL slug).
|
|
1677
1674
|
* @maxLength 20
|
|
@@ -1688,21 +1685,21 @@ export interface SiteRenamed {
|
|
|
1688
1685
|
*
|
|
1689
1686
|
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
1690
1687
|
*/
|
|
1691
|
-
|
|
1688
|
+
interface SiteHardDeleted {
|
|
1692
1689
|
/** A deletion context. */
|
|
1693
1690
|
deleteContext?: DeleteContext;
|
|
1694
1691
|
}
|
|
1695
|
-
|
|
1692
|
+
interface NamespaceChanged {
|
|
1696
1693
|
/** A previous namespace. */
|
|
1697
1694
|
oldNamespace?: NamespaceWithLiterals;
|
|
1698
1695
|
/** A new namespace. */
|
|
1699
1696
|
newNamespace?: NamespaceWithLiterals;
|
|
1700
1697
|
}
|
|
1701
1698
|
/** Assigned Studio editor */
|
|
1702
|
-
|
|
1699
|
+
interface StudioAssigned {
|
|
1703
1700
|
}
|
|
1704
1701
|
/** Unassigned Studio editor */
|
|
1705
|
-
|
|
1702
|
+
interface StudioUnassigned {
|
|
1706
1703
|
}
|
|
1707
1704
|
/**
|
|
1708
1705
|
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
@@ -1712,13 +1709,13 @@ export interface StudioUnassigned {
|
|
|
1712
1709
|
*
|
|
1713
1710
|
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
1714
1711
|
*/
|
|
1715
|
-
|
|
1712
|
+
interface SiteUrlChanged {
|
|
1716
1713
|
}
|
|
1717
1714
|
/**
|
|
1718
1715
|
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
1719
1716
|
* Consumed by other teams to remove relevant data.
|
|
1720
1717
|
*/
|
|
1721
|
-
|
|
1718
|
+
interface SitePurgedExternally {
|
|
1722
1719
|
/**
|
|
1723
1720
|
* @maxLength 2048
|
|
1724
1721
|
* @maxSize 100
|
|
@@ -1728,45 +1725,45 @@ export interface SitePurgedExternally {
|
|
|
1728
1725
|
appDefId?: string[];
|
|
1729
1726
|
}
|
|
1730
1727
|
/** Assigned Odeditor */
|
|
1731
|
-
|
|
1728
|
+
interface OdeditorAssigned {
|
|
1732
1729
|
}
|
|
1733
1730
|
/** Unassigned Odeditor */
|
|
1734
|
-
|
|
1731
|
+
interface OdeditorUnassigned {
|
|
1735
1732
|
}
|
|
1736
1733
|
/** Assigned Picasso editor */
|
|
1737
|
-
|
|
1734
|
+
interface PicassoAssigned {
|
|
1738
1735
|
}
|
|
1739
1736
|
/** Unassigned Picasso */
|
|
1740
|
-
|
|
1737
|
+
interface PicassoUnassigned {
|
|
1741
1738
|
}
|
|
1742
|
-
|
|
1739
|
+
interface CreateDraftAutomationRequest {
|
|
1743
1740
|
/** Draft automation to create. */
|
|
1744
1741
|
automation?: Automation;
|
|
1745
1742
|
}
|
|
1746
|
-
|
|
1743
|
+
interface CreateDraftAutomationResponse {
|
|
1747
1744
|
/** Draft automation that was created. */
|
|
1748
1745
|
automation?: Automation;
|
|
1749
1746
|
}
|
|
1750
|
-
|
|
1747
|
+
interface GetOrCreateDraftAutomationRequest {
|
|
1751
1748
|
/**
|
|
1752
1749
|
* ID of the original automation on which the draft is based.
|
|
1753
1750
|
* @format GUID
|
|
1754
1751
|
*/
|
|
1755
1752
|
originalAutomationId: string;
|
|
1756
1753
|
}
|
|
1757
|
-
|
|
1754
|
+
interface GetOrCreateDraftAutomationResponse {
|
|
1758
1755
|
/** Draft automation. */
|
|
1759
1756
|
automation?: Automation;
|
|
1760
1757
|
}
|
|
1761
|
-
|
|
1758
|
+
interface UpdateDraftAutomationRequest {
|
|
1762
1759
|
/** Automation to update. Updates can be partial. */
|
|
1763
1760
|
automation: Automation;
|
|
1764
1761
|
}
|
|
1765
|
-
|
|
1762
|
+
interface UpdateDraftAutomationResponse {
|
|
1766
1763
|
/** Updated draft automation. */
|
|
1767
1764
|
automation?: Automation;
|
|
1768
1765
|
}
|
|
1769
|
-
|
|
1766
|
+
interface QueryAutomationsWithDraftsRequest {
|
|
1770
1767
|
/**
|
|
1771
1768
|
* Query.
|
|
1772
1769
|
*
|
|
@@ -1774,7 +1771,7 @@ export interface QueryAutomationsWithDraftsRequest {
|
|
|
1774
1771
|
*/
|
|
1775
1772
|
query?: CursorQuery;
|
|
1776
1773
|
}
|
|
1777
|
-
|
|
1774
|
+
interface QueryAutomationsWithDraftsResponse {
|
|
1778
1775
|
/** Retrieved automations. */
|
|
1779
1776
|
automations?: Automation[];
|
|
1780
1777
|
/** Paging metadata. */
|
|
@@ -1785,7 +1782,7 @@ export interface QueryAutomationsWithDraftsResponse {
|
|
|
1785
1782
|
*/
|
|
1786
1783
|
originalAutomationIdToDrafts?: Record<string, DraftsInfo>;
|
|
1787
1784
|
}
|
|
1788
|
-
|
|
1785
|
+
interface DraftsInfo {
|
|
1789
1786
|
/**
|
|
1790
1787
|
* IDs of the draft automations.
|
|
1791
1788
|
* @maxSize 1
|
|
@@ -1793,33 +1790,33 @@ export interface DraftsInfo {
|
|
|
1793
1790
|
*/
|
|
1794
1791
|
draftAutomationIds?: string[];
|
|
1795
1792
|
}
|
|
1796
|
-
|
|
1793
|
+
interface DeleteDraftAutomationRequest {
|
|
1797
1794
|
/**
|
|
1798
1795
|
* ID of the draft automation to delete.
|
|
1799
1796
|
* @format GUID
|
|
1800
1797
|
*/
|
|
1801
1798
|
automationId: string;
|
|
1802
1799
|
}
|
|
1803
|
-
|
|
1800
|
+
interface DeleteDraftAutomationResponse {
|
|
1804
1801
|
}
|
|
1805
|
-
|
|
1802
|
+
interface PublishDraftAutomationRequest {
|
|
1806
1803
|
/**
|
|
1807
1804
|
* ID of the draft automation to publish.
|
|
1808
1805
|
* @format GUID
|
|
1809
1806
|
*/
|
|
1810
1807
|
automationId: string;
|
|
1811
1808
|
}
|
|
1812
|
-
|
|
1809
|
+
interface PublishDraftAutomationResponse {
|
|
1813
1810
|
/** Updated published automation. */
|
|
1814
1811
|
automation?: Automation;
|
|
1815
1812
|
}
|
|
1816
|
-
|
|
1813
|
+
interface ValidateAutomationRequest {
|
|
1817
1814
|
/** Automation to validate. */
|
|
1818
1815
|
automation: Automation;
|
|
1819
1816
|
/** Automation validation settings. */
|
|
1820
1817
|
validationSettings?: ValidationSettings;
|
|
1821
1818
|
}
|
|
1822
|
-
|
|
1819
|
+
interface ValidationSettings {
|
|
1823
1820
|
/**
|
|
1824
1821
|
* IDs of actions to validate. Only actions whose IDs are specified are validated.
|
|
1825
1822
|
*
|
|
@@ -1835,7 +1832,7 @@ export interface ValidationSettings {
|
|
|
1835
1832
|
*/
|
|
1836
1833
|
skipProviderValidations?: boolean;
|
|
1837
1834
|
}
|
|
1838
|
-
|
|
1835
|
+
interface ValidateAutomationResponse {
|
|
1839
1836
|
/** Whether the automation is valid. */
|
|
1840
1837
|
valid?: boolean;
|
|
1841
1838
|
/**
|
|
@@ -1854,7 +1851,7 @@ export interface ValidateAutomationResponse {
|
|
|
1854
1851
|
*/
|
|
1855
1852
|
automationValidationErrors?: AutomationValidationError[];
|
|
1856
1853
|
}
|
|
1857
|
-
|
|
1854
|
+
interface TriggerValidationError extends TriggerValidationErrorErrorOneOf {
|
|
1858
1855
|
/** Trigger configuration error. */
|
|
1859
1856
|
configurationError?: TriggerConfigurationError;
|
|
1860
1857
|
/** Provider configuration error. */
|
|
@@ -1865,13 +1862,13 @@ export interface TriggerValidationError extends TriggerValidationErrorErrorOneOf
|
|
|
1865
1862
|
severity?: ValidationErrorSeverityWithLiterals;
|
|
1866
1863
|
}
|
|
1867
1864
|
/** @oneof */
|
|
1868
|
-
|
|
1865
|
+
interface TriggerValidationErrorErrorOneOf {
|
|
1869
1866
|
/** Trigger configuration error. */
|
|
1870
1867
|
configurationError?: TriggerConfigurationError;
|
|
1871
1868
|
/** Provider configuration error. */
|
|
1872
1869
|
providerConfigurationError?: ProviderConfigurationError;
|
|
1873
1870
|
}
|
|
1874
|
-
|
|
1871
|
+
declare enum TriggerValidationErrorValidationErrorType {
|
|
1875
1872
|
UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
|
|
1876
1873
|
/** Configuration error. */
|
|
1877
1874
|
CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
|
|
@@ -1879,8 +1876,8 @@ export declare enum TriggerValidationErrorValidationErrorType {
|
|
|
1879
1876
|
PROVIDER_ERROR = "PROVIDER_ERROR"
|
|
1880
1877
|
}
|
|
1881
1878
|
/** @enumType */
|
|
1882
|
-
|
|
1883
|
-
|
|
1879
|
+
type TriggerValidationErrorValidationErrorTypeWithLiterals = TriggerValidationErrorValidationErrorType | 'UNKNOWN_VALIDATION_ERROR_TYPE' | 'CONFIGURATION_ERROR' | 'PROVIDER_ERROR';
|
|
1880
|
+
interface TriggerConfigurationError {
|
|
1884
1881
|
/** Trigger error type. */
|
|
1885
1882
|
errorType?: TriggerErrorTypeWithLiterals;
|
|
1886
1883
|
/**
|
|
@@ -1889,7 +1886,7 @@ export interface TriggerConfigurationError {
|
|
|
1889
1886
|
*/
|
|
1890
1887
|
filterFieldKey?: string | null;
|
|
1891
1888
|
}
|
|
1892
|
-
|
|
1889
|
+
declare enum TriggerErrorType {
|
|
1893
1890
|
UNKNOWN_TRIGGER_ERROR_TYPE = "UNKNOWN_TRIGGER_ERROR_TYPE",
|
|
1894
1891
|
/** Trigger not found. */
|
|
1895
1892
|
NOT_FOUND = "NOT_FOUND",
|
|
@@ -1907,8 +1904,8 @@ export declare enum TriggerErrorType {
|
|
|
1907
1904
|
INVALID_FILTER_EXPRESSION = "INVALID_FILTER_EXPRESSION"
|
|
1908
1905
|
}
|
|
1909
1906
|
/** @enumType */
|
|
1910
|
-
|
|
1911
|
-
|
|
1907
|
+
type TriggerErrorTypeWithLiterals = TriggerErrorType | 'UNKNOWN_TRIGGER_ERROR_TYPE' | 'NOT_FOUND' | 'APP_NOT_INSTALLED' | 'MODERATION_MISMATCH' | 'DEPRECATED' | 'INVALID_TRIGGER_KEY' | 'INVALID_FILTER_FIELD_KEY' | 'INVALID_FILTER_EXPRESSION';
|
|
1908
|
+
interface ProviderConfigurationError {
|
|
1912
1909
|
/** Key corresponding to the field in the schema. */
|
|
1913
1910
|
fieldKey?: string | null;
|
|
1914
1911
|
/** Error message. */
|
|
@@ -1920,7 +1917,7 @@ export interface ProviderConfigurationError {
|
|
|
1920
1917
|
/** Title for the error. */
|
|
1921
1918
|
title?: string;
|
|
1922
1919
|
}
|
|
1923
|
-
|
|
1920
|
+
declare enum ValidationErrorSeverity {
|
|
1924
1921
|
UNKNOWN_VALIDATION_ERROR_SEVERITY = "UNKNOWN_VALIDATION_ERROR_SEVERITY",
|
|
1925
1922
|
/** Warning. */
|
|
1926
1923
|
WARNING = "WARNING",
|
|
@@ -1928,8 +1925,8 @@ export declare enum ValidationErrorSeverity {
|
|
|
1928
1925
|
ERROR = "ERROR"
|
|
1929
1926
|
}
|
|
1930
1927
|
/** @enumType */
|
|
1931
|
-
|
|
1932
|
-
|
|
1928
|
+
type ValidationErrorSeverityWithLiterals = ValidationErrorSeverity | 'UNKNOWN_VALIDATION_ERROR_SEVERITY' | 'WARNING' | 'ERROR';
|
|
1929
|
+
interface ActionValidationInfo {
|
|
1933
1930
|
/**
|
|
1934
1931
|
* Action ID.
|
|
1935
1932
|
* @format GUID
|
|
@@ -1952,7 +1949,7 @@ export interface ActionValidationInfo {
|
|
|
1952
1949
|
*/
|
|
1953
1950
|
validationErrors?: ActionValidationError[];
|
|
1954
1951
|
}
|
|
1955
|
-
|
|
1952
|
+
interface ActionValidationError extends ActionValidationErrorErrorOneOf {
|
|
1956
1953
|
/** Action configuration error. */
|
|
1957
1954
|
configurationError?: ActionConfigurationError;
|
|
1958
1955
|
/** Provider configuration error. */
|
|
@@ -1963,13 +1960,13 @@ export interface ActionValidationError extends ActionValidationErrorErrorOneOf {
|
|
|
1963
1960
|
severity?: ValidationErrorSeverityWithLiterals;
|
|
1964
1961
|
}
|
|
1965
1962
|
/** @oneof */
|
|
1966
|
-
|
|
1963
|
+
interface ActionValidationErrorErrorOneOf {
|
|
1967
1964
|
/** Action configuration error. */
|
|
1968
1965
|
configurationError?: ActionConfigurationError;
|
|
1969
1966
|
/** Provider configuration error. */
|
|
1970
1967
|
providerConfigurationError?: ProviderConfigurationError;
|
|
1971
1968
|
}
|
|
1972
|
-
|
|
1969
|
+
declare enum ValidationErrorType {
|
|
1973
1970
|
UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
|
|
1974
1971
|
/** Configuration error. */
|
|
1975
1972
|
CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
|
|
@@ -1977,8 +1974,8 @@ export declare enum ValidationErrorType {
|
|
|
1977
1974
|
PROVIDER_ERROR = "PROVIDER_ERROR"
|
|
1978
1975
|
}
|
|
1979
1976
|
/** @enumType */
|
|
1980
|
-
|
|
1981
|
-
|
|
1977
|
+
type ValidationErrorTypeWithLiterals = ValidationErrorType | 'UNKNOWN_VALIDATION_ERROR_TYPE' | 'CONFIGURATION_ERROR' | 'PROVIDER_ERROR';
|
|
1978
|
+
interface ActionConfigurationError {
|
|
1982
1979
|
/** Action error type. */
|
|
1983
1980
|
errorType?: ActionErrorTypeWithLiterals;
|
|
1984
1981
|
/**
|
|
@@ -1987,7 +1984,7 @@ export interface ActionConfigurationError {
|
|
|
1987
1984
|
*/
|
|
1988
1985
|
fieldKey?: string | null;
|
|
1989
1986
|
}
|
|
1990
|
-
|
|
1987
|
+
declare enum ActionErrorType {
|
|
1991
1988
|
UNKNOWN_ACTION_ERROR_TYPE = "UNKNOWN_ACTION_ERROR_TYPE",
|
|
1992
1989
|
NOT_FOUND = "NOT_FOUND",
|
|
1993
1990
|
APP_NOT_INSTALLED = "APP_NOT_INSTALLED",
|
|
@@ -2002,8 +1999,8 @@ export declare enum ActionErrorType {
|
|
|
2002
1999
|
SAMPLE_CODE_RUN_FAILED = "SAMPLE_CODE_RUN_FAILED"
|
|
2003
2000
|
}
|
|
2004
2001
|
/** @enumType */
|
|
2005
|
-
|
|
2006
|
-
|
|
2002
|
+
type ActionErrorTypeWithLiterals = ActionErrorType | 'UNKNOWN_ACTION_ERROR_TYPE' | 'NOT_FOUND' | 'APP_NOT_INSTALLED' | 'MODERATION_MISMATCH' | 'DEPRECATED' | 'INVALID_ACTION_KEY' | 'INVALID_MAPPING' | 'MAPPING_TYPE_MISMATCH' | 'MAPPING_MISSING_REQUIRED_FIELD' | 'MAPPING_SCHEMA_MISMATCH' | 'MAPPING_VARIABLE_MISSING_FROM_SCHEMA' | 'SAMPLE_CODE_RUN_FAILED';
|
|
2003
|
+
interface AutomationValidationError extends AutomationValidationErrorErrorOneOf {
|
|
2007
2004
|
/** Automation configuration error. */
|
|
2008
2005
|
configurationError?: AutomationConfigurationError;
|
|
2009
2006
|
/** Provider configuration error. */
|
|
@@ -2014,29 +2011,29 @@ export interface AutomationValidationError extends AutomationValidationErrorErro
|
|
|
2014
2011
|
severity?: ValidationErrorSeverityWithLiterals;
|
|
2015
2012
|
}
|
|
2016
2013
|
/** @oneof */
|
|
2017
|
-
|
|
2014
|
+
interface AutomationValidationErrorErrorOneOf {
|
|
2018
2015
|
/** Automation configuration error. */
|
|
2019
2016
|
configurationError?: AutomationConfigurationError;
|
|
2020
2017
|
/** Provider configuration error. */
|
|
2021
2018
|
providerConfigurationError?: ProviderConfigurationError;
|
|
2022
2019
|
}
|
|
2023
|
-
|
|
2020
|
+
declare enum AutomationValidationErrorValidationErrorType {
|
|
2024
2021
|
UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
|
|
2025
2022
|
CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
|
|
2026
2023
|
PROVIDER_ERROR = "PROVIDER_ERROR"
|
|
2027
2024
|
}
|
|
2028
2025
|
/** @enumType */
|
|
2029
|
-
|
|
2030
|
-
|
|
2026
|
+
type AutomationValidationErrorValidationErrorTypeWithLiterals = AutomationValidationErrorValidationErrorType | 'UNKNOWN_VALIDATION_ERROR_TYPE' | 'CONFIGURATION_ERROR' | 'PROVIDER_ERROR';
|
|
2027
|
+
interface AutomationConfigurationError {
|
|
2031
2028
|
/** Automation error type. */
|
|
2032
2029
|
errorType?: AutomationErrorTypeWithLiterals;
|
|
2033
2030
|
}
|
|
2034
|
-
|
|
2031
|
+
declare enum AutomationErrorType {
|
|
2035
2032
|
UNKNOWN_AUTOMATION_ERROR_TYPE = "UNKNOWN_AUTOMATION_ERROR_TYPE"
|
|
2036
2033
|
}
|
|
2037
2034
|
/** @enumType */
|
|
2038
|
-
|
|
2039
|
-
|
|
2035
|
+
type AutomationErrorTypeWithLiterals = AutomationErrorType | 'UNKNOWN_AUTOMATION_ERROR_TYPE';
|
|
2036
|
+
interface ValidateAutomationByIdRequest {
|
|
2040
2037
|
/**
|
|
2041
2038
|
* Automation ID.
|
|
2042
2039
|
* @format GUID
|
|
@@ -2045,7 +2042,7 @@ export interface ValidateAutomationByIdRequest {
|
|
|
2045
2042
|
/** Validation settings. */
|
|
2046
2043
|
validationSettings?: ValidationSettings;
|
|
2047
2044
|
}
|
|
2048
|
-
|
|
2045
|
+
interface ValidateAutomationByIdResponse {
|
|
2049
2046
|
/** Whether the automation is valid. */
|
|
2050
2047
|
valid?: boolean;
|
|
2051
2048
|
/**
|
|
@@ -2064,7 +2061,7 @@ export interface ValidateAutomationByIdResponse {
|
|
|
2064
2061
|
*/
|
|
2065
2062
|
automationValidationErrors?: AutomationValidationError[];
|
|
2066
2063
|
}
|
|
2067
|
-
|
|
2064
|
+
interface GetAutomationActionSchemaRequest {
|
|
2068
2065
|
/**
|
|
2069
2066
|
* Automation ID.
|
|
2070
2067
|
* @format GUID
|
|
@@ -2076,17 +2073,17 @@ export interface GetAutomationActionSchemaRequest {
|
|
|
2076
2073
|
*/
|
|
2077
2074
|
actionId?: string;
|
|
2078
2075
|
}
|
|
2079
|
-
|
|
2076
|
+
interface GetAutomationActionSchemaResponse {
|
|
2080
2077
|
/** The accumulated payload schema for an action. */
|
|
2081
2078
|
schema?: Record<string, any> | null;
|
|
2082
2079
|
}
|
|
2083
|
-
|
|
2080
|
+
interface GetActionsQuotaInfoRequest {
|
|
2084
2081
|
}
|
|
2085
|
-
|
|
2082
|
+
interface GetActionsQuotaInfoResponse {
|
|
2086
2083
|
/** Action quotas. */
|
|
2087
2084
|
actionProviderQuotaInfo?: ActionProviderQuotaInfo[];
|
|
2088
2085
|
}
|
|
2089
|
-
|
|
2086
|
+
interface ActionProviderQuotaInfo {
|
|
2090
2087
|
/**
|
|
2091
2088
|
* ID of the app that defined the action.
|
|
2092
2089
|
* @format GUID
|
|
@@ -2101,7 +2098,7 @@ export interface ActionProviderQuotaInfo {
|
|
|
2101
2098
|
/** Action quota information. */
|
|
2102
2099
|
actionQuotaInfo?: ActionQuotaInfo;
|
|
2103
2100
|
}
|
|
2104
|
-
|
|
2101
|
+
interface ActionQuotaInfo {
|
|
2105
2102
|
/**
|
|
2106
2103
|
* Whether the quotas for your action are enforced. If you mark this as `true` in the response body,
|
|
2107
2104
|
* Wix displays the information in the quota object on the site dashboard. If you mark this as `false` for
|
|
@@ -2121,7 +2118,7 @@ export interface ActionQuotaInfo {
|
|
|
2121
2118
|
*/
|
|
2122
2119
|
quotaInfo?: QuotaInfo[];
|
|
2123
2120
|
}
|
|
2124
|
-
|
|
2121
|
+
interface QuotaInfo {
|
|
2125
2122
|
/** List of plans associated with the site making the request. */
|
|
2126
2123
|
plans?: Plan[];
|
|
2127
2124
|
/**
|
|
@@ -2135,13 +2132,13 @@ export interface QuotaInfo {
|
|
|
2135
2132
|
*/
|
|
2136
2133
|
upgradeCta?: UpgradeCTA;
|
|
2137
2134
|
}
|
|
2138
|
-
|
|
2135
|
+
interface Plan {
|
|
2139
2136
|
/** Plan ID defined by the action provider. */
|
|
2140
2137
|
_id?: string;
|
|
2141
2138
|
/** Plan name to display in the Wix user’s site dashboard. */
|
|
2142
2139
|
name?: string;
|
|
2143
2140
|
}
|
|
2144
|
-
|
|
2141
|
+
interface Quota {
|
|
2145
2142
|
/**
|
|
2146
2143
|
* Name of the feature the quota is related to. For example, "Messages sent".
|
|
2147
2144
|
* @minLength 1
|
|
@@ -2159,7 +2156,7 @@ export interface Quota {
|
|
|
2159
2156
|
/** Additional information about the quota. Displayed as a tooltip in the Wix user’s dashboard. */
|
|
2160
2157
|
additionalInfo?: AdditionalInfo;
|
|
2161
2158
|
}
|
|
2162
|
-
|
|
2159
|
+
interface CTA {
|
|
2163
2160
|
/**
|
|
2164
2161
|
* Call-to-action redirect URL.
|
|
2165
2162
|
* @minLength 1
|
|
@@ -2171,7 +2168,7 @@ export interface CTA {
|
|
|
2171
2168
|
*/
|
|
2172
2169
|
label?: string;
|
|
2173
2170
|
}
|
|
2174
|
-
|
|
2171
|
+
interface AdditionalInfo {
|
|
2175
2172
|
/**
|
|
2176
2173
|
* Tooltip content.
|
|
2177
2174
|
* @minLength 1
|
|
@@ -2180,7 +2177,7 @@ export interface AdditionalInfo {
|
|
|
2180
2177
|
/** Details for an options call-to-action link that appears in the tooltip. */
|
|
2181
2178
|
cta?: CTA;
|
|
2182
2179
|
}
|
|
2183
|
-
|
|
2180
|
+
interface UpgradeCTA {
|
|
2184
2181
|
/**
|
|
2185
2182
|
* CTA button redirect URL.
|
|
2186
2183
|
* @minLength 1
|
|
@@ -2192,7 +2189,7 @@ export interface UpgradeCTA {
|
|
|
2192
2189
|
*/
|
|
2193
2190
|
label?: string;
|
|
2194
2191
|
}
|
|
2195
|
-
|
|
2192
|
+
interface MigrateVeloActionAutomationsRequest {
|
|
2196
2193
|
/** @format GUID */
|
|
2197
2194
|
oldAppId?: string;
|
|
2198
2195
|
/** @format GUID */
|
|
@@ -2200,9 +2197,9 @@ export interface MigrateVeloActionAutomationsRequest {
|
|
|
2200
2197
|
/** @format GUID */
|
|
2201
2198
|
newComponentId?: string;
|
|
2202
2199
|
}
|
|
2203
|
-
|
|
2200
|
+
interface MigrateVeloActionAutomationsResponse {
|
|
2204
2201
|
}
|
|
2205
|
-
|
|
2202
|
+
interface GetAutomationRevisionRequest {
|
|
2206
2203
|
/**
|
|
2207
2204
|
* Automation ID.
|
|
2208
2205
|
* @format GUID
|
|
@@ -2216,11 +2213,11 @@ export interface GetAutomationRevisionRequest {
|
|
|
2216
2213
|
*/
|
|
2217
2214
|
fields?: RequestedFieldsWithLiterals[];
|
|
2218
2215
|
}
|
|
2219
|
-
|
|
2216
|
+
interface GetAutomationRevisionResponse {
|
|
2220
2217
|
/** Automation revision. */
|
|
2221
2218
|
automation?: Automation;
|
|
2222
2219
|
}
|
|
2223
|
-
|
|
2220
|
+
interface BaseEventMetadata {
|
|
2224
2221
|
/**
|
|
2225
2222
|
* App instance ID.
|
|
2226
2223
|
* @format GUID
|
|
@@ -2234,7 +2231,7 @@ export interface BaseEventMetadata {
|
|
|
2234
2231
|
/** The identification type and identity data. */
|
|
2235
2232
|
identity?: IdentificationData;
|
|
2236
2233
|
}
|
|
2237
|
-
|
|
2234
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
2238
2235
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2239
2236
|
_id?: string;
|
|
2240
2237
|
/**
|
|
@@ -2264,120 +2261,19 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
2264
2261
|
*/
|
|
2265
2262
|
entityEventSequence?: string | null;
|
|
2266
2263
|
}
|
|
2267
|
-
|
|
2264
|
+
interface AutomationCreatedEnvelope {
|
|
2268
2265
|
entity: Automation;
|
|
2269
2266
|
metadata: EventMetadata;
|
|
2270
2267
|
}
|
|
2271
|
-
|
|
2272
|
-
* Triggered when a new automation is created.
|
|
2273
|
-
* @permissionScope Manage Stores
|
|
2274
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2275
|
-
* @permissionScope Set Up Automations
|
|
2276
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2277
|
-
* @permissionId AUTOMATIONS.AUTOMATION_READ
|
|
2278
|
-
* @webhook
|
|
2279
|
-
* @eventType wix.automations.v2.automation_created
|
|
2280
|
-
* @slug created
|
|
2281
|
-
* @documentationMaturity preview
|
|
2282
|
-
*/
|
|
2283
|
-
export declare function onAutomationCreated(handler: (event: AutomationCreatedEnvelope) => void | Promise<void>): void;
|
|
2284
|
-
export interface AutomationDeletedEnvelope {
|
|
2268
|
+
interface AutomationDeletedEnvelope {
|
|
2285
2269
|
entity: Automation;
|
|
2286
2270
|
metadata: EventMetadata;
|
|
2287
2271
|
}
|
|
2288
|
-
|
|
2289
|
-
* Triggered when an automation is deleted.
|
|
2290
|
-
* @permissionScope Manage Stores
|
|
2291
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2292
|
-
* @permissionScope Set Up Automations
|
|
2293
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2294
|
-
* @permissionId AUTOMATIONS.AUTOMATION_READ
|
|
2295
|
-
* @webhook
|
|
2296
|
-
* @eventType wix.automations.v2.automation_deleted
|
|
2297
|
-
* @slug deleted
|
|
2298
|
-
* @documentationMaturity preview
|
|
2299
|
-
*/
|
|
2300
|
-
export declare function onAutomationDeleted(handler: (event: AutomationDeletedEnvelope) => void | Promise<void>): void;
|
|
2301
|
-
export interface AutomationUpdatedEnvelope {
|
|
2272
|
+
interface AutomationUpdatedEnvelope {
|
|
2302
2273
|
entity: Automation;
|
|
2303
2274
|
metadata: EventMetadata;
|
|
2304
2275
|
}
|
|
2305
|
-
|
|
2306
|
-
* Triggered when an automation is updated.
|
|
2307
|
-
* @permissionScope Manage Stores
|
|
2308
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2309
|
-
* @permissionScope Set Up Automations
|
|
2310
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2311
|
-
* @permissionId AUTOMATIONS.AUTOMATION_READ
|
|
2312
|
-
* @webhook
|
|
2313
|
-
* @eventType wix.automations.v2.automation_updated
|
|
2314
|
-
* @slug updated
|
|
2315
|
-
* @documentationMaturity preview
|
|
2316
|
-
*/
|
|
2317
|
-
export declare function onAutomationUpdated(handler: (event: AutomationUpdatedEnvelope) => void | Promise<void>): void;
|
|
2318
|
-
type AutomationNonNullablePaths = `applicationInfo.appId` | `preinstalledInfo.appId` | `createdBy.userId` | `createdBy.appId` | `updatedBy.userId` | `updatedBy.appId` | `name` | `configuration.status` | `configuration.trigger.appId` | `configuration.trigger.triggerKey` | `configuration.trigger.filters` | `configuration.trigger.filters.${number}._id` | `configuration.trigger.filters.${number}.fieldKey` | `configuration.trigger.filters.${number}.filterExpression` | `configuration.trigger.scheduledEventOffset.preScheduledEventOffsetExpression` | `configuration.trigger.scheduledEventOffset.scheduledEventOffsetTimeUnit` | `configuration.trigger.rateLimit.maxActivationsExpression` | `configuration.trigger.rateLimit.durationTimeUnit` | `configuration.rootActionIds` | `origin` | `settings.hidden` | `settings.readonly` | `settings.disableDelete` | `settings.disableStatusChange` | `settings.actionSettings.permanentActionIds` | `settings.actionSettings.readonlyActionIds` | `settings.actionSettings.disableDelayAddition` | `settings.actionSettings.disableConditionAddition` | `archived`;
|
|
2319
|
-
/**
|
|
2320
|
-
* Creates an automation.
|
|
2321
|
-
* @param automation - Automation to create.
|
|
2322
|
-
* @public
|
|
2323
|
-
* @documentationMaturity preview
|
|
2324
|
-
* @requiredField automation
|
|
2325
|
-
* @requiredField automation.configuration
|
|
2326
|
-
* @requiredField automation.configuration.actions
|
|
2327
|
-
* @requiredField automation.configuration.rootActionIds
|
|
2328
|
-
* @requiredField automation.configuration.status
|
|
2329
|
-
* @requiredField automation.configuration.trigger
|
|
2330
|
-
* @requiredField automation.configuration.trigger.appId
|
|
2331
|
-
* @requiredField automation.configuration.trigger.triggerKey
|
|
2332
|
-
* @requiredField automation.name
|
|
2333
|
-
* @requiredField automation.origin
|
|
2334
|
-
* @permissionId AUTOMATIONS.AUTOMATION_CREATE
|
|
2335
|
-
* @permissionScope Manage Stores
|
|
2336
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2337
|
-
* @permissionScope Set Up Automations
|
|
2338
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2339
|
-
* @applicableIdentity APP
|
|
2340
|
-
* @returns Details of the created automation.
|
|
2341
|
-
* @fqn wix.automations.v2.AutomationsService.CreateAutomation
|
|
2342
|
-
*/
|
|
2343
|
-
export declare function createAutomation(automation: NonNullablePaths<Automation, `configuration` | `configuration.actions` | `configuration.rootActionIds` | `configuration.status` | `configuration.trigger` | `configuration.trigger.appId` | `configuration.trigger.triggerKey` | `name` | `origin`>): Promise<NonNullablePaths<Automation, AutomationNonNullablePaths>>;
|
|
2344
|
-
/**
|
|
2345
|
-
* Retrieves an automation by ID.
|
|
2346
|
-
* @param automationId - Automation ID.
|
|
2347
|
-
* @public
|
|
2348
|
-
* @documentationMaturity preview
|
|
2349
|
-
* @requiredField automationId
|
|
2350
|
-
* @permissionId AUTOMATIONS.AUTOMATION_READ
|
|
2351
|
-
* @permissionScope Manage Stores
|
|
2352
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2353
|
-
* @permissionScope Set Up Automations
|
|
2354
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2355
|
-
* @applicableIdentity APP
|
|
2356
|
-
* @returns Retrieved automation.
|
|
2357
|
-
* @fqn wix.automations.v2.AutomationsService.GetAutomation
|
|
2358
|
-
*/
|
|
2359
|
-
export declare function getAutomation(automationId: string): Promise<NonNullablePaths<Automation, AutomationNonNullablePaths>>;
|
|
2360
|
-
/**
|
|
2361
|
-
* Updates the specified automation.
|
|
2362
|
-
*
|
|
2363
|
-
* When an automation is updated, its `revision` property is incremented by 1. When updating an automation, you must specify the current revision number.
|
|
2364
|
-
* @param _id - Automation ID.
|
|
2365
|
-
* @public
|
|
2366
|
-
* @documentationMaturity preview
|
|
2367
|
-
* @requiredField _id
|
|
2368
|
-
* @requiredField automation
|
|
2369
|
-
* @requiredField automation.revision
|
|
2370
|
-
* @permissionId AUTOMATIONS.AUTOMATION_UPDATE
|
|
2371
|
-
* @permissionScope Manage Stores
|
|
2372
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2373
|
-
* @permissionScope Set Up Automations
|
|
2374
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2375
|
-
* @applicableIdentity APP
|
|
2376
|
-
* @returns Updated automation.
|
|
2377
|
-
* @fqn wix.automations.v2.AutomationsService.UpdateAutomation
|
|
2378
|
-
*/
|
|
2379
|
-
export declare function updateAutomation(_id: string, automation: NonNullablePaths<UpdateAutomation, `revision`>): Promise<NonNullablePaths<Automation, AutomationNonNullablePaths>>;
|
|
2380
|
-
export interface UpdateAutomation {
|
|
2276
|
+
interface UpdateAutomation {
|
|
2381
2277
|
/** When the origin of the automation is `APPLICATION`, the details of the app that created it. */
|
|
2382
2278
|
applicationInfo?: ApplicationOrigin;
|
|
2383
2279
|
/** When the origin of the automation is `PREINSTALLED`, the details of the preinstalled automation. */
|
|
@@ -2446,77 +2342,13 @@ export interface UpdateAutomation {
|
|
|
2446
2342
|
*/
|
|
2447
2343
|
archived?: boolean;
|
|
2448
2344
|
}
|
|
2449
|
-
|
|
2450
|
-
* Deletes the specified automation.
|
|
2451
|
-
* @param automationId - Automation ID.
|
|
2452
|
-
* @public
|
|
2453
|
-
* @documentationMaturity preview
|
|
2454
|
-
* @requiredField automationId
|
|
2455
|
-
* @permissionId AUTOMATIONS.AUTOMATION_DELETE
|
|
2456
|
-
* @permissionScope Manage Stores
|
|
2457
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2458
|
-
* @permissionScope Set Up Automations
|
|
2459
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2460
|
-
* @applicableIdentity APP
|
|
2461
|
-
* @fqn wix.automations.v2.AutomationsService.DeleteAutomation
|
|
2462
|
-
*/
|
|
2463
|
-
export declare function deleteAutomation(automationId: string): Promise<void>;
|
|
2464
|
-
/**
|
|
2465
|
-
* Deletes one or more automations.
|
|
2466
|
-
* @param automationIds - IDs of the automations to delete.
|
|
2467
|
-
* @public
|
|
2468
|
-
* @documentationMaturity preview
|
|
2469
|
-
* @requiredField automationIds
|
|
2470
|
-
* @permissionId AUTOMATIONS.AUTOMATION_DELETE
|
|
2471
|
-
* @permissionScope Manage Stores
|
|
2472
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2473
|
-
* @permissionScope Set Up Automations
|
|
2474
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2475
|
-
* @applicableIdentity APP
|
|
2476
|
-
* @fqn wix.automations.v2.AutomationsService.BulkDeleteAutomations
|
|
2477
|
-
*/
|
|
2478
|
-
export declare function bulkDeleteAutomations(automationIds: string[]): Promise<NonNullablePaths<BulkDeleteAutomationsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
2479
|
-
/**
|
|
2480
|
-
* Generates a preinstalled automation from another automation.
|
|
2481
|
-
*
|
|
2482
|
-
* Calls the action providers for changes needed to make a preinstalled automation, such as changes made to email template.
|
|
2483
|
-
*
|
|
2484
|
-
* > **Note**: You must have an account permission to edit an app.
|
|
2485
|
-
* @param automation - Automation.
|
|
2486
|
-
* @public
|
|
2487
|
-
* @documentationMaturity preview
|
|
2488
|
-
* @requiredField automation
|
|
2489
|
-
* @fqn wix.automations.v2.AutomationsService.GeneratePreinstalledAutomation
|
|
2490
|
-
*/
|
|
2491
|
-
export declare function generatePreinstalledAutomation(automation: Automation, options?: GeneratePreinstalledAutomationOptions): Promise<NonNullablePaths<GeneratePreinstalledAutomationResponse, {
|
|
2492
|
-
[P in AutomationNonNullablePaths]: `automation.${P}`;
|
|
2493
|
-
}[AutomationNonNullablePaths]>>;
|
|
2494
|
-
export interface GeneratePreinstalledAutomationOptions {
|
|
2345
|
+
interface GeneratePreinstalledAutomationOptions {
|
|
2495
2346
|
/**
|
|
2496
2347
|
* ID of the app to which the automation belongs.
|
|
2497
2348
|
* @format GUID
|
|
2498
2349
|
*/
|
|
2499
2350
|
appId?: string;
|
|
2500
2351
|
}
|
|
2501
|
-
/**
|
|
2502
|
-
* Retrieves a list of automations. This includes both automations overridden on a site and preinstalled automations. If a preinstalled automation has been overridden on the site, the method returns the override automation.
|
|
2503
|
-
*
|
|
2504
|
-
* > **Note**: The method only returns automations by apps installed on the site.
|
|
2505
|
-
*
|
|
2506
|
-
* Learn more about [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
|
|
2507
|
-
* @public
|
|
2508
|
-
* @documentationMaturity preview
|
|
2509
|
-
* @permissionScope Manage Stores
|
|
2510
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2511
|
-
* @permissionScope Set Up Automations
|
|
2512
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2513
|
-
* @permissionId AUTOMATIONS.AUTOMATION_READ
|
|
2514
|
-
* @applicableIdentity APP
|
|
2515
|
-
* @fqn wix.automations.v2.AutomationsService.QueryAutomations
|
|
2516
|
-
*/
|
|
2517
|
-
export declare function queryAutomations(options?: QueryAutomationsOptions): AutomationsQueryBuilder;
|
|
2518
|
-
export interface QueryAutomationsOptions {
|
|
2519
|
-
}
|
|
2520
2352
|
interface QueryCursorResult {
|
|
2521
2353
|
cursors: Cursors;
|
|
2522
2354
|
hasNext: () => boolean;
|
|
@@ -2524,13 +2356,13 @@ interface QueryCursorResult {
|
|
|
2524
2356
|
length: number;
|
|
2525
2357
|
pageSize: number;
|
|
2526
2358
|
}
|
|
2527
|
-
|
|
2359
|
+
interface AutomationsQueryResult extends QueryCursorResult {
|
|
2528
2360
|
items: Automation[];
|
|
2529
2361
|
query: AutomationsQueryBuilder;
|
|
2530
2362
|
next: () => Promise<AutomationsQueryResult>;
|
|
2531
2363
|
prev: () => Promise<AutomationsQueryResult>;
|
|
2532
2364
|
}
|
|
2533
|
-
|
|
2365
|
+
interface AutomationsQueryBuilder {
|
|
2534
2366
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
2535
2367
|
* @param value - Value to compare against.
|
|
2536
2368
|
* @documentationMaturity preview
|
|
@@ -2599,89 +2431,17 @@ export interface AutomationsQueryBuilder {
|
|
|
2599
2431
|
/** @documentationMaturity preview */
|
|
2600
2432
|
find: () => Promise<AutomationsQueryResult>;
|
|
2601
2433
|
}
|
|
2602
|
-
|
|
2603
|
-
* Creates a copy of an action with a new ID, and changes the action's input mapping if necessary.
|
|
2604
|
-
*
|
|
2605
|
-
* The action copy isn't saved automatically. To save it, the user must perform an action
|
|
2606
|
-
* such as clicking the **Save** button.
|
|
2607
|
-
* @param automationId - ID of the automation to copy.
|
|
2608
|
-
* @public
|
|
2609
|
-
* @documentationMaturity preview
|
|
2610
|
-
* @requiredField automationId
|
|
2611
|
-
* @permissionId AUTOMATIONS.AUTOMATION_COPY
|
|
2612
|
-
* @permissionScope Manage Stores
|
|
2613
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2614
|
-
* @permissionScope Set Up Automations
|
|
2615
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2616
|
-
* @applicableIdentity APP
|
|
2617
|
-
* @fqn wix.automations.v2.AutomationsService.CopyAutomation
|
|
2618
|
-
*/
|
|
2619
|
-
export declare function copyAutomation(automationId: string, options?: CopyAutomationOptions): Promise<NonNullablePaths<CopyAutomationResponse, {
|
|
2620
|
-
[P in AutomationNonNullablePaths]: `automation.${P}`;
|
|
2621
|
-
}[AutomationNonNullablePaths]>>;
|
|
2622
|
-
export interface CopyAutomationOptions {
|
|
2434
|
+
interface CopyAutomationOptions {
|
|
2623
2435
|
/** Origin of the automation to copy. */
|
|
2624
2436
|
origin?: OriginWithLiterals;
|
|
2625
2437
|
/** Automation to copy. Skips fetching by ID. */
|
|
2626
2438
|
automation?: Automation;
|
|
2627
2439
|
}
|
|
2628
|
-
|
|
2629
|
-
* Creates a draft automation.
|
|
2630
|
-
* @public
|
|
2631
|
-
* @documentationMaturity preview
|
|
2632
|
-
* @permissionId AUTOMATIONS.AUTOMATION_DRAFT_CREATE
|
|
2633
|
-
* @permissionScope Manage Stores
|
|
2634
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2635
|
-
* @permissionScope Set Up Automations
|
|
2636
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2637
|
-
* @applicableIdentity APP
|
|
2638
|
-
* @fqn wix.automations.v2.AutomationsService.CreateDraftAutomation
|
|
2639
|
-
*/
|
|
2640
|
-
export declare function createDraftAutomation(options?: CreateDraftAutomationOptions): Promise<NonNullablePaths<CreateDraftAutomationResponse, {
|
|
2641
|
-
[P in AutomationNonNullablePaths]: `automation.${P}`;
|
|
2642
|
-
}[AutomationNonNullablePaths]>>;
|
|
2643
|
-
export interface CreateDraftAutomationOptions {
|
|
2440
|
+
interface CreateDraftAutomationOptions {
|
|
2644
2441
|
/** Draft automation to create. */
|
|
2645
2442
|
automation?: Automation;
|
|
2646
2443
|
}
|
|
2647
|
-
|
|
2648
|
-
* Retrieves the draft of the specified automation. If a draft doesn't exist, the method creates one.
|
|
2649
|
-
*
|
|
2650
|
-
* > **Note**: If the specified automation is a draft, the method returns it.
|
|
2651
|
-
* @param originalAutomationId - ID of the original automation on which the draft is based.
|
|
2652
|
-
* @public
|
|
2653
|
-
* @documentationMaturity preview
|
|
2654
|
-
* @requiredField originalAutomationId
|
|
2655
|
-
* @permissionId AUTOMATIONS.AUTOMATION_DRAFT_CREATE
|
|
2656
|
-
* @permissionScope Manage Stores
|
|
2657
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2658
|
-
* @permissionScope Set Up Automations
|
|
2659
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2660
|
-
* @applicableIdentity APP
|
|
2661
|
-
* @fqn wix.automations.v2.AutomationsService.GetOrCreateDraftAutomation
|
|
2662
|
-
*/
|
|
2663
|
-
export declare function getOrCreateDraftAutomation(originalAutomationId: string): Promise<NonNullablePaths<GetOrCreateDraftAutomationResponse, {
|
|
2664
|
-
[P in AutomationNonNullablePaths]: `automation.${P}`;
|
|
2665
|
-
}[AutomationNonNullablePaths]>>;
|
|
2666
|
-
/**
|
|
2667
|
-
* Updates a draft automation.
|
|
2668
|
-
* @param _id - Automation ID.
|
|
2669
|
-
* @public
|
|
2670
|
-
* @documentationMaturity preview
|
|
2671
|
-
* @requiredField _id
|
|
2672
|
-
* @requiredField automation
|
|
2673
|
-
* @permissionId AUTOMATIONS.AUTOMATION_DRAFT_UPDATE
|
|
2674
|
-
* @permissionScope Manage Stores
|
|
2675
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2676
|
-
* @permissionScope Set Up Automations
|
|
2677
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2678
|
-
* @applicableIdentity APP
|
|
2679
|
-
* @fqn wix.automations.v2.AutomationsService.UpdateDraftAutomation
|
|
2680
|
-
*/
|
|
2681
|
-
export declare function updateDraftAutomation(_id: string, automation: UpdateDraftAutomation): Promise<NonNullablePaths<UpdateDraftAutomationResponse, {
|
|
2682
|
-
[P in AutomationNonNullablePaths]: `automation.${P}`;
|
|
2683
|
-
}[AutomationNonNullablePaths]>>;
|
|
2684
|
-
export interface UpdateDraftAutomation {
|
|
2444
|
+
interface UpdateDraftAutomation {
|
|
2685
2445
|
/** When the origin of the automation is `APPLICATION`, the details of the app that created it. */
|
|
2686
2446
|
applicationInfo?: ApplicationOrigin;
|
|
2687
2447
|
/** When the origin of the automation is `PREINSTALLED`, the details of the preinstalled automation. */
|
|
@@ -2750,36 +2510,7 @@ export interface UpdateDraftAutomation {
|
|
|
2750
2510
|
*/
|
|
2751
2511
|
archived?: boolean;
|
|
2752
2512
|
}
|
|
2753
|
-
|
|
2754
|
-
* Retrieves a list of automations, including drafts. Max query filter depth is 3.
|
|
2755
|
-
*
|
|
2756
|
-
* Relevant automations for the query are returned. This includes automations created on the site and pre-installed automations.
|
|
2757
|
-
* If there's an existing override for a pre-installed automation, the override is returned in the query result.
|
|
2758
|
-
* The query only returns automations from apps that are installed on the site.
|
|
2759
|
-
*
|
|
2760
|
-
* - new drafts that are not related to existing automations will be returned in the list
|
|
2761
|
-
* - the response will contain a map of originalAutomationId => relatedDrafts
|
|
2762
|
-
*
|
|
2763
|
-
* To learn about working with _Query_ endpoints, see
|
|
2764
|
-
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
|
2765
|
-
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),
|
|
2766
|
-
* and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
|
2767
|
-
* @public
|
|
2768
|
-
* @documentationMaturity preview
|
|
2769
|
-
* @permissionId AUTOMATIONS.AUTOMATION_DRAFT_READ
|
|
2770
|
-
* @permissionScope Manage Stores
|
|
2771
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2772
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
2773
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2774
|
-
* @permissionScope Set Up Automations
|
|
2775
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2776
|
-
* @applicableIdentity APP
|
|
2777
|
-
* @fqn wix.automations.v2.AutomationsService.QueryAutomationsWithDrafts
|
|
2778
|
-
*/
|
|
2779
|
-
export declare function queryAutomationsWithDrafts(options?: QueryAutomationsWithDraftsOptions): Promise<NonNullablePaths<QueryAutomationsWithDraftsResponse, {
|
|
2780
|
-
[P in AutomationNonNullablePaths]: `automations.${number}.${P}`;
|
|
2781
|
-
}[AutomationNonNullablePaths]>>;
|
|
2782
|
-
export interface QueryAutomationsWithDraftsOptions {
|
|
2513
|
+
interface QueryAutomationsWithDraftsOptions {
|
|
2783
2514
|
/**
|
|
2784
2515
|
* Query.
|
|
2785
2516
|
*
|
|
@@ -2787,94 +2518,15 @@ export interface QueryAutomationsWithDraftsOptions {
|
|
|
2787
2518
|
*/
|
|
2788
2519
|
query?: CursorQuery;
|
|
2789
2520
|
}
|
|
2790
|
-
|
|
2791
|
-
* Deletes a draft automation.
|
|
2792
|
-
* @param automationId - ID of the draft automation to delete.
|
|
2793
|
-
* @public
|
|
2794
|
-
* @documentationMaturity preview
|
|
2795
|
-
* @requiredField automationId
|
|
2796
|
-
* @permissionId AUTOMATIONS.AUTOMATION_DRAFT_DELETE
|
|
2797
|
-
* @permissionScope Manage Stores
|
|
2798
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2799
|
-
* @permissionScope Set Up Automations
|
|
2800
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2801
|
-
* @applicableIdentity APP
|
|
2802
|
-
* @fqn wix.automations.v2.AutomationsService.DeleteDraftAutomation
|
|
2803
|
-
*/
|
|
2804
|
-
export declare function deleteDraftAutomation(automationId: string): Promise<void>;
|
|
2805
|
-
/**
|
|
2806
|
-
* Publishes a draft automation. This applies any changes to the live automation.
|
|
2807
|
-
* @param automationId - ID of the draft automation to publish.
|
|
2808
|
-
* @public
|
|
2809
|
-
* @documentationMaturity preview
|
|
2810
|
-
* @requiredField automationId
|
|
2811
|
-
* @permissionId AUTOMATIONS.AUTOMATION_UPDATE
|
|
2812
|
-
* @permissionScope Manage Stores
|
|
2813
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2814
|
-
* @permissionScope Set Up Automations
|
|
2815
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2816
|
-
* @applicableIdentity APP
|
|
2817
|
-
* @fqn wix.automations.v2.AutomationsService.PublishDraftAutomation
|
|
2818
|
-
*/
|
|
2819
|
-
export declare function publishDraftAutomation(automationId: string): Promise<NonNullablePaths<PublishDraftAutomationResponse, {
|
|
2820
|
-
[P in AutomationNonNullablePaths]: `automation.${P}`;
|
|
2821
|
-
}[AutomationNonNullablePaths]>>;
|
|
2822
|
-
/**
|
|
2823
|
-
* Validates the specified automation.
|
|
2824
|
-
* @param automation - Automation to validate.
|
|
2825
|
-
* @public
|
|
2826
|
-
* @documentationMaturity preview
|
|
2827
|
-
* @requiredField automation
|
|
2828
|
-
* @permissionId AUTOMATIONS.AUTOMATION_VALIDATE
|
|
2829
|
-
* @permissionScope Manage Stores
|
|
2830
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2831
|
-
* @permissionScope Set Up Automations
|
|
2832
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2833
|
-
* @applicableIdentity APP
|
|
2834
|
-
* @fqn wix.automations.v2.AutomationsService.ValidateAutomation
|
|
2835
|
-
*/
|
|
2836
|
-
export declare function validateAutomation(automation: Automation, options?: ValidateAutomationOptions): Promise<NonNullablePaths<ValidateAutomationResponse, `valid` | `triggerValidationErrors` | `triggerValidationErrors.${number}.configurationError.errorType` | `triggerValidationErrors.${number}.providerConfigurationError.message` | `triggerValidationErrors.${number}.providerConfigurationError.title` | `triggerValidationErrors.${number}.errorType` | `triggerValidationErrors.${number}.severity` | `actionValidationInfo` | `actionValidationInfo.${number}.appId` | `actionValidationInfo.${number}.actionKey` | `automationValidationErrors` | `automationValidationErrors.${number}.configurationError.errorType` | `automationValidationErrors.${number}.providerConfigurationError.message` | `automationValidationErrors.${number}.providerConfigurationError.title` | `automationValidationErrors.${number}.errorType` | `automationValidationErrors.${number}.severity`>>;
|
|
2837
|
-
export interface ValidateAutomationOptions {
|
|
2521
|
+
interface ValidateAutomationOptions {
|
|
2838
2522
|
/** Automation validation settings. */
|
|
2839
2523
|
validationSettings?: ValidationSettings;
|
|
2840
2524
|
}
|
|
2841
|
-
|
|
2842
|
-
* Validates the automation specified by ID.
|
|
2843
|
-
* @param automationId - Automation ID.
|
|
2844
|
-
* @public
|
|
2845
|
-
* @documentationMaturity preview
|
|
2846
|
-
* @requiredField automationId
|
|
2847
|
-
* @permissionId AUTOMATIONS.AUTOMATION_VALIDATE
|
|
2848
|
-
* @permissionScope Manage Stores
|
|
2849
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2850
|
-
* @permissionScope Set Up Automations
|
|
2851
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2852
|
-
* @applicableIdentity APP
|
|
2853
|
-
* @fqn wix.automations.v2.AutomationsService.ValidateAutomationById
|
|
2854
|
-
*/
|
|
2855
|
-
export declare function validateAutomationById(automationId: string, options?: ValidateAutomationByIdOptions): Promise<NonNullablePaths<ValidateAutomationByIdResponse, `valid` | `triggerValidationErrors` | `triggerValidationErrors.${number}.configurationError.errorType` | `triggerValidationErrors.${number}.providerConfigurationError.message` | `triggerValidationErrors.${number}.providerConfigurationError.title` | `triggerValidationErrors.${number}.errorType` | `triggerValidationErrors.${number}.severity` | `actionValidationInfo` | `actionValidationInfo.${number}.appId` | `actionValidationInfo.${number}.actionKey` | `automationValidationErrors` | `automationValidationErrors.${number}.configurationError.errorType` | `automationValidationErrors.${number}.providerConfigurationError.message` | `automationValidationErrors.${number}.providerConfigurationError.title` | `automationValidationErrors.${number}.errorType` | `automationValidationErrors.${number}.severity`>>;
|
|
2856
|
-
export interface ValidateAutomationByIdOptions {
|
|
2525
|
+
interface ValidateAutomationByIdOptions {
|
|
2857
2526
|
/** Validation settings. */
|
|
2858
2527
|
validationSettings?: ValidationSettings;
|
|
2859
2528
|
}
|
|
2860
|
-
|
|
2861
|
-
* Gets the specified automation revision.
|
|
2862
|
-
* @param automationId - Automation ID.
|
|
2863
|
-
* @public
|
|
2864
|
-
* @documentationMaturity preview
|
|
2865
|
-
* @requiredField automationId
|
|
2866
|
-
* @permissionId AUTOMATIONS.AUTOMATION_REVISION_READ
|
|
2867
|
-
* @permissionScope Manage Stores
|
|
2868
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2869
|
-
* @permissionScope Set Up Automations
|
|
2870
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2871
|
-
* @applicableIdentity APP
|
|
2872
|
-
* @fqn wix.automations.v2.AutomationRevisionsService.GetAutomationRevision
|
|
2873
|
-
*/
|
|
2874
|
-
export declare function getAutomationRevision(automationId: string, options?: GetAutomationRevisionOptions): Promise<NonNullablePaths<GetAutomationRevisionResponse, {
|
|
2875
|
-
[P in AutomationNonNullablePaths]: `automation.${P}`;
|
|
2876
|
-
}[AutomationNonNullablePaths]>>;
|
|
2877
|
-
export interface GetAutomationRevisionOptions {
|
|
2529
|
+
interface GetAutomationRevisionOptions {
|
|
2878
2530
|
/** Revision number. */
|
|
2879
2531
|
revision?: string | null;
|
|
2880
2532
|
/**
|
|
@@ -2883,4 +2535,5 @@ export interface GetAutomationRevisionOptions {
|
|
|
2883
2535
|
*/
|
|
2884
2536
|
fields?: RequestedFieldsWithLiterals[];
|
|
2885
2537
|
}
|
|
2886
|
-
|
|
2538
|
+
|
|
2539
|
+
export { type FutureDateActivationOffset as $, type Automation as A, type BulkDeleteAutomationsResponse as B, type CopyAutomationOptions as C, Domain as D, ValidationErrorType as E, ActionErrorType as F, type GeneratePreinstalledAutomationOptions as G, AutomationValidationErrorValidationErrorType as H, AutomationErrorType as I, type AutomationOriginInfoOneOf as J, type ActionSettings as K, Language as L, type Enrichment as M, Namespace as N, Operator as O, type PublishDraftAutomationResponse as P, type QueryAutomationsWithDraftsOptions as Q, RequestedFields as R, Status as S, TimeUnit as T, type UpdateAutomation as U, type ValidateAutomationOptions as V, WebhookIdentityType as W, type AuditInfo as X, type AuditInfoIdOneOf as Y, type AutomationConfiguration as Z, type Filter as _, type GeneratePreinstalledAutomationResponse as a, type GeneratePreinstalledAutomationRequest as a$, type RateLimit as a0, type FilterValueSelection as a1, type ConditionExpressionGroup as a2, type Path as a3, type AppDefinedAction as a4, type ConditionAction as a5, type DelayAction as a6, type RateLimitAction as a7, type SetVariablesAction as a8, type OutputAction as a9, type TestUpdateApplicationAutomationResponse as aA, type MessageEnvelope as aB, type IdentificationData as aC, type IdentificationDataIdOneOf as aD, type CodeSnippet as aE, type CodeConditionAction as aF, type CreateAutomationRequest as aG, type CreateAutomationResponse as aH, type GetAutomationRequest as aI, type GetAutomationResponse as aJ, type UpdateAutomationRequest as aK, type UpdateAutomationResponse as aL, type DeleteAutomationRequest as aM, type DeleteAutomationResponse as aN, type BulkDeleteAutomationsRequest as aO, type BulkDeleteResult as aP, type ItemMetadata as aQ, type ApplicationError as aR, type BulkActionMetadata as aS, type CreatePreinstalledAutomationRequest as aT, type PreinstalledAutomationSpecInfo as aU, type OriginAutomationInfo as aV, type CreatePreinstalledAutomationResponse as aW, type UpdatePreinstalledAutomationRequest as aX, type UpdatePreinstalledAutomationResponse as aY, type DeletePreinstalledAutomationRequest as aZ, type DeletePreinstalledAutomationResponse as a_, type SplitAction as aa, type Trigger as ab, type Action as ac, type ActionInfoOneOf as ad, type FilterableAppDefinedActions as ae, type ApplicationOrigin as af, type PreinstalledOrigin as ag, type AutomationSettings as ah, type DraftInfo as ai, type Enrichments as aj, type ExtendedFields as ak, type AutomationMigrationRequest as al, type UpdatedWithPreviousEntity as am, type DeletedWithEntity as an, type DraftPublished as ao, type DomainEvent as ap, type DomainEventBodyOneOf as aq, type EntityCreatedEvent as ar, type RestoreInfo as as, type EntityUpdatedEvent as at, type EntityDeletedEvent as au, type ActionEvent as av, type Empty as aw, type UpdateApplicationAutomationsRequest as ax, type UpdateApplicationAutomationsResponse as ay, type TestUpdateApplicationAutomationRequest as az, type AutomationsQueryBuilder as b, type GetAutomationActionSchemaResponse as b$, type QueryPreinstalledAutomationsForAppRequest as b0, type CursorQuery as b1, type CursorQueryPagingMethodOneOf as b2, type Sorting as b3, type CursorPaging as b4, type QueryPreinstalledAutomationsForAppResponse as b5, type CursorPagingMetadata as b6, type Cursors as b7, type QueryAutomationsRequest as b8, type QueryAutomationsResponse as b9, type OdeditorAssigned as bA, type OdeditorUnassigned as bB, type PicassoAssigned as bC, type PicassoUnassigned as bD, type CreateDraftAutomationRequest as bE, type GetOrCreateDraftAutomationRequest as bF, type UpdateDraftAutomationRequest as bG, type QueryAutomationsWithDraftsRequest as bH, type DraftsInfo as bI, type DeleteDraftAutomationRequest as bJ, type DeleteDraftAutomationResponse as bK, type PublishDraftAutomationRequest as bL, type ValidateAutomationRequest as bM, type ValidationSettings as bN, type TriggerValidationError as bO, type TriggerValidationErrorErrorOneOf as bP, type TriggerConfigurationError as bQ, type ProviderConfigurationError as bR, type ActionValidationInfo as bS, type ActionValidationError as bT, type ActionValidationErrorErrorOneOf as bU, type ActionConfigurationError as bV, type AutomationValidationError as bW, type AutomationValidationErrorErrorOneOf as bX, type AutomationConfigurationError as bY, type ValidateAutomationByIdRequest as bZ, type GetAutomationActionSchemaRequest as b_, type GetAggregatedUsageInfoRequest as ba, type GetAggregatedUsageInfoResponse as bb, type TriggerUsageSummary as bc, type ActionUsageSummary as bd, type CopyAutomationRequest as be, type MetaSiteSpecialEvent as bf, type MetaSiteSpecialEventPayloadOneOf as bg, type Asset as bh, type SiteCreated as bi, type SiteTransferred as bj, type SiteDeleted as bk, type DeleteContext as bl, type SiteUndeleted as bm, type SitePublished as bn, type SiteUnpublished as bo, type SiteMarkedAsTemplate as bp, type SiteMarkedAsWixSite as bq, type ServiceProvisioned as br, type ServiceRemoved as bs, type SiteRenamed as bt, type SiteHardDeleted as bu, type NamespaceChanged as bv, type StudioAssigned as bw, type StudioUnassigned as bx, type SiteUrlChanged as by, type SitePurgedExternally as bz, type CopyAutomationResponse as c, type GetActionsQuotaInfoRequest as c0, type GetActionsQuotaInfoResponse as c1, type ActionProviderQuotaInfo as c2, type ActionQuotaInfo as c3, type QuotaInfo as c4, type Plan as c5, type Quota as c6, type CTA as c7, type AdditionalInfo as c8, type UpgradeCTA as c9, type MigrateVeloActionAutomationsRequest as ca, type MigrateVeloActionAutomationsResponse as cb, type GetAutomationRevisionRequest as cc, type BaseEventMetadata as cd, type EventMetadata as ce, type AutomationsQueryResult as cf, type CreateDraftAutomationOptions as d, type CreateDraftAutomationResponse as e, type GetOrCreateDraftAutomationResponse as f, type UpdateDraftAutomation as g, type UpdateDraftAutomationResponse as h, type QueryAutomationsWithDraftsResponse as i, type ValidateAutomationResponse as j, type ValidateAutomationByIdOptions as k, type ValidateAutomationByIdResponse as l, type GetAutomationRevisionOptions as m, type GetAutomationRevisionResponse as n, type AutomationCreatedEnvelope as o, type AutomationDeletedEnvelope as p, type AutomationUpdatedEnvelope as q, Type as r, Origin as s, SortOrder as t, State as u, SiteCreatedContext as v, DeleteStatus as w, TriggerValidationErrorValidationErrorType as x, TriggerErrorType as y, ValidationErrorSeverity as z };
|