@wix/auto_sdk_automations_automations-v-2 1.0.3 → 1.0.5
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 → automations-v2-automation-automations-v-2.universal-BVuQcd6J.d.mts} +223 -567
- package/build/{cjs/src/automations-v2-automation-automations-v-2.universal.d.ts → automations-v2-automation-automations-v-2.universal-BVuQcd6J.d.ts} +223 -567
- package/build/index.d.mts +202 -0
- package/build/index.d.ts +202 -0
- package/build/index.js +1562 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +1498 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{es/src/automations-v2-automation-automations-v-2.universal.d.ts → automations-v2-automation-automations-v-2.universal-BVuQcd6J.d.mts} +223 -567
- package/build/{es/src/automations-v2-automation-automations-v-2.universal.d.ts → internal/automations-v2-automation-automations-v-2.universal-BVuQcd6J.d.ts} +223 -567
- package/build/internal/index.d.mts +202 -0
- package/build/internal/index.d.ts +202 -0
- package/build/internal/index.js +1562 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +1498 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +1167 -0
- package/build/internal/meta.d.ts +1167 -0
- package/build/internal/meta.js +963 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +920 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +1167 -0
- package/build/meta.d.ts +1167 -0
- package/build/meta.js +963 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +920 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/automations-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 -2222
- package/build/cjs/src/automations-v2-automation-automations-v-2.types.js +0 -275
- 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 -1024
- 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/package.json +0 -3
- 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 -2222
- package/build/es/src/automations-v2-automation-automations-v-2.types.js +0 -272
- 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 -981
- package/build/es/src/automations-v2-automation-automations-v-2.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/automations-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 -2222
- package/build/internal/cjs/src/automations-v2-automation-automations-v-2.types.js +0 -275
- 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 -1024
- 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 -2222
- package/build/internal/es/src/automations-v2-automation-automations-v-2.types.js +0 -272
- 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 -981
- package/build/internal/es/src/automations-v2-automation-automations-v-2.universal.js.map +0 -1
|
@@ -1,2222 +0,0 @@
|
|
|
1
|
-
export interface Automation extends AutomationOriginInfoOneOf {
|
|
2
|
-
/** When the origin of the automation is `APPLICATION`, the details of the app that created it. */
|
|
3
|
-
applicationInfo?: ApplicationOrigin;
|
|
4
|
-
/** When the origin of the automation is `PREINSTALLED`, the details of the preinstalled automation. */
|
|
5
|
-
preinstalledInfo?: PreinstalledOrigin;
|
|
6
|
-
/**
|
|
7
|
-
* Automation ID.
|
|
8
|
-
* @format GUID
|
|
9
|
-
* @readonly
|
|
10
|
-
*/
|
|
11
|
-
id?: string | null;
|
|
12
|
-
/**
|
|
13
|
-
* Revision number. This increments by 1 whenever the automation is updated. Specify the current revision number whenever updating an existing automation.
|
|
14
|
-
* @readonly
|
|
15
|
-
*/
|
|
16
|
-
revision?: string | null;
|
|
17
|
-
/**
|
|
18
|
-
* Who created the automation.
|
|
19
|
-
* @immutable
|
|
20
|
-
* @readonly
|
|
21
|
-
*/
|
|
22
|
-
createdBy?: AuditInfo;
|
|
23
|
-
/**
|
|
24
|
-
* When the automation was created.
|
|
25
|
-
* @readonly
|
|
26
|
-
*/
|
|
27
|
-
createdDate?: Date | null;
|
|
28
|
-
/**
|
|
29
|
-
* Who last updated the automation.
|
|
30
|
-
* @readonly
|
|
31
|
-
*/
|
|
32
|
-
updatedBy?: AuditInfo;
|
|
33
|
-
/**
|
|
34
|
-
* When the automation was last updated.
|
|
35
|
-
* @readonly
|
|
36
|
-
*/
|
|
37
|
-
updatedDate?: Date | null;
|
|
38
|
-
/**
|
|
39
|
-
* Automation name as displayed on the user's site.
|
|
40
|
-
* @minLength 1
|
|
41
|
-
* @maxLength 500
|
|
42
|
-
*/
|
|
43
|
-
name?: string;
|
|
44
|
-
/**
|
|
45
|
-
* Automation description.
|
|
46
|
-
* @maxLength 2000
|
|
47
|
-
*/
|
|
48
|
-
description?: string | null;
|
|
49
|
-
/** Automation configuration. */
|
|
50
|
-
configuration?: AutomationConfiguration;
|
|
51
|
-
/**
|
|
52
|
-
* How the automation was added to the user's site.
|
|
53
|
-
* @immutable
|
|
54
|
-
*/
|
|
55
|
-
origin?: OriginWithLiterals;
|
|
56
|
-
/** Automation settings. */
|
|
57
|
-
settings?: AutomationSettings;
|
|
58
|
-
/**
|
|
59
|
-
* When the automation is a draft, the draft details.
|
|
60
|
-
* @readonly
|
|
61
|
-
*/
|
|
62
|
-
draftInfo?: DraftInfo;
|
|
63
|
-
/**
|
|
64
|
-
* Whether the automation is archived.
|
|
65
|
-
*
|
|
66
|
-
* To archive an automation, set this to `true`. To restore an archived automation, set this to `false`.
|
|
67
|
-
*/
|
|
68
|
-
archived?: boolean;
|
|
69
|
-
}
|
|
70
|
-
/** @oneof */
|
|
71
|
-
export interface AutomationOriginInfoOneOf {
|
|
72
|
-
/** When the origin of the automation is `APPLICATION`, the details of the app that created it. */
|
|
73
|
-
applicationInfo?: ApplicationOrigin;
|
|
74
|
-
/** When the origin of the automation is `PREINSTALLED`, the details of the preinstalled automation. */
|
|
75
|
-
preinstalledInfo?: PreinstalledOrigin;
|
|
76
|
-
}
|
|
77
|
-
export interface ActionSettings {
|
|
78
|
-
/**
|
|
79
|
-
* Permanent actions. Permanent actions cannot be deleted.
|
|
80
|
-
*
|
|
81
|
-
* When empty, all actions can be deleted by the user.
|
|
82
|
-
* @maxSize 30
|
|
83
|
-
* @format GUID
|
|
84
|
-
*/
|
|
85
|
-
permanentActionIds?: string[];
|
|
86
|
-
/**
|
|
87
|
-
* Read-only actions. Read-only actions cannot be edited.
|
|
88
|
-
*
|
|
89
|
-
* When empty, all actions are editable.
|
|
90
|
-
* @maxSize 30
|
|
91
|
-
* @format GUID
|
|
92
|
-
*/
|
|
93
|
-
readonlyActionIds?: string[];
|
|
94
|
-
/**
|
|
95
|
-
* Whether to disable the ability to add a delay to the automation.
|
|
96
|
-
*
|
|
97
|
-
* Default: `false`.
|
|
98
|
-
*/
|
|
99
|
-
disableDelayAddition?: boolean;
|
|
100
|
-
/**
|
|
101
|
-
* Whether to disable the ability to add a condition to the automation.
|
|
102
|
-
*
|
|
103
|
-
* Default: `false`.
|
|
104
|
-
*/
|
|
105
|
-
disableConditionAddition?: boolean;
|
|
106
|
-
}
|
|
107
|
-
export declare enum Domain {
|
|
108
|
-
/** User domain (default). */
|
|
109
|
-
USER = "USER",
|
|
110
|
-
/** Wix domain. */
|
|
111
|
-
WIX = "WIX",
|
|
112
|
-
/** Wix account-level domain. */
|
|
113
|
-
WIX_ACCOUNT = "WIX_ACCOUNT"
|
|
114
|
-
}
|
|
115
|
-
/** @enumType */
|
|
116
|
-
export type DomainWithLiterals = Domain | 'USER' | 'WIX' | 'WIX_ACCOUNT';
|
|
117
|
-
export interface Enrichment {
|
|
118
|
-
/**
|
|
119
|
-
* Enrichment input mappings.
|
|
120
|
-
* @maxSize 2
|
|
121
|
-
*/
|
|
122
|
-
inputMappings?: Record<string, any>[] | null;
|
|
123
|
-
}
|
|
124
|
-
export interface AuditInfo extends AuditInfoIdOneOf {
|
|
125
|
-
/**
|
|
126
|
-
* [User ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#user-id).
|
|
127
|
-
* @format GUID
|
|
128
|
-
*/
|
|
129
|
-
userId?: string;
|
|
130
|
-
/**
|
|
131
|
-
* [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
|
|
132
|
-
*
|
|
133
|
-
* You can find the app ID on the [Home page](https://manage.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%home) in the app's dashboard.
|
|
134
|
-
* @format GUID
|
|
135
|
-
*/
|
|
136
|
-
appId?: string;
|
|
137
|
-
}
|
|
138
|
-
/** @oneof */
|
|
139
|
-
export interface AuditInfoIdOneOf {
|
|
140
|
-
/**
|
|
141
|
-
* [User ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#user-id).
|
|
142
|
-
* @format GUID
|
|
143
|
-
*/
|
|
144
|
-
userId?: string;
|
|
145
|
-
/**
|
|
146
|
-
* [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
|
|
147
|
-
*
|
|
148
|
-
* You can find the app ID on the [Home page](https://manage.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%home) in the app's dashboard.
|
|
149
|
-
* @format GUID
|
|
150
|
-
*/
|
|
151
|
-
appId?: string;
|
|
152
|
-
}
|
|
153
|
-
export interface AutomationConfiguration {
|
|
154
|
-
/** Status of the automation on the site. */
|
|
155
|
-
status?: StatusWithLiterals;
|
|
156
|
-
/** Trigger configuration. */
|
|
157
|
-
trigger?: Trigger;
|
|
158
|
-
/**
|
|
159
|
-
* Root action IDs. A root action is the first action that runs after the trigger occurs. Root actions run in parallel.
|
|
160
|
-
*
|
|
161
|
-
* > **Note**: You can currently only specify 1 root action.
|
|
162
|
-
* @maxSize 20
|
|
163
|
-
* @format GUID
|
|
164
|
-
*/
|
|
165
|
-
rootActionIds?: string[];
|
|
166
|
-
/** 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. */
|
|
167
|
-
actions?: Record<string, Action>;
|
|
168
|
-
}
|
|
169
|
-
export declare enum TimeUnit {
|
|
170
|
-
UNKNOWN_TIME_UNIT = "UNKNOWN_TIME_UNIT",
|
|
171
|
-
/** Minutes. */
|
|
172
|
-
MINUTES = "MINUTES",
|
|
173
|
-
/** Hours. */
|
|
174
|
-
HOURS = "HOURS",
|
|
175
|
-
/** Days. */
|
|
176
|
-
DAYS = "DAYS",
|
|
177
|
-
/** Weeks. */
|
|
178
|
-
WEEKS = "WEEKS",
|
|
179
|
-
/** Months. */
|
|
180
|
-
MONTHS = "MONTHS"
|
|
181
|
-
}
|
|
182
|
-
/** @enumType */
|
|
183
|
-
export type TimeUnitWithLiterals = TimeUnit | 'UNKNOWN_TIME_UNIT' | 'MINUTES' | 'HOURS' | 'DAYS' | 'WEEKS' | 'MONTHS';
|
|
184
|
-
export interface Filter {
|
|
185
|
-
/**
|
|
186
|
-
* Filter ID.
|
|
187
|
-
* @format GUID
|
|
188
|
-
*/
|
|
189
|
-
id?: string;
|
|
190
|
-
/**
|
|
191
|
-
* Field key.
|
|
192
|
-
*
|
|
193
|
-
* You can find the field key in [the trigger payload schema](https://dev.wix.com/docs/rest/business-management/automations/triggers/the-trigger-payload-schema).
|
|
194
|
-
* @minLength 1
|
|
195
|
-
* @maxLength 110
|
|
196
|
-
*/
|
|
197
|
-
fieldKey?: string;
|
|
198
|
-
/**
|
|
199
|
-
* Filter expression.
|
|
200
|
-
*
|
|
201
|
-
* For the automation to run, the expression must evaluate to `true`.
|
|
202
|
-
* @maxLength 2500
|
|
203
|
-
*/
|
|
204
|
-
filterExpression?: string;
|
|
205
|
-
}
|
|
206
|
-
export interface FutureDateActivationOffset {
|
|
207
|
-
/**
|
|
208
|
-
* Amount of time before the trigger to run the automation.
|
|
209
|
-
*
|
|
210
|
-
* > **Note**: To delay an automation after the trigger event occurs, use a [delay action](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/about-automation-configuration#delay-action).
|
|
211
|
-
* @maxLength 1000
|
|
212
|
-
*/
|
|
213
|
-
preScheduledEventOffsetExpression?: string;
|
|
214
|
-
/** Unit in which to set the action offset. */
|
|
215
|
-
scheduledEventOffsetTimeUnit?: TimeUnitWithLiterals;
|
|
216
|
-
}
|
|
217
|
-
export interface RateLimit {
|
|
218
|
-
/**
|
|
219
|
-
* Maximum number of times the trigger can be activated.
|
|
220
|
-
* @maxLength 1000
|
|
221
|
-
*/
|
|
222
|
-
maxActivationsExpression?: string;
|
|
223
|
-
/**
|
|
224
|
-
* Duration of the rate limit. The rate limit applies for the specified duration and then expires.
|
|
225
|
-
*
|
|
226
|
-
* When empty, the rate limit does not expire.
|
|
227
|
-
* @maxLength 1000
|
|
228
|
-
*/
|
|
229
|
-
durationExpression?: string | null;
|
|
230
|
-
/** Unit in which to set the duration of the rate limit. */
|
|
231
|
-
durationTimeUnit?: TimeUnitWithLiterals;
|
|
232
|
-
/**
|
|
233
|
-
* Activation identifier used to count the number of activations.
|
|
234
|
-
* @minLength 1
|
|
235
|
-
* @maxLength 400
|
|
236
|
-
*/
|
|
237
|
-
uniqueIdentifierExpression?: string | null;
|
|
238
|
-
}
|
|
239
|
-
export interface FilterValueSelection {
|
|
240
|
-
/**
|
|
241
|
-
* Values that can help the user filter certain automations. Specify values in the following format: `<filter_id>__<selected_value>`.
|
|
242
|
-
* @maxLength 80
|
|
243
|
-
* @maxSize 50
|
|
244
|
-
*/
|
|
245
|
-
selectedFilterValues?: string[];
|
|
246
|
-
}
|
|
247
|
-
export interface ConditionExpressionGroup {
|
|
248
|
-
/** Logical operator used to evaluate the condition expressions. */
|
|
249
|
-
operator?: OperatorWithLiterals;
|
|
250
|
-
/**
|
|
251
|
-
* Expressions evaluated using the selected operator.
|
|
252
|
-
* @minSize 1
|
|
253
|
-
* @maxSize 20
|
|
254
|
-
* @maxLength 2500
|
|
255
|
-
*/
|
|
256
|
-
booleanExpressions?: string[];
|
|
257
|
-
}
|
|
258
|
-
export declare enum Operator {
|
|
259
|
-
/** Unknown. */
|
|
260
|
-
UNKNOWN_OPERATOR = "UNKNOWN_OPERATOR",
|
|
261
|
-
/** `OR` operator. */
|
|
262
|
-
OR = "OR",
|
|
263
|
-
/** `AND` operator. */
|
|
264
|
-
AND = "AND"
|
|
265
|
-
}
|
|
266
|
-
/** @enumType */
|
|
267
|
-
export type OperatorWithLiterals = Operator | 'UNKNOWN_OPERATOR' | 'OR' | 'AND';
|
|
268
|
-
/** Path definition */
|
|
269
|
-
export interface Path {
|
|
270
|
-
/**
|
|
271
|
-
* Unique path ID.
|
|
272
|
-
* @format GUID
|
|
273
|
-
*/
|
|
274
|
-
id?: string;
|
|
275
|
-
/**
|
|
276
|
-
* Path display name.
|
|
277
|
-
* @minLength 1
|
|
278
|
-
* @maxLength 100
|
|
279
|
-
*/
|
|
280
|
-
name?: string;
|
|
281
|
-
/**
|
|
282
|
-
* ID of the action to run when this path is taken.
|
|
283
|
-
* @format GUID
|
|
284
|
-
*/
|
|
285
|
-
postActionId?: string | null;
|
|
286
|
-
}
|
|
287
|
-
export declare enum Type {
|
|
288
|
-
/** Based on the trigger. */
|
|
289
|
-
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
290
|
-
/** 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. */
|
|
291
|
-
APP_DEFINED = "APP_DEFINED",
|
|
292
|
-
/** Condition. This determines which action runs next. */
|
|
293
|
-
CONDITION = "CONDITION",
|
|
294
|
-
/** Delay. The automation must wait before executing the next step. */
|
|
295
|
-
DELAY = "DELAY",
|
|
296
|
-
/** Rate-limiter. This stops the automation flow if the subsequent action has reached its maximum allowed executions. */
|
|
297
|
-
RATE_LIMIT = "RATE_LIMIT"
|
|
298
|
-
}
|
|
299
|
-
/** @enumType */
|
|
300
|
-
export type TypeWithLiterals = Type | 'UNKNOWN_ACTION_TYPE' | 'APP_DEFINED' | 'CONDITION' | 'DELAY' | 'RATE_LIMIT';
|
|
301
|
-
export interface AppDefinedAction {
|
|
302
|
-
/**
|
|
303
|
-
* ID of the app that defines the action.
|
|
304
|
-
* @format GUID
|
|
305
|
-
*/
|
|
306
|
-
appId?: string;
|
|
307
|
-
/**
|
|
308
|
-
* Action key.
|
|
309
|
-
* @minLength 1
|
|
310
|
-
* @maxLength 100
|
|
311
|
-
*/
|
|
312
|
-
actionKey?: string;
|
|
313
|
-
/** Action input mapping as defined in the action's [input schema](https://dev.wix.com/docs/rest/business-management/automations/actions/the-action-input-schema). */
|
|
314
|
-
inputMapping?: Record<string, any> | null;
|
|
315
|
-
/**
|
|
316
|
-
* Action skip conditions. An action is skipped if any of the specified conditions evaluates to `true`.
|
|
317
|
-
*
|
|
318
|
-
* > **Note**: Actions that follow a skipped action still run.
|
|
319
|
-
* @maxSize 10
|
|
320
|
-
*/
|
|
321
|
-
skipConditionOrExpressionGroups?: ConditionExpressionGroup[];
|
|
322
|
-
/**
|
|
323
|
-
* IDs of actions that run in parallel after the action completes.
|
|
324
|
-
* @maxSize 20
|
|
325
|
-
* @format GUID
|
|
326
|
-
*/
|
|
327
|
-
postActionIds?: string[];
|
|
328
|
-
/** Action output schema. When specified, this replaces the action schema. */
|
|
329
|
-
overrideOutputSchema?: Record<string, any> | null;
|
|
330
|
-
}
|
|
331
|
-
export interface ConditionAction {
|
|
332
|
-
/**
|
|
333
|
-
* Condition is `true` if one or more of the expression groups evaluates to `true`.
|
|
334
|
-
* @minSize 1
|
|
335
|
-
* @maxSize 10
|
|
336
|
-
*/
|
|
337
|
-
orExpressionGroups?: ConditionExpressionGroup[];
|
|
338
|
-
/**
|
|
339
|
-
* IDs of actions to run when the condition evaluates to `true`.
|
|
340
|
-
* @maxSize 20
|
|
341
|
-
* @format GUID
|
|
342
|
-
*/
|
|
343
|
-
truePostActionIds?: string[];
|
|
344
|
-
/**
|
|
345
|
-
* IDs of actions to run when the condition evaluates to `false`.
|
|
346
|
-
* @maxSize 20
|
|
347
|
-
* @format GUID
|
|
348
|
-
*/
|
|
349
|
-
falsePostActionIds?: string[];
|
|
350
|
-
}
|
|
351
|
-
export interface DelayAction {
|
|
352
|
-
/**
|
|
353
|
-
* Time to wait before running the action. The wait time starts from when the current action completes.
|
|
354
|
-
*
|
|
355
|
-
* > **Note**: To define the wait time from a specific moment in time, use `dueDateEpochExpression`.
|
|
356
|
-
* @maxLength 1000
|
|
357
|
-
*/
|
|
358
|
-
offsetExpression?: string | null;
|
|
359
|
-
/** Unit in which to set the wait time to wait before the action runs. */
|
|
360
|
-
offsetTimeUnit?: TimeUnitWithLiterals;
|
|
361
|
-
/**
|
|
362
|
-
* Action run date in milliseconds elapsed since January 1, 1970 UTC.
|
|
363
|
-
*
|
|
364
|
-
* > **Note**: If an `offsetExpression` is defined, the delay is calculated from the time of the offset.
|
|
365
|
-
* @maxLength 1000
|
|
366
|
-
*/
|
|
367
|
-
dueDateEpochExpression?: string | null;
|
|
368
|
-
/**
|
|
369
|
-
* IDs of actions to run in parallel after the time delay.
|
|
370
|
-
* @maxSize 20
|
|
371
|
-
* @format GUID
|
|
372
|
-
*/
|
|
373
|
-
postActionIds?: string[];
|
|
374
|
-
}
|
|
375
|
-
export interface RateLimitAction {
|
|
376
|
-
/**
|
|
377
|
-
* Maximum number of times the action can run.
|
|
378
|
-
* @maxLength 1000
|
|
379
|
-
*/
|
|
380
|
-
maxActivationsExpression?: string;
|
|
381
|
-
/**
|
|
382
|
-
* Rate limit duration.
|
|
383
|
-
*
|
|
384
|
-
* When empty, the rate limit does not expire.
|
|
385
|
-
* @maxLength 1000
|
|
386
|
-
*/
|
|
387
|
-
rateLimitDurationExpression?: string | null;
|
|
388
|
-
/** Unit in which to set the duration of the rate limit. */
|
|
389
|
-
rateLimitDurationTimeUnit?: TimeUnitWithLiterals;
|
|
390
|
-
/**
|
|
391
|
-
* Unique identifier of each activation by which rate limiter counts activations.
|
|
392
|
-
* @minLength 1
|
|
393
|
-
* @maxLength 400
|
|
394
|
-
*/
|
|
395
|
-
uniqueIdentifierExpression?: string | null;
|
|
396
|
-
/**
|
|
397
|
-
* IDs of actions to run in parallel after the action completes.
|
|
398
|
-
* @maxSize 20
|
|
399
|
-
* @format GUID
|
|
400
|
-
*/
|
|
401
|
-
postActionIds?: string[];
|
|
402
|
-
}
|
|
403
|
-
export interface SetVariablesAction {
|
|
404
|
-
/** Output mapping. For example: `{"someField": "{{10}}", "someOtherField": "{{multiply( var('account.points.balance') ;2 )}}" }`. */
|
|
405
|
-
outputMapping?: Record<string, any> | null;
|
|
406
|
-
/**
|
|
407
|
-
* Output JSON schema representation.
|
|
408
|
-
*
|
|
409
|
-
* > **Note**: To minimize request size, you can also specify a string.
|
|
410
|
-
*/
|
|
411
|
-
outputSchema?: Record<string, any> | null;
|
|
412
|
-
/**
|
|
413
|
-
* IDs of actions to run in parallel after variable initialization.
|
|
414
|
-
* @maxSize 20
|
|
415
|
-
* @format GUID
|
|
416
|
-
*/
|
|
417
|
-
postActionIds?: string[];
|
|
418
|
-
}
|
|
419
|
-
export interface OutputAction {
|
|
420
|
-
/** Output action output mapping. */
|
|
421
|
-
outputMapping?: Record<string, any> | null;
|
|
422
|
-
}
|
|
423
|
-
export interface SplitAction {
|
|
424
|
-
/**
|
|
425
|
-
* List of paths to split execution into.
|
|
426
|
-
* @minSize 2
|
|
427
|
-
* @maxSize 10
|
|
428
|
-
*/
|
|
429
|
-
paths?: Path[];
|
|
430
|
-
}
|
|
431
|
-
export declare enum Status {
|
|
432
|
-
/** Unknown. */
|
|
433
|
-
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
434
|
-
/** Active. Active automations can be triggered. */
|
|
435
|
-
ACTIVE = "ACTIVE",
|
|
436
|
-
/** Inactive. Inactive automations cannot be triggered. */
|
|
437
|
-
INACTIVE = "INACTIVE"
|
|
438
|
-
}
|
|
439
|
-
/** @enumType */
|
|
440
|
-
export type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'ACTIVE' | 'INACTIVE';
|
|
441
|
-
export interface Trigger {
|
|
442
|
-
/**
|
|
443
|
-
* ID of the app that defines the trigger.
|
|
444
|
-
* @format GUID
|
|
445
|
-
*/
|
|
446
|
-
appId?: string;
|
|
447
|
-
/**
|
|
448
|
-
* Trigger key.
|
|
449
|
-
*
|
|
450
|
-
* Learn about [setting up a trigger](https://dev.wix.com/docs/rest/business-management/automations/triggers/add-a-trigger-to-your-app#step-1--set-up-the-trigger).
|
|
451
|
-
* @minLength 1
|
|
452
|
-
* @maxLength 100
|
|
453
|
-
*/
|
|
454
|
-
triggerKey?: string;
|
|
455
|
-
/**
|
|
456
|
-
* Schema field filters. All filter conditions must be met for the automation to run.
|
|
457
|
-
*
|
|
458
|
-
* Learn more about setting up [automation filters](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/about-automation-configuration#filters).
|
|
459
|
-
* @maxSize 5
|
|
460
|
-
*/
|
|
461
|
-
filters?: Filter[];
|
|
462
|
-
/**
|
|
463
|
-
* Automation offset. You can schedule automations to run before the trigger occurs.
|
|
464
|
-
*
|
|
465
|
-
* Learn more about [scheduled events](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/configure-your-automation#scheduled-events).
|
|
466
|
-
*/
|
|
467
|
-
scheduledEventOffset?: FutureDateActivationOffset;
|
|
468
|
-
/** Limit on the number of times an automation can be triggered. */
|
|
469
|
-
rateLimit?: RateLimit;
|
|
470
|
-
/** Trigger schema override. When specified, this replaces the trigger schema. */
|
|
471
|
-
overrideSchema?: Record<string, any> | null;
|
|
472
|
-
}
|
|
473
|
-
export interface Action extends ActionInfoOneOf {
|
|
474
|
-
/** Details of the action when its `type` is `APP_DEFINED`. */
|
|
475
|
-
appDefinedInfo?: AppDefinedAction;
|
|
476
|
-
/** Details of the action when its `type` is `CONDITION`. */
|
|
477
|
-
conditionInfo?: ConditionAction;
|
|
478
|
-
/** Details of the action when its `type` is `CODE_CONDITION`. */
|
|
479
|
-
codeConditionInfo?: CodeConditionAction;
|
|
480
|
-
/** Details of the action when its `type` is `DELAY`. */
|
|
481
|
-
delayInfo?: DelayAction;
|
|
482
|
-
/** Details of the action when its `type` is `RATE_LIMIT`. */
|
|
483
|
-
rateLimitInfo?: RateLimitAction;
|
|
484
|
-
/**
|
|
485
|
-
* Action ID.
|
|
486
|
-
*
|
|
487
|
-
* If not specified, automatically generated by Wix.
|
|
488
|
-
* @format GUID
|
|
489
|
-
*/
|
|
490
|
-
id?: string | null;
|
|
491
|
-
/** [Action type](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/about-automation-configuration#action-type). */
|
|
492
|
-
type?: TypeWithLiterals;
|
|
493
|
-
/**
|
|
494
|
-
* [Action namespace](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/about-automation-configuration#namespace). This differentiates it from other actions of the same type.
|
|
495
|
-
*
|
|
496
|
-
* If the action outputs any data, the data appears under the namespace in the payload sent to the subsequent steps in the automation. If the user has multiple actions with the same `appId` and `actionKey`, the output of the previous action is overwritten.
|
|
497
|
-
* @minLength 1
|
|
498
|
-
* @maxLength 100
|
|
499
|
-
*/
|
|
500
|
-
namespace?: string | null;
|
|
501
|
-
}
|
|
502
|
-
/** @oneof */
|
|
503
|
-
export interface ActionInfoOneOf {
|
|
504
|
-
/** Details of the action when its `type` is `APP_DEFINED`. */
|
|
505
|
-
appDefinedInfo?: AppDefinedAction;
|
|
506
|
-
/** Details of the action when its `type` is `CONDITION`. */
|
|
507
|
-
conditionInfo?: ConditionAction;
|
|
508
|
-
/** Details of the action when its `type` is `CODE_CONDITION`. */
|
|
509
|
-
codeConditionInfo?: CodeConditionAction;
|
|
510
|
-
/** Details of the action when its `type` is `DELAY`. */
|
|
511
|
-
delayInfo?: DelayAction;
|
|
512
|
-
/** Details of the action when its `type` is `RATE_LIMIT`. */
|
|
513
|
-
rateLimitInfo?: RateLimitAction;
|
|
514
|
-
}
|
|
515
|
-
export interface FilterableAppDefinedActions {
|
|
516
|
-
/**
|
|
517
|
-
* App-defined action identifiers. Identifiers have the following format: `${appId}_${actionKey}`.
|
|
518
|
-
* @minSize 1
|
|
519
|
-
* @maxSize 100
|
|
520
|
-
* @minLength 1
|
|
521
|
-
* @maxLength 150
|
|
522
|
-
*/
|
|
523
|
-
actionIdentifiers?: string[];
|
|
524
|
-
}
|
|
525
|
-
export declare enum Origin {
|
|
526
|
-
/** Default value. */
|
|
527
|
-
UNKNOWN_ORIGIN = "UNKNOWN_ORIGIN",
|
|
528
|
-
/** Created by a [Wix user](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#wix-user). */
|
|
529
|
-
USER = "USER",
|
|
530
|
-
/** Created by a [Wix app](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#wix-app) for a particular site. */
|
|
531
|
-
APPLICATION = "APPLICATION",
|
|
532
|
-
/** [Preinstalled automation](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/pre-installed-automations/about-pre-installed-automations). */
|
|
533
|
-
PREINSTALLED = "PREINSTALLED"
|
|
534
|
-
}
|
|
535
|
-
/** @enumType */
|
|
536
|
-
export type OriginWithLiterals = Origin | 'UNKNOWN_ORIGIN' | 'USER' | 'APPLICATION' | 'PREINSTALLED';
|
|
537
|
-
export interface ApplicationOrigin {
|
|
538
|
-
/**
|
|
539
|
-
* [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
|
|
540
|
-
*
|
|
541
|
-
* You can find the app ID on the [Home page](https://manage.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%home) in the app's dashboard.
|
|
542
|
-
* @format GUID
|
|
543
|
-
*/
|
|
544
|
-
appId?: string;
|
|
545
|
-
}
|
|
546
|
-
export interface PreinstalledOrigin {
|
|
547
|
-
/**
|
|
548
|
-
* 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).
|
|
549
|
-
* @format GUID
|
|
550
|
-
*/
|
|
551
|
-
appId?: string;
|
|
552
|
-
/**
|
|
553
|
-
* Whether the automation is an override.
|
|
554
|
-
*
|
|
555
|
-
* When a user modifies the preinstalled automation installed on their site, a site-specific version of the automation is created that overrides the automation that was originally installed. This override automation has the same automation ID as the original preinstalled automation.
|
|
556
|
-
*
|
|
557
|
-
* > **Note**: An override automation can no longer be updated by the app that originally installed it.
|
|
558
|
-
* >
|
|
559
|
-
* > To revert to the original preinstalled version, the user must delete the override by calling the Delete Automation method. Calling Delete Automation on an override automation removes the override method and restores the preinstalled automation that was previously installed.
|
|
560
|
-
*
|
|
561
|
-
* Default: `false`.
|
|
562
|
-
* @immutable
|
|
563
|
-
* @readonly
|
|
564
|
-
*/
|
|
565
|
-
override?: boolean | null;
|
|
566
|
-
}
|
|
567
|
-
export interface AutomationSettings {
|
|
568
|
-
/**
|
|
569
|
-
* Whether the automation is hidden from users.
|
|
570
|
-
*
|
|
571
|
-
* Default: `false`
|
|
572
|
-
*/
|
|
573
|
-
hidden?: boolean;
|
|
574
|
-
/**
|
|
575
|
-
* Whether the automation is read-only.
|
|
576
|
-
*
|
|
577
|
-
* Default: `false`
|
|
578
|
-
*/
|
|
579
|
-
readonly?: boolean;
|
|
580
|
-
/**
|
|
581
|
-
* Whether to disable the option to delete the automation from the site.
|
|
582
|
-
*
|
|
583
|
-
* Default: `false`.
|
|
584
|
-
*/
|
|
585
|
-
disableDelete?: boolean;
|
|
586
|
-
/**
|
|
587
|
-
* Whether to disable the option to change the automation's `configuration.status`, for example from `ACTIVE` to `INACTIVE`.
|
|
588
|
-
*
|
|
589
|
-
* Default: `false`.
|
|
590
|
-
*/
|
|
591
|
-
disableStatusChange?: boolean;
|
|
592
|
-
/** Automation action settings. */
|
|
593
|
-
actionSettings?: ActionSettings;
|
|
594
|
-
}
|
|
595
|
-
export interface DraftInfo {
|
|
596
|
-
/**
|
|
597
|
-
* ID of the original automation.
|
|
598
|
-
* @format GUID
|
|
599
|
-
* @readonly
|
|
600
|
-
*/
|
|
601
|
-
originalAutomationId?: string | null;
|
|
602
|
-
}
|
|
603
|
-
export interface Enrichments {
|
|
604
|
-
/** Whether the studio site enrichment is wanted. */
|
|
605
|
-
studioSite?: Enrichment;
|
|
606
|
-
}
|
|
607
|
-
export interface ExtendedFields {
|
|
608
|
-
/**
|
|
609
|
-
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
610
|
-
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
611
|
-
*
|
|
612
|
-
* You can only access fields for which you have the appropriate permissions.
|
|
613
|
-
*
|
|
614
|
-
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
615
|
-
*/
|
|
616
|
-
namespaces?: Record<string, Record<string, any>>;
|
|
617
|
-
}
|
|
618
|
-
export interface AutomationMigrationRequest {
|
|
619
|
-
/**
|
|
620
|
-
* Automation id
|
|
621
|
-
* @format GUID
|
|
622
|
-
*/
|
|
623
|
-
userAutomationId?: string;
|
|
624
|
-
/**
|
|
625
|
-
* An automation to use to migrate the old automation
|
|
626
|
-
* @readonly
|
|
627
|
-
*/
|
|
628
|
-
automation?: Automation;
|
|
629
|
-
/**
|
|
630
|
-
* List of action ids to override in the automations.
|
|
631
|
-
* @format GUID
|
|
632
|
-
* @maxSize 100
|
|
633
|
-
*/
|
|
634
|
-
overrideActionIds?: string[];
|
|
635
|
-
/** if true, the trigger will be overridden */
|
|
636
|
-
overrideTrigger?: boolean;
|
|
637
|
-
/**
|
|
638
|
-
* Job id
|
|
639
|
-
* @format GUID
|
|
640
|
-
*/
|
|
641
|
-
jobId?: string;
|
|
642
|
-
}
|
|
643
|
-
export interface UpdatedWithPreviousEntity {
|
|
644
|
-
/** Previous automation. */
|
|
645
|
-
previousAutomation?: Automation;
|
|
646
|
-
/** Updated automation. */
|
|
647
|
-
currentAutomation?: Automation;
|
|
648
|
-
}
|
|
649
|
-
export interface DeletedWithEntity {
|
|
650
|
-
/** Deleted automation. */
|
|
651
|
-
automation?: Automation;
|
|
652
|
-
}
|
|
653
|
-
export interface DraftPublished {
|
|
654
|
-
/**
|
|
655
|
-
* ID of the draft automation.
|
|
656
|
-
* @format GUID
|
|
657
|
-
*/
|
|
658
|
-
draftAutomationId?: string;
|
|
659
|
-
/**
|
|
660
|
-
* Original automation on which the draft is based.
|
|
661
|
-
*
|
|
662
|
-
* > **Note**: If the draft is not based on an existing automation, the draft itself is the original automation.
|
|
663
|
-
*/
|
|
664
|
-
draftOriginalAutomation?: Automation;
|
|
665
|
-
/** Updated, published automation. */
|
|
666
|
-
updatedAutomation?: Automation;
|
|
667
|
-
}
|
|
668
|
-
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
669
|
-
createdEvent?: EntityCreatedEvent;
|
|
670
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
671
|
-
deletedEvent?: EntityDeletedEvent;
|
|
672
|
-
actionEvent?: ActionEvent;
|
|
673
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
674
|
-
id?: string;
|
|
675
|
-
/**
|
|
676
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
677
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
678
|
-
*/
|
|
679
|
-
entityFqdn?: string;
|
|
680
|
-
/**
|
|
681
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
682
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
683
|
-
*/
|
|
684
|
-
slug?: string;
|
|
685
|
-
/** ID of the entity associated with the event. */
|
|
686
|
-
entityId?: string;
|
|
687
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
688
|
-
eventTime?: Date | null;
|
|
689
|
-
/**
|
|
690
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
691
|
-
* (for example, GDPR).
|
|
692
|
-
*/
|
|
693
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
694
|
-
/** If present, indicates the action that triggered the event. */
|
|
695
|
-
originatedFrom?: string | null;
|
|
696
|
-
/**
|
|
697
|
-
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
698
|
-
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
699
|
-
*/
|
|
700
|
-
entityEventSequence?: string | null;
|
|
701
|
-
}
|
|
702
|
-
/** @oneof */
|
|
703
|
-
export interface DomainEventBodyOneOf {
|
|
704
|
-
createdEvent?: EntityCreatedEvent;
|
|
705
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
706
|
-
deletedEvent?: EntityDeletedEvent;
|
|
707
|
-
actionEvent?: ActionEvent;
|
|
708
|
-
}
|
|
709
|
-
export interface EntityCreatedEvent {
|
|
710
|
-
entityAsJson?: string;
|
|
711
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
712
|
-
restoreInfo?: RestoreInfo;
|
|
713
|
-
}
|
|
714
|
-
export interface RestoreInfo {
|
|
715
|
-
deletedDate?: Date | null;
|
|
716
|
-
}
|
|
717
|
-
export interface EntityUpdatedEvent {
|
|
718
|
-
/**
|
|
719
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
720
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
721
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
722
|
-
*/
|
|
723
|
-
currentEntityAsJson?: string;
|
|
724
|
-
}
|
|
725
|
-
export interface EntityDeletedEvent {
|
|
726
|
-
/** Entity that was deleted. */
|
|
727
|
-
deletedEntityAsJson?: string | null;
|
|
728
|
-
}
|
|
729
|
-
export interface ActionEvent {
|
|
730
|
-
bodyAsJson?: string;
|
|
731
|
-
}
|
|
732
|
-
export interface Empty {
|
|
733
|
-
}
|
|
734
|
-
export interface UpdateApplicationAutomationsRequest {
|
|
735
|
-
/** Automation to use for updating other automations. */
|
|
736
|
-
automation?: Automation;
|
|
737
|
-
/**
|
|
738
|
-
* List of action ids to override in the automations.
|
|
739
|
-
* @format GUID
|
|
740
|
-
* @maxSize 100
|
|
741
|
-
*/
|
|
742
|
-
overrideActionIds?: string[];
|
|
743
|
-
/**
|
|
744
|
-
* An id to identify the application automations.
|
|
745
|
-
* @format GUID
|
|
746
|
-
*/
|
|
747
|
-
appDefinedExternalId?: string;
|
|
748
|
-
/**
|
|
749
|
-
* The application id to update automations for.
|
|
750
|
-
* @format GUID
|
|
751
|
-
*/
|
|
752
|
-
appId?: string;
|
|
753
|
-
/** True if the update should override the trigger. */
|
|
754
|
-
overrideTrigger?: boolean;
|
|
755
|
-
}
|
|
756
|
-
export interface UpdateApplicationAutomationsResponse {
|
|
757
|
-
/**
|
|
758
|
-
* Job id for the update process.
|
|
759
|
-
* @format GUID
|
|
760
|
-
*/
|
|
761
|
-
jobId?: string;
|
|
762
|
-
}
|
|
763
|
-
export interface TestUpdateApplicationAutomationRequest {
|
|
764
|
-
/** Automation to use for updating the test automation. */
|
|
765
|
-
automation?: Automation;
|
|
766
|
-
/**
|
|
767
|
-
* Automation id in site to update with the given automation.
|
|
768
|
-
* @format GUID
|
|
769
|
-
*/
|
|
770
|
-
automationId?: string;
|
|
771
|
-
/**
|
|
772
|
-
* List of action ids to override in the automations.
|
|
773
|
-
* @format GUID
|
|
774
|
-
* @maxSize 100
|
|
775
|
-
*/
|
|
776
|
-
overrideActionIds?: string[];
|
|
777
|
-
/**
|
|
778
|
-
* An id to identify the application automations. should be configured in the automation
|
|
779
|
-
* @format GUID
|
|
780
|
-
*/
|
|
781
|
-
appDefinedExternalId?: string;
|
|
782
|
-
/**
|
|
783
|
-
* The application id to update automations for. should be configured in the automation
|
|
784
|
-
* @format GUID
|
|
785
|
-
*/
|
|
786
|
-
appId?: string;
|
|
787
|
-
/** True if the update should override the trigger. */
|
|
788
|
-
overrideTrigger?: boolean;
|
|
789
|
-
}
|
|
790
|
-
export interface TestUpdateApplicationAutomationResponse {
|
|
791
|
-
/** The automation after the update. */
|
|
792
|
-
automation?: Automation;
|
|
793
|
-
}
|
|
794
|
-
export interface MessageEnvelope {
|
|
795
|
-
/**
|
|
796
|
-
* App instance ID.
|
|
797
|
-
* @format GUID
|
|
798
|
-
*/
|
|
799
|
-
instanceId?: string | null;
|
|
800
|
-
/**
|
|
801
|
-
* Event type.
|
|
802
|
-
* @maxLength 150
|
|
803
|
-
*/
|
|
804
|
-
eventType?: string;
|
|
805
|
-
/** The identification type and identity data. */
|
|
806
|
-
identity?: IdentificationData;
|
|
807
|
-
/** Stringify payload. */
|
|
808
|
-
data?: string;
|
|
809
|
-
}
|
|
810
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
811
|
-
/**
|
|
812
|
-
* ID of a site visitor that has not logged in to the site.
|
|
813
|
-
* @format GUID
|
|
814
|
-
*/
|
|
815
|
-
anonymousVisitorId?: string;
|
|
816
|
-
/**
|
|
817
|
-
* ID of a site visitor that has logged in to the site.
|
|
818
|
-
* @format GUID
|
|
819
|
-
*/
|
|
820
|
-
memberId?: string;
|
|
821
|
-
/**
|
|
822
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
823
|
-
* @format GUID
|
|
824
|
-
*/
|
|
825
|
-
wixUserId?: string;
|
|
826
|
-
/**
|
|
827
|
-
* ID of an app.
|
|
828
|
-
* @format GUID
|
|
829
|
-
*/
|
|
830
|
-
appId?: string;
|
|
831
|
-
/** @readonly */
|
|
832
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
833
|
-
}
|
|
834
|
-
/** @oneof */
|
|
835
|
-
export interface IdentificationDataIdOneOf {
|
|
836
|
-
/**
|
|
837
|
-
* ID of a site visitor that has not logged in to the site.
|
|
838
|
-
* @format GUID
|
|
839
|
-
*/
|
|
840
|
-
anonymousVisitorId?: string;
|
|
841
|
-
/**
|
|
842
|
-
* ID of a site visitor that has logged in to the site.
|
|
843
|
-
* @format GUID
|
|
844
|
-
*/
|
|
845
|
-
memberId?: string;
|
|
846
|
-
/**
|
|
847
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
848
|
-
* @format GUID
|
|
849
|
-
*/
|
|
850
|
-
wixUserId?: string;
|
|
851
|
-
/**
|
|
852
|
-
* ID of an app.
|
|
853
|
-
* @format GUID
|
|
854
|
-
*/
|
|
855
|
-
appId?: string;
|
|
856
|
-
}
|
|
857
|
-
export declare enum WebhookIdentityType {
|
|
858
|
-
UNKNOWN = "UNKNOWN",
|
|
859
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
860
|
-
MEMBER = "MEMBER",
|
|
861
|
-
WIX_USER = "WIX_USER",
|
|
862
|
-
APP = "APP"
|
|
863
|
-
}
|
|
864
|
-
/** @enumType */
|
|
865
|
-
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
866
|
-
export interface CodeSnippet {
|
|
867
|
-
/** Logical operator used to evaluate the condition expressions. */
|
|
868
|
-
language?: LanguageWithLiterals;
|
|
869
|
-
/**
|
|
870
|
-
* Expressions evaluated using the selected operator. this code should comply the language syntax. and format
|
|
871
|
-
* @maxLength 1000
|
|
872
|
-
*/
|
|
873
|
-
code?: string;
|
|
874
|
-
}
|
|
875
|
-
export declare enum Language {
|
|
876
|
-
/** Unknown. */
|
|
877
|
-
UNKNOWN_LANGUAGE = "UNKNOWN_LANGUAGE",
|
|
878
|
-
/** `JAVASCRIPT` language. */
|
|
879
|
-
JAVASCRIPT = "JAVASCRIPT"
|
|
880
|
-
}
|
|
881
|
-
/** @enumType */
|
|
882
|
-
export type LanguageWithLiterals = Language | 'UNKNOWN_LANGUAGE' | 'JAVASCRIPT';
|
|
883
|
-
export interface CodeConditionAction {
|
|
884
|
-
/** 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. */
|
|
885
|
-
snippet?: CodeSnippet;
|
|
886
|
-
/**
|
|
887
|
-
* IDs of actions to run when the condition evaluates to `true`.
|
|
888
|
-
* @maxSize 20
|
|
889
|
-
* @format GUID
|
|
890
|
-
*/
|
|
891
|
-
truePostActionIds?: string[];
|
|
892
|
-
/**
|
|
893
|
-
* IDs of actions to run when the condition evaluates to `false`.
|
|
894
|
-
* @maxSize 20
|
|
895
|
-
* @format GUID
|
|
896
|
-
*/
|
|
897
|
-
falsePostActionIds?: string[];
|
|
898
|
-
}
|
|
899
|
-
export interface CreateAutomationRequest {
|
|
900
|
-
/** Automation to create. */
|
|
901
|
-
automation: Automation;
|
|
902
|
-
}
|
|
903
|
-
export declare enum RequestedFields {
|
|
904
|
-
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
905
|
-
/** whether to return in response `configuration.trigger.override_output_schema` field and in `configuration.actions` the `override_output_schema` field */
|
|
906
|
-
OVERRIDE_SCHEMA = "OVERRIDE_SCHEMA"
|
|
907
|
-
}
|
|
908
|
-
/** @enumType */
|
|
909
|
-
export type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'OVERRIDE_SCHEMA';
|
|
910
|
-
export interface CreateAutomationResponse {
|
|
911
|
-
/** Details of the created automation. */
|
|
912
|
-
automation?: Automation;
|
|
913
|
-
}
|
|
914
|
-
export interface GetAutomationRequest {
|
|
915
|
-
/**
|
|
916
|
-
* Automation ID.
|
|
917
|
-
* @format GUID
|
|
918
|
-
*/
|
|
919
|
-
automationId: string;
|
|
920
|
-
}
|
|
921
|
-
export interface GetAutomationResponse {
|
|
922
|
-
/** Retrieved automation. */
|
|
923
|
-
automation?: Automation;
|
|
924
|
-
}
|
|
925
|
-
export interface UpdateAutomationRequest {
|
|
926
|
-
/** Automation to update. */
|
|
927
|
-
automation: Automation;
|
|
928
|
-
}
|
|
929
|
-
export interface UpdateAutomationResponse {
|
|
930
|
-
/** Updated automation. */
|
|
931
|
-
automation?: Automation;
|
|
932
|
-
}
|
|
933
|
-
export interface DeleteAutomationRequest {
|
|
934
|
-
/**
|
|
935
|
-
* Automation ID.
|
|
936
|
-
* @format GUID
|
|
937
|
-
*/
|
|
938
|
-
automationId: string;
|
|
939
|
-
}
|
|
940
|
-
export interface DeleteAutomationResponse {
|
|
941
|
-
}
|
|
942
|
-
export interface BulkDeleteAutomationsRequest {
|
|
943
|
-
/**
|
|
944
|
-
* IDs of the automations to delete.
|
|
945
|
-
* @format GUID
|
|
946
|
-
* @minSize 1
|
|
947
|
-
* @maxSize 200
|
|
948
|
-
*/
|
|
949
|
-
automationIds: string[];
|
|
950
|
-
}
|
|
951
|
-
export interface BulkDeleteAutomationsResponse {
|
|
952
|
-
/**
|
|
953
|
-
* Results of the bulk deletion.
|
|
954
|
-
* @minSize 1
|
|
955
|
-
* @maxSize 200
|
|
956
|
-
*/
|
|
957
|
-
results?: BulkDeleteResult[];
|
|
958
|
-
/** Metadata for the API call. */
|
|
959
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
960
|
-
}
|
|
961
|
-
export interface BulkDeleteResult {
|
|
962
|
-
/** Deleted item metadata. */
|
|
963
|
-
itemMetadata?: ItemMetadata;
|
|
964
|
-
}
|
|
965
|
-
export interface ItemMetadata {
|
|
966
|
-
/**
|
|
967
|
-
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
968
|
-
* @format GUID
|
|
969
|
-
*/
|
|
970
|
-
id?: string | null;
|
|
971
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
972
|
-
originalIndex?: number;
|
|
973
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
974
|
-
success?: boolean;
|
|
975
|
-
/** Details about the error in case of failure. */
|
|
976
|
-
error?: ApplicationError;
|
|
977
|
-
}
|
|
978
|
-
export interface ApplicationError {
|
|
979
|
-
/** Error code. */
|
|
980
|
-
code?: string;
|
|
981
|
-
/** Description of the error. */
|
|
982
|
-
description?: string;
|
|
983
|
-
/** Data related to the error. */
|
|
984
|
-
data?: Record<string, any> | null;
|
|
985
|
-
}
|
|
986
|
-
export interface BulkActionMetadata {
|
|
987
|
-
/** Number of items that were successfully processed. */
|
|
988
|
-
totalSuccesses?: number;
|
|
989
|
-
/** Number of items that couldn't be processed. */
|
|
990
|
-
totalFailures?: number;
|
|
991
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
992
|
-
undetailedFailures?: number;
|
|
993
|
-
}
|
|
994
|
-
export interface CreatePreinstalledAutomationRequest {
|
|
995
|
-
/** Preinstalled automation to create. */
|
|
996
|
-
automation?: Automation;
|
|
997
|
-
/**
|
|
998
|
-
* Hide the created automation behind a spec.
|
|
999
|
-
*
|
|
1000
|
-
* For internal use only.
|
|
1001
|
-
*/
|
|
1002
|
-
specInfo?: PreinstalledAutomationSpecInfo;
|
|
1003
|
-
/**
|
|
1004
|
-
* Original site automation used to create the current preinstalled automation.
|
|
1005
|
-
*
|
|
1006
|
-
* Usually an existing automation on a site is used to create the preinstalled automation.
|
|
1007
|
-
*
|
|
1008
|
-
* For internal use only.
|
|
1009
|
-
*/
|
|
1010
|
-
originAutomationInfo?: OriginAutomationInfo;
|
|
1011
|
-
/**
|
|
1012
|
-
* ID of the app to which the automation belongs.
|
|
1013
|
-
* @format GUID
|
|
1014
|
-
*/
|
|
1015
|
-
appId?: string;
|
|
1016
|
-
}
|
|
1017
|
-
export interface PreinstalledAutomationSpecInfo {
|
|
1018
|
-
/**
|
|
1019
|
-
* Spec to conduct on for the automation.
|
|
1020
|
-
*
|
|
1021
|
-
* For internal use only.
|
|
1022
|
-
* @maxLength 128
|
|
1023
|
-
*/
|
|
1024
|
-
spec?: string;
|
|
1025
|
-
/**
|
|
1026
|
-
* Value the spec should return in order to affect the user with the operation
|
|
1027
|
-
* e.g. creation - show the users the automation, update - show the users the updated automation, deletion - not show the users the automation
|
|
1028
|
-
* @maxLength 128
|
|
1029
|
-
*/
|
|
1030
|
-
variantValue?: string | null;
|
|
1031
|
-
/**
|
|
1032
|
-
* Version from which the experiment should decide whether to expose it to users when !conduct(spec).contains(variant_value)
|
|
1033
|
-
* For example, if 50 is set, version 49 and below (including 49) will not expose the preinstalled automation to the user.
|
|
1034
|
-
*/
|
|
1035
|
-
experimentVersion?: number;
|
|
1036
|
-
}
|
|
1037
|
-
export interface OriginAutomationInfo {
|
|
1038
|
-
/**
|
|
1039
|
-
* ID of the original automation.
|
|
1040
|
-
* @format GUID
|
|
1041
|
-
*/
|
|
1042
|
-
siteAutomationId?: string;
|
|
1043
|
-
/**
|
|
1044
|
-
* Metasite ID of the original automation.
|
|
1045
|
-
* @format GUID
|
|
1046
|
-
*/
|
|
1047
|
-
metaSiteId?: string;
|
|
1048
|
-
}
|
|
1049
|
-
export interface CreatePreinstalledAutomationResponse {
|
|
1050
|
-
/** Details of the created preinstalled automation. */
|
|
1051
|
-
automation?: Automation;
|
|
1052
|
-
}
|
|
1053
|
-
export interface UpdatePreinstalledAutomationRequest {
|
|
1054
|
-
/** Preinstalled automation to update. */
|
|
1055
|
-
automation?: Automation;
|
|
1056
|
-
/**
|
|
1057
|
-
* Hide the updated automation behind a spec.
|
|
1058
|
-
*
|
|
1059
|
-
* For internal use only.
|
|
1060
|
-
*/
|
|
1061
|
-
specInfo?: PreinstalledAutomationSpecInfo;
|
|
1062
|
-
/**
|
|
1063
|
-
* ID of the app to which the automation belongs.
|
|
1064
|
-
* @format GUID
|
|
1065
|
-
*/
|
|
1066
|
-
appId?: string;
|
|
1067
|
-
}
|
|
1068
|
-
export interface UpdatePreinstalledAutomationResponse {
|
|
1069
|
-
/** Updated preinstalled automation. */
|
|
1070
|
-
automation?: Automation;
|
|
1071
|
-
}
|
|
1072
|
-
export interface DeletePreinstalledAutomationRequest {
|
|
1073
|
-
/**
|
|
1074
|
-
* ID of the preinstalled component.
|
|
1075
|
-
* @format GUID
|
|
1076
|
-
*/
|
|
1077
|
-
componentId?: string;
|
|
1078
|
-
/**
|
|
1079
|
-
* Makes the deletion operation gradual.
|
|
1080
|
-
* The automation will not return if the variant returns for the site
|
|
1081
|
-
*
|
|
1082
|
-
* For internal use only.
|
|
1083
|
-
*/
|
|
1084
|
-
specInfo?: PreinstalledAutomationSpecInfo;
|
|
1085
|
-
/**
|
|
1086
|
-
* ID of the app to which the component belongs.
|
|
1087
|
-
* @format GUID
|
|
1088
|
-
*/
|
|
1089
|
-
appId?: string;
|
|
1090
|
-
}
|
|
1091
|
-
export interface DeletePreinstalledAutomationResponse {
|
|
1092
|
-
}
|
|
1093
|
-
export interface GeneratePreinstalledAutomationRequest {
|
|
1094
|
-
/** Automation. */
|
|
1095
|
-
automation: Automation;
|
|
1096
|
-
/**
|
|
1097
|
-
* ID of the app to which the automation belongs.
|
|
1098
|
-
* @format GUID
|
|
1099
|
-
*/
|
|
1100
|
-
appId?: string;
|
|
1101
|
-
}
|
|
1102
|
-
export interface GeneratePreinstalledAutomationResponse {
|
|
1103
|
-
/** Automation. */
|
|
1104
|
-
automation?: Automation;
|
|
1105
|
-
}
|
|
1106
|
-
export interface QueryPreinstalledAutomationsForAppRequest {
|
|
1107
|
-
/**
|
|
1108
|
-
* Query.
|
|
1109
|
-
*
|
|
1110
|
-
* Learn more about [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language).
|
|
1111
|
-
*/
|
|
1112
|
-
query?: CursorQuery;
|
|
1113
|
-
/**
|
|
1114
|
-
* ID of the app for which to query preinstalled automations.
|
|
1115
|
-
* @format GUID
|
|
1116
|
-
*/
|
|
1117
|
-
appId?: string;
|
|
1118
|
-
}
|
|
1119
|
-
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1120
|
-
/** 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`. */
|
|
1121
|
-
cursorPaging?: CursorPaging;
|
|
1122
|
-
/**
|
|
1123
|
-
* Filter object in the following format:
|
|
1124
|
-
* `"filter" : {
|
|
1125
|
-
* "fieldName1": "value1",
|
|
1126
|
-
* "fieldName2": { "$operator": "value2" }
|
|
1127
|
-
* }`
|
|
1128
|
-
*
|
|
1129
|
-
* Learn more about [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language).
|
|
1130
|
-
*/
|
|
1131
|
-
filter?: Record<string, any> | null;
|
|
1132
|
-
/**
|
|
1133
|
-
* Sort configuration in the following format:
|
|
1134
|
-
* `[{ "fieldName": "sortField1", "order": "ASC" }, { "fieldName":" sortField2", "order": "DESC" }]`
|
|
1135
|
-
* @maxSize 5
|
|
1136
|
-
*/
|
|
1137
|
-
sort?: Sorting[];
|
|
1138
|
-
}
|
|
1139
|
-
/** @oneof */
|
|
1140
|
-
export interface CursorQueryPagingMethodOneOf {
|
|
1141
|
-
/** 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`. */
|
|
1142
|
-
cursorPaging?: CursorPaging;
|
|
1143
|
-
}
|
|
1144
|
-
export interface Sorting {
|
|
1145
|
-
/**
|
|
1146
|
-
* Name of the field to sort by.
|
|
1147
|
-
* @maxLength 512
|
|
1148
|
-
*/
|
|
1149
|
-
fieldName?: string;
|
|
1150
|
-
/** Sort order. */
|
|
1151
|
-
order?: SortOrderWithLiterals;
|
|
1152
|
-
}
|
|
1153
|
-
export declare enum SortOrder {
|
|
1154
|
-
ASC = "ASC",
|
|
1155
|
-
DESC = "DESC"
|
|
1156
|
-
}
|
|
1157
|
-
/** @enumType */
|
|
1158
|
-
export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1159
|
-
export interface CursorPaging {
|
|
1160
|
-
/**
|
|
1161
|
-
* Maximum number of items to return in the results.
|
|
1162
|
-
* @max 500
|
|
1163
|
-
*/
|
|
1164
|
-
limit?: number | null;
|
|
1165
|
-
/**
|
|
1166
|
-
* Pointer to the next or previous page in the list of results.
|
|
1167
|
-
*
|
|
1168
|
-
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
1169
|
-
* Not relevant for the first request.
|
|
1170
|
-
* @maxLength 64000
|
|
1171
|
-
*/
|
|
1172
|
-
cursor?: string | null;
|
|
1173
|
-
}
|
|
1174
|
-
export interface QueryPreinstalledAutomationsForAppResponse {
|
|
1175
|
-
/** Automations. */
|
|
1176
|
-
automations?: Automation[];
|
|
1177
|
-
/** Paging metadata. */
|
|
1178
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
1179
|
-
}
|
|
1180
|
-
export interface CursorPagingMetadata {
|
|
1181
|
-
/** Number of items returned in the response. */
|
|
1182
|
-
count?: number | null;
|
|
1183
|
-
/** Cursor strings that point to the next page, previous page, or both. */
|
|
1184
|
-
cursors?: Cursors;
|
|
1185
|
-
/**
|
|
1186
|
-
* Whether there are more pages to retrieve following the current page.
|
|
1187
|
-
*
|
|
1188
|
-
* + `true`: Another page of results can be retrieved.
|
|
1189
|
-
* + `false`: This is the last page.
|
|
1190
|
-
*/
|
|
1191
|
-
hasNext?: boolean | null;
|
|
1192
|
-
}
|
|
1193
|
-
export interface Cursors {
|
|
1194
|
-
/**
|
|
1195
|
-
* Cursor string pointing to the next page in the list of results.
|
|
1196
|
-
* @maxLength 64000
|
|
1197
|
-
*/
|
|
1198
|
-
next?: string | null;
|
|
1199
|
-
/**
|
|
1200
|
-
* Cursor pointing to the previous page in the list of results.
|
|
1201
|
-
* @maxLength 64000
|
|
1202
|
-
*/
|
|
1203
|
-
prev?: string | null;
|
|
1204
|
-
}
|
|
1205
|
-
export interface QueryAutomationsRequest {
|
|
1206
|
-
/**
|
|
1207
|
-
* Query.
|
|
1208
|
-
*
|
|
1209
|
-
* Learn more about [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language).
|
|
1210
|
-
*
|
|
1211
|
-
* > **Note**: To query archived automations, specify `{ "archived": true }` in the [query filter object](https://dev.wix.com/docs/rest/articles/get-started/api-query-language#filters).
|
|
1212
|
-
*/
|
|
1213
|
-
query?: CursorQuery;
|
|
1214
|
-
}
|
|
1215
|
-
export interface QueryAutomationsResponse {
|
|
1216
|
-
/** Automations. */
|
|
1217
|
-
automations?: Automation[];
|
|
1218
|
-
/** Paging metadata. */
|
|
1219
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
1220
|
-
}
|
|
1221
|
-
export interface GetAggregatedUsageInfoRequest {
|
|
1222
|
-
/**
|
|
1223
|
-
* Filter in the following format:
|
|
1224
|
-
*
|
|
1225
|
-
* `"filter" :
|
|
1226
|
-
* {
|
|
1227
|
-
* "fieldName1": "value1",
|
|
1228
|
-
* "fieldName2":{"$operator":"value2"}
|
|
1229
|
-
* }`
|
|
1230
|
-
*
|
|
1231
|
-
* Learn more about [filters in API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language#filters).
|
|
1232
|
-
*/
|
|
1233
|
-
filter?: Record<string, any> | null;
|
|
1234
|
-
}
|
|
1235
|
-
export interface GetAggregatedUsageInfoResponse {
|
|
1236
|
-
/** Triggers in use. */
|
|
1237
|
-
triggersUsageSummary?: TriggerUsageSummary[];
|
|
1238
|
-
/** Actions in use */
|
|
1239
|
-
actionsUsageSummary?: ActionUsageSummary[];
|
|
1240
|
-
}
|
|
1241
|
-
export interface TriggerUsageSummary {
|
|
1242
|
-
/**
|
|
1243
|
-
* ID of the app that defined the trigger.
|
|
1244
|
-
* @format GUID
|
|
1245
|
-
*/
|
|
1246
|
-
appId?: string;
|
|
1247
|
-
/**
|
|
1248
|
-
* Trigger key.
|
|
1249
|
-
* @minLength 1
|
|
1250
|
-
* @maxLength 100
|
|
1251
|
-
*/
|
|
1252
|
-
triggerKey?: string;
|
|
1253
|
-
/** Number of automations that include this trigger. */
|
|
1254
|
-
automationsCount?: number;
|
|
1255
|
-
}
|
|
1256
|
-
export interface ActionUsageSummary {
|
|
1257
|
-
/**
|
|
1258
|
-
* ID of the app that defined the action.
|
|
1259
|
-
* @format GUID
|
|
1260
|
-
*/
|
|
1261
|
-
appId?: string;
|
|
1262
|
-
/**
|
|
1263
|
-
* Action key.
|
|
1264
|
-
* @minLength 1
|
|
1265
|
-
* @maxLength 100
|
|
1266
|
-
*/
|
|
1267
|
-
actionKey?: string;
|
|
1268
|
-
/** Number of automations that include this action. */
|
|
1269
|
-
automationsCount?: number;
|
|
1270
|
-
}
|
|
1271
|
-
export interface CopyAutomationRequest {
|
|
1272
|
-
/**
|
|
1273
|
-
* ID of the automation to copy.
|
|
1274
|
-
* @format GUID
|
|
1275
|
-
*/
|
|
1276
|
-
automationId: string;
|
|
1277
|
-
/** Origin of the automation to copy. */
|
|
1278
|
-
origin?: OriginWithLiterals;
|
|
1279
|
-
/** Automation to copy. Skips fetching by ID. */
|
|
1280
|
-
automation?: Automation;
|
|
1281
|
-
}
|
|
1282
|
-
export interface CopyAutomationResponse {
|
|
1283
|
-
/** Copy of the automation. */
|
|
1284
|
-
automation?: Automation;
|
|
1285
|
-
}
|
|
1286
|
-
export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
1287
|
-
/** Emitted on a meta site creation. */
|
|
1288
|
-
siteCreated?: SiteCreated;
|
|
1289
|
-
/** Emitted on a meta site transfer completion. */
|
|
1290
|
-
siteTransferred?: SiteTransferred;
|
|
1291
|
-
/** Emitted on a meta site deletion. */
|
|
1292
|
-
siteDeleted?: SiteDeleted;
|
|
1293
|
-
/** Emitted on a meta site restoration. */
|
|
1294
|
-
siteUndeleted?: SiteUndeleted;
|
|
1295
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
1296
|
-
sitePublished?: SitePublished;
|
|
1297
|
-
/** Emitted on a meta site unpublish. */
|
|
1298
|
-
siteUnpublished?: SiteUnpublished;
|
|
1299
|
-
/** Emitted when meta site is marked as template. */
|
|
1300
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
1301
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
1302
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
1303
|
-
/** Emitted when an application is provisioned (installed). */
|
|
1304
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
1305
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
1306
|
-
serviceRemoved?: ServiceRemoved;
|
|
1307
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
1308
|
-
siteRenamedPayload?: SiteRenamed;
|
|
1309
|
-
/** Emitted when meta site was permanently deleted. */
|
|
1310
|
-
hardDeleted?: SiteHardDeleted;
|
|
1311
|
-
/** Emitted on a namespace change. */
|
|
1312
|
-
namespaceChanged?: NamespaceChanged;
|
|
1313
|
-
/** Emitted when Studio is attached. */
|
|
1314
|
-
studioAssigned?: StudioAssigned;
|
|
1315
|
-
/** Emitted when Studio is detached. */
|
|
1316
|
-
studioUnassigned?: StudioUnassigned;
|
|
1317
|
-
/**
|
|
1318
|
-
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
1319
|
-
* the actual URL.
|
|
1320
|
-
*
|
|
1321
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
1322
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
1323
|
-
*/
|
|
1324
|
-
urlChanged?: SiteUrlChanged;
|
|
1325
|
-
/** Site is marked as PurgedExternally */
|
|
1326
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
1327
|
-
/** Emitted when Odeditor is attached. */
|
|
1328
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
1329
|
-
/** Emitted when Odeditor is detached. */
|
|
1330
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
1331
|
-
/** Emitted when Picasso is attached. */
|
|
1332
|
-
picassoAssigned?: PicassoAssigned;
|
|
1333
|
-
/** Emitted when Picasso is detached. */
|
|
1334
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
1335
|
-
/**
|
|
1336
|
-
* A meta site id.
|
|
1337
|
-
* @format GUID
|
|
1338
|
-
*/
|
|
1339
|
-
metaSiteId?: string;
|
|
1340
|
-
/** A meta site version. Monotonically increasing. */
|
|
1341
|
-
version?: string;
|
|
1342
|
-
/** A timestamp of the event. */
|
|
1343
|
-
timestamp?: string;
|
|
1344
|
-
/**
|
|
1345
|
-
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
1346
|
-
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
1347
|
-
* @maxSize 4000
|
|
1348
|
-
*/
|
|
1349
|
-
assets?: Asset[];
|
|
1350
|
-
}
|
|
1351
|
-
/** @oneof */
|
|
1352
|
-
export interface MetaSiteSpecialEventPayloadOneOf {
|
|
1353
|
-
/** Emitted on a meta site creation. */
|
|
1354
|
-
siteCreated?: SiteCreated;
|
|
1355
|
-
/** Emitted on a meta site transfer completion. */
|
|
1356
|
-
siteTransferred?: SiteTransferred;
|
|
1357
|
-
/** Emitted on a meta site deletion. */
|
|
1358
|
-
siteDeleted?: SiteDeleted;
|
|
1359
|
-
/** Emitted on a meta site restoration. */
|
|
1360
|
-
siteUndeleted?: SiteUndeleted;
|
|
1361
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
1362
|
-
sitePublished?: SitePublished;
|
|
1363
|
-
/** Emitted on a meta site unpublish. */
|
|
1364
|
-
siteUnpublished?: SiteUnpublished;
|
|
1365
|
-
/** Emitted when meta site is marked as template. */
|
|
1366
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
1367
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
1368
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
1369
|
-
/** Emitted when an application is provisioned (installed). */
|
|
1370
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
1371
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
1372
|
-
serviceRemoved?: ServiceRemoved;
|
|
1373
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
1374
|
-
siteRenamedPayload?: SiteRenamed;
|
|
1375
|
-
/** Emitted when meta site was permanently deleted. */
|
|
1376
|
-
hardDeleted?: SiteHardDeleted;
|
|
1377
|
-
/** Emitted on a namespace change. */
|
|
1378
|
-
namespaceChanged?: NamespaceChanged;
|
|
1379
|
-
/** Emitted when Studio is attached. */
|
|
1380
|
-
studioAssigned?: StudioAssigned;
|
|
1381
|
-
/** Emitted when Studio is detached. */
|
|
1382
|
-
studioUnassigned?: StudioUnassigned;
|
|
1383
|
-
/**
|
|
1384
|
-
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
1385
|
-
* the actual URL.
|
|
1386
|
-
*
|
|
1387
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
1388
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
1389
|
-
*/
|
|
1390
|
-
urlChanged?: SiteUrlChanged;
|
|
1391
|
-
/** Site is marked as PurgedExternally */
|
|
1392
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
1393
|
-
/** Emitted when Odeditor is attached. */
|
|
1394
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
1395
|
-
/** Emitted when Odeditor is detached. */
|
|
1396
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
1397
|
-
/** Emitted when Picasso is attached. */
|
|
1398
|
-
picassoAssigned?: PicassoAssigned;
|
|
1399
|
-
/** Emitted when Picasso is detached. */
|
|
1400
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
1401
|
-
}
|
|
1402
|
-
export interface Asset {
|
|
1403
|
-
/**
|
|
1404
|
-
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
1405
|
-
* @maxLength 36
|
|
1406
|
-
*/
|
|
1407
|
-
appDefId?: string;
|
|
1408
|
-
/**
|
|
1409
|
-
* An instance id. For legacy reasons may be UUID or a string.
|
|
1410
|
-
* @maxLength 200
|
|
1411
|
-
*/
|
|
1412
|
-
instanceId?: string;
|
|
1413
|
-
/** An application state. */
|
|
1414
|
-
state?: StateWithLiterals;
|
|
1415
|
-
}
|
|
1416
|
-
export declare enum State {
|
|
1417
|
-
UNKNOWN = "UNKNOWN",
|
|
1418
|
-
ENABLED = "ENABLED",
|
|
1419
|
-
DISABLED = "DISABLED",
|
|
1420
|
-
PENDING = "PENDING",
|
|
1421
|
-
DEMO = "DEMO"
|
|
1422
|
-
}
|
|
1423
|
-
/** @enumType */
|
|
1424
|
-
export type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
1425
|
-
export interface SiteCreated {
|
|
1426
|
-
/**
|
|
1427
|
-
* A template identifier (empty if not created from a template).
|
|
1428
|
-
* @maxLength 36
|
|
1429
|
-
*/
|
|
1430
|
-
originTemplateId?: string;
|
|
1431
|
-
/**
|
|
1432
|
-
* An account id of the owner.
|
|
1433
|
-
* @format GUID
|
|
1434
|
-
*/
|
|
1435
|
-
ownerId?: string;
|
|
1436
|
-
/** A context in which meta site was created. */
|
|
1437
|
-
context?: SiteCreatedContextWithLiterals;
|
|
1438
|
-
/**
|
|
1439
|
-
* A meta site id from which this site was created.
|
|
1440
|
-
*
|
|
1441
|
-
* In case of a creation from a template it's a template id.
|
|
1442
|
-
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
1443
|
-
* @format GUID
|
|
1444
|
-
*/
|
|
1445
|
-
originMetaSiteId?: string | null;
|
|
1446
|
-
/**
|
|
1447
|
-
* A meta site name (URL slug).
|
|
1448
|
-
* @maxLength 20
|
|
1449
|
-
*/
|
|
1450
|
-
siteName?: string;
|
|
1451
|
-
/** A namespace. */
|
|
1452
|
-
namespace?: NamespaceWithLiterals;
|
|
1453
|
-
}
|
|
1454
|
-
export declare enum SiteCreatedContext {
|
|
1455
|
-
/** A valid option, we don't expose all reasons why site might be created. */
|
|
1456
|
-
OTHER = "OTHER",
|
|
1457
|
-
/** A meta site was created from template. */
|
|
1458
|
-
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
1459
|
-
/** A meta site was created by copying of the transfferred meta site. */
|
|
1460
|
-
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
1461
|
-
/** A copy of existing meta site. */
|
|
1462
|
-
DUPLICATE = "DUPLICATE",
|
|
1463
|
-
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
1464
|
-
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
1465
|
-
/** deprecated A meta site was created for Flash editor. */
|
|
1466
|
-
FLASH = "FLASH"
|
|
1467
|
-
}
|
|
1468
|
-
/** @enumType */
|
|
1469
|
-
export type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
1470
|
-
export declare enum Namespace {
|
|
1471
|
-
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
1472
|
-
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
1473
|
-
WIX = "WIX",
|
|
1474
|
-
/** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1475
|
-
SHOUT_OUT = "SHOUT_OUT",
|
|
1476
|
-
/** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1477
|
-
ALBUMS = "ALBUMS",
|
|
1478
|
-
/** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1479
|
-
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
1480
|
-
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1481
|
-
HOTELS = "HOTELS",
|
|
1482
|
-
/** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1483
|
-
CLUBS = "CLUBS",
|
|
1484
|
-
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1485
|
-
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
1486
|
-
/** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1487
|
-
DEV_SITE = "DEV_SITE",
|
|
1488
|
-
/** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1489
|
-
LOGOS = "LOGOS",
|
|
1490
|
-
/** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1491
|
-
VIDEO_MAKER = "VIDEO_MAKER",
|
|
1492
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1493
|
-
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
1494
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1495
|
-
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
1496
|
-
/**
|
|
1497
|
-
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
1498
|
-
*
|
|
1499
|
-
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
1500
|
-
*/
|
|
1501
|
-
HTML_DRAFT = "HTML_DRAFT",
|
|
1502
|
-
/**
|
|
1503
|
-
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
1504
|
-
* Will be accessible from Site List and will not have a website app.
|
|
1505
|
-
* Once the user attaches a site, the site will become a regular wixsite.
|
|
1506
|
-
*/
|
|
1507
|
-
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
1508
|
-
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
1509
|
-
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
1510
|
-
/** It is to be used in the Business First efforts. */
|
|
1511
|
-
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
1512
|
-
/** Bookings business flow with no site. */
|
|
1513
|
-
ANYWHERE = "ANYWHERE",
|
|
1514
|
-
/** Namespace for Headless Backoffice with no editor */
|
|
1515
|
-
HEADLESS = "HEADLESS",
|
|
1516
|
-
/**
|
|
1517
|
-
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
1518
|
-
* The site will be used for account level CSM feature for enterprise
|
|
1519
|
-
*/
|
|
1520
|
-
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
1521
|
-
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
1522
|
-
RISE = "RISE",
|
|
1523
|
-
/**
|
|
1524
|
-
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
1525
|
-
* There's a blank site behind the scene but it's blank).
|
|
1526
|
-
* The Mobile company will be the owner of this namespace.
|
|
1527
|
-
*/
|
|
1528
|
-
BRANDED_FIRST = "BRANDED_FIRST",
|
|
1529
|
-
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
1530
|
-
NOWNIA = "NOWNIA",
|
|
1531
|
-
/**
|
|
1532
|
-
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
1533
|
-
* The Partners company owns this namespace.
|
|
1534
|
-
*/
|
|
1535
|
-
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
1536
|
-
/** Codux Headless Sites */
|
|
1537
|
-
CODUX = "CODUX",
|
|
1538
|
-
/** Bobb - AI Design Creator. */
|
|
1539
|
-
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
1540
|
-
/**
|
|
1541
|
-
* Shared Blog Site is a unique single site across Enterprise account,
|
|
1542
|
-
* This site will hold all Blog posts related to the Marketing product.
|
|
1543
|
-
*/
|
|
1544
|
-
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
1545
|
-
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1546
|
-
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
1547
|
-
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1548
|
-
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
1549
|
-
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
1550
|
-
MIMIR = "MIMIR"
|
|
1551
|
-
}
|
|
1552
|
-
/** @enumType */
|
|
1553
|
-
export 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';
|
|
1554
|
-
/** Site transferred to another user. */
|
|
1555
|
-
export interface SiteTransferred {
|
|
1556
|
-
/**
|
|
1557
|
-
* A previous owner id (user that transfers meta site).
|
|
1558
|
-
* @format GUID
|
|
1559
|
-
*/
|
|
1560
|
-
oldOwnerId?: string;
|
|
1561
|
-
/**
|
|
1562
|
-
* A new owner id (user that accepts meta site).
|
|
1563
|
-
* @format GUID
|
|
1564
|
-
*/
|
|
1565
|
-
newOwnerId?: string;
|
|
1566
|
-
}
|
|
1567
|
-
/** Soft deletion of the meta site. Could be restored. */
|
|
1568
|
-
export interface SiteDeleted {
|
|
1569
|
-
/** A deletion context. */
|
|
1570
|
-
deleteContext?: DeleteContext;
|
|
1571
|
-
}
|
|
1572
|
-
export interface DeleteContext {
|
|
1573
|
-
/** When the meta site was deleted. */
|
|
1574
|
-
dateDeleted?: Date | null;
|
|
1575
|
-
/** A status. */
|
|
1576
|
-
deleteStatus?: DeleteStatusWithLiterals;
|
|
1577
|
-
/**
|
|
1578
|
-
* A reason (flow).
|
|
1579
|
-
* @maxLength 255
|
|
1580
|
-
*/
|
|
1581
|
-
deleteOrigin?: string;
|
|
1582
|
-
/**
|
|
1583
|
-
* A service that deleted it.
|
|
1584
|
-
* @maxLength 255
|
|
1585
|
-
*/
|
|
1586
|
-
initiatorId?: string | null;
|
|
1587
|
-
}
|
|
1588
|
-
export declare enum DeleteStatus {
|
|
1589
|
-
UNKNOWN = "UNKNOWN",
|
|
1590
|
-
TRASH = "TRASH",
|
|
1591
|
-
DELETED = "DELETED",
|
|
1592
|
-
PENDING_PURGE = "PENDING_PURGE",
|
|
1593
|
-
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
1594
|
-
}
|
|
1595
|
-
/** @enumType */
|
|
1596
|
-
export type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
1597
|
-
/** Restoration of the meta site. */
|
|
1598
|
-
export interface SiteUndeleted {
|
|
1599
|
-
}
|
|
1600
|
-
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
1601
|
-
export interface SitePublished {
|
|
1602
|
-
}
|
|
1603
|
-
export interface SiteUnpublished {
|
|
1604
|
-
/**
|
|
1605
|
-
* A list of URLs previously associated with the meta site.
|
|
1606
|
-
* @maxLength 4000
|
|
1607
|
-
* @maxSize 10000
|
|
1608
|
-
*/
|
|
1609
|
-
urls?: string[];
|
|
1610
|
-
}
|
|
1611
|
-
export interface SiteMarkedAsTemplate {
|
|
1612
|
-
}
|
|
1613
|
-
export interface SiteMarkedAsWixSite {
|
|
1614
|
-
}
|
|
1615
|
-
/**
|
|
1616
|
-
* Represents a service provisioned a site.
|
|
1617
|
-
*
|
|
1618
|
-
* Note on `origin_instance_id`:
|
|
1619
|
-
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
1620
|
-
* This is because of the following scenario:
|
|
1621
|
-
*
|
|
1622
|
-
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
1623
|
-
* such as a product catalog. When you create a site from this template, you inherit this
|
|
1624
|
-
* default product catalog. However, if the template's product catalog is modified,
|
|
1625
|
-
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
1626
|
-
* your site remains consistent with what you initially received and does not include any
|
|
1627
|
-
* changes made to the original template afterward.
|
|
1628
|
-
* To ensure this, the TPA on the template gets a new instance_id.
|
|
1629
|
-
*/
|
|
1630
|
-
export interface ServiceProvisioned {
|
|
1631
|
-
/**
|
|
1632
|
-
* Either UUID or EmbeddedServiceType.
|
|
1633
|
-
* @maxLength 36
|
|
1634
|
-
*/
|
|
1635
|
-
appDefId?: string;
|
|
1636
|
-
/**
|
|
1637
|
-
* Not only UUID. Something here could be something weird.
|
|
1638
|
-
* @maxLength 36
|
|
1639
|
-
*/
|
|
1640
|
-
instanceId?: string;
|
|
1641
|
-
/**
|
|
1642
|
-
* An instance id from which this instance is originated.
|
|
1643
|
-
* @maxLength 36
|
|
1644
|
-
*/
|
|
1645
|
-
originInstanceId?: string;
|
|
1646
|
-
/**
|
|
1647
|
-
* A version.
|
|
1648
|
-
* @maxLength 500
|
|
1649
|
-
*/
|
|
1650
|
-
version?: string | null;
|
|
1651
|
-
/**
|
|
1652
|
-
* The origin meta site id
|
|
1653
|
-
* @format GUID
|
|
1654
|
-
*/
|
|
1655
|
-
originMetaSiteId?: string | null;
|
|
1656
|
-
}
|
|
1657
|
-
export interface ServiceRemoved {
|
|
1658
|
-
/**
|
|
1659
|
-
* Either UUID or EmbeddedServiceType.
|
|
1660
|
-
* @maxLength 36
|
|
1661
|
-
*/
|
|
1662
|
-
appDefId?: string;
|
|
1663
|
-
/**
|
|
1664
|
-
* Not only UUID. Something here could be something weird.
|
|
1665
|
-
* @maxLength 36
|
|
1666
|
-
*/
|
|
1667
|
-
instanceId?: string;
|
|
1668
|
-
/**
|
|
1669
|
-
* A version.
|
|
1670
|
-
* @maxLength 500
|
|
1671
|
-
*/
|
|
1672
|
-
version?: string | null;
|
|
1673
|
-
}
|
|
1674
|
-
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
1675
|
-
export interface SiteRenamed {
|
|
1676
|
-
/**
|
|
1677
|
-
* A new meta site name (URL slug).
|
|
1678
|
-
* @maxLength 20
|
|
1679
|
-
*/
|
|
1680
|
-
newSiteName?: string;
|
|
1681
|
-
/**
|
|
1682
|
-
* A previous meta site name (URL slug).
|
|
1683
|
-
* @maxLength 255
|
|
1684
|
-
*/
|
|
1685
|
-
oldSiteName?: string;
|
|
1686
|
-
}
|
|
1687
|
-
/**
|
|
1688
|
-
* Hard deletion of the meta site.
|
|
1689
|
-
*
|
|
1690
|
-
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
1691
|
-
*/
|
|
1692
|
-
export interface SiteHardDeleted {
|
|
1693
|
-
/** A deletion context. */
|
|
1694
|
-
deleteContext?: DeleteContext;
|
|
1695
|
-
}
|
|
1696
|
-
export interface NamespaceChanged {
|
|
1697
|
-
/** A previous namespace. */
|
|
1698
|
-
oldNamespace?: NamespaceWithLiterals;
|
|
1699
|
-
/** A new namespace. */
|
|
1700
|
-
newNamespace?: NamespaceWithLiterals;
|
|
1701
|
-
}
|
|
1702
|
-
/** Assigned Studio editor */
|
|
1703
|
-
export interface StudioAssigned {
|
|
1704
|
-
}
|
|
1705
|
-
/** Unassigned Studio editor */
|
|
1706
|
-
export interface StudioUnassigned {
|
|
1707
|
-
}
|
|
1708
|
-
/**
|
|
1709
|
-
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
1710
|
-
*
|
|
1711
|
-
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
1712
|
-
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
1713
|
-
*
|
|
1714
|
-
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
1715
|
-
*/
|
|
1716
|
-
export interface SiteUrlChanged {
|
|
1717
|
-
}
|
|
1718
|
-
/**
|
|
1719
|
-
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
1720
|
-
* Consumed by other teams to remove relevant data.
|
|
1721
|
-
*/
|
|
1722
|
-
export interface SitePurgedExternally {
|
|
1723
|
-
/**
|
|
1724
|
-
* @maxLength 2048
|
|
1725
|
-
* @maxSize 100
|
|
1726
|
-
* @deprecated
|
|
1727
|
-
* @targetRemovalDate 2025-04-15
|
|
1728
|
-
*/
|
|
1729
|
-
appDefId?: string[];
|
|
1730
|
-
}
|
|
1731
|
-
/** Assigned Odeditor */
|
|
1732
|
-
export interface OdeditorAssigned {
|
|
1733
|
-
}
|
|
1734
|
-
/** Unassigned Odeditor */
|
|
1735
|
-
export interface OdeditorUnassigned {
|
|
1736
|
-
}
|
|
1737
|
-
/** Assigned Picasso editor */
|
|
1738
|
-
export interface PicassoAssigned {
|
|
1739
|
-
}
|
|
1740
|
-
/** Unassigned Picasso */
|
|
1741
|
-
export interface PicassoUnassigned {
|
|
1742
|
-
}
|
|
1743
|
-
export interface CreateDraftAutomationRequest {
|
|
1744
|
-
/** Draft automation to create. */
|
|
1745
|
-
automation?: Automation;
|
|
1746
|
-
}
|
|
1747
|
-
export interface CreateDraftAutomationResponse {
|
|
1748
|
-
/** Draft automation that was created. */
|
|
1749
|
-
automation?: Automation;
|
|
1750
|
-
}
|
|
1751
|
-
export interface GetOrCreateDraftAutomationRequest {
|
|
1752
|
-
/**
|
|
1753
|
-
* ID of the original automation on which the draft is based.
|
|
1754
|
-
* @format GUID
|
|
1755
|
-
*/
|
|
1756
|
-
originalAutomationId: string;
|
|
1757
|
-
}
|
|
1758
|
-
export interface GetOrCreateDraftAutomationResponse {
|
|
1759
|
-
/** Draft automation. */
|
|
1760
|
-
automation?: Automation;
|
|
1761
|
-
}
|
|
1762
|
-
export interface UpdateDraftAutomationRequest {
|
|
1763
|
-
/** Automation to update. Updates can be partial. */
|
|
1764
|
-
automation: Automation;
|
|
1765
|
-
}
|
|
1766
|
-
export interface UpdateDraftAutomationResponse {
|
|
1767
|
-
/** Updated draft automation. */
|
|
1768
|
-
automation?: Automation;
|
|
1769
|
-
}
|
|
1770
|
-
export interface QueryAutomationsWithDraftsRequest {
|
|
1771
|
-
/**
|
|
1772
|
-
* Query.
|
|
1773
|
-
*
|
|
1774
|
-
* Learn more about [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language).
|
|
1775
|
-
*/
|
|
1776
|
-
query?: CursorQuery;
|
|
1777
|
-
}
|
|
1778
|
-
export interface QueryAutomationsWithDraftsResponse {
|
|
1779
|
-
/** Retrieved automations. */
|
|
1780
|
-
automations?: Automation[];
|
|
1781
|
-
/** Paging metadata. */
|
|
1782
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
1783
|
-
/**
|
|
1784
|
-
* Map of existing automation IDs and their drafts' automation IDs.
|
|
1785
|
-
* When include_draft_data is set to `false`, the map is empty. The key is the automationId of the original automation, and the value a list of related draft automationIds.
|
|
1786
|
-
*/
|
|
1787
|
-
originalAutomationIdToDrafts?: Record<string, DraftsInfo>;
|
|
1788
|
-
}
|
|
1789
|
-
export interface DraftsInfo {
|
|
1790
|
-
/**
|
|
1791
|
-
* IDs of the draft automations.
|
|
1792
|
-
* @maxSize 1
|
|
1793
|
-
* @format GUID
|
|
1794
|
-
*/
|
|
1795
|
-
draftAutomationIds?: string[];
|
|
1796
|
-
}
|
|
1797
|
-
export interface DeleteDraftAutomationRequest {
|
|
1798
|
-
/**
|
|
1799
|
-
* ID of the draft automation to delete.
|
|
1800
|
-
* @format GUID
|
|
1801
|
-
*/
|
|
1802
|
-
automationId: string;
|
|
1803
|
-
}
|
|
1804
|
-
export interface DeleteDraftAutomationResponse {
|
|
1805
|
-
}
|
|
1806
|
-
export interface PublishDraftAutomationRequest {
|
|
1807
|
-
/**
|
|
1808
|
-
* ID of the draft automation to publish.
|
|
1809
|
-
* @format GUID
|
|
1810
|
-
*/
|
|
1811
|
-
automationId: string;
|
|
1812
|
-
}
|
|
1813
|
-
export interface PublishDraftAutomationResponse {
|
|
1814
|
-
/** Updated published automation. */
|
|
1815
|
-
automation?: Automation;
|
|
1816
|
-
}
|
|
1817
|
-
export interface ValidateAutomationRequest {
|
|
1818
|
-
/** Automation to validate. */
|
|
1819
|
-
automation: Automation;
|
|
1820
|
-
/** Automation validation settings. */
|
|
1821
|
-
validationSettings?: ValidationSettings;
|
|
1822
|
-
}
|
|
1823
|
-
export interface ValidationSettings {
|
|
1824
|
-
/**
|
|
1825
|
-
* IDs of actions to validate. Only actions whose IDs are specified are validated.
|
|
1826
|
-
*
|
|
1827
|
-
* When action IDs are specified, triggers are not validated. When empty, the full automation is validated, including triggers.
|
|
1828
|
-
* @maxSize 30
|
|
1829
|
-
* @format GUID
|
|
1830
|
-
*/
|
|
1831
|
-
actionIds?: string[];
|
|
1832
|
-
/**
|
|
1833
|
-
* Whether to skip provider validations.
|
|
1834
|
-
*
|
|
1835
|
-
* Default: `false`.
|
|
1836
|
-
*/
|
|
1837
|
-
skipProviderValidations?: boolean;
|
|
1838
|
-
}
|
|
1839
|
-
export interface ValidateAutomationResponse {
|
|
1840
|
-
/** Whether the automation is valid. */
|
|
1841
|
-
valid?: boolean;
|
|
1842
|
-
/**
|
|
1843
|
-
* Validation errors generated by the automation trigger.
|
|
1844
|
-
* @maxSize 100
|
|
1845
|
-
*/
|
|
1846
|
-
triggerValidationErrors?: TriggerValidationError[];
|
|
1847
|
-
/**
|
|
1848
|
-
* Validation information generated by the automation actions.
|
|
1849
|
-
* @maxSize 100
|
|
1850
|
-
*/
|
|
1851
|
-
actionValidationInfo?: ActionValidationInfo[];
|
|
1852
|
-
/**
|
|
1853
|
-
* Additional validation errors generated by the automation.
|
|
1854
|
-
* @maxSize 100
|
|
1855
|
-
*/
|
|
1856
|
-
automationValidationErrors?: AutomationValidationError[];
|
|
1857
|
-
}
|
|
1858
|
-
export interface TriggerValidationError extends TriggerValidationErrorErrorOneOf {
|
|
1859
|
-
/** Trigger configuration error. */
|
|
1860
|
-
configurationError?: TriggerConfigurationError;
|
|
1861
|
-
/** Provider configuration error. */
|
|
1862
|
-
providerConfigurationError?: ProviderConfigurationError;
|
|
1863
|
-
/** Validation error type. */
|
|
1864
|
-
errorType?: TriggerValidationErrorValidationErrorTypeWithLiterals;
|
|
1865
|
-
/** Validation error severity */
|
|
1866
|
-
severity?: ValidationErrorSeverityWithLiterals;
|
|
1867
|
-
}
|
|
1868
|
-
/** @oneof */
|
|
1869
|
-
export interface TriggerValidationErrorErrorOneOf {
|
|
1870
|
-
/** Trigger configuration error. */
|
|
1871
|
-
configurationError?: TriggerConfigurationError;
|
|
1872
|
-
/** Provider configuration error. */
|
|
1873
|
-
providerConfigurationError?: ProviderConfigurationError;
|
|
1874
|
-
}
|
|
1875
|
-
export declare enum TriggerValidationErrorValidationErrorType {
|
|
1876
|
-
UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
|
|
1877
|
-
/** Configuration error. */
|
|
1878
|
-
CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
|
|
1879
|
-
/** Provider error. */
|
|
1880
|
-
PROVIDER_ERROR = "PROVIDER_ERROR"
|
|
1881
|
-
}
|
|
1882
|
-
/** @enumType */
|
|
1883
|
-
export type TriggerValidationErrorValidationErrorTypeWithLiterals = TriggerValidationErrorValidationErrorType | 'UNKNOWN_VALIDATION_ERROR_TYPE' | 'CONFIGURATION_ERROR' | 'PROVIDER_ERROR';
|
|
1884
|
-
export interface TriggerConfigurationError {
|
|
1885
|
-
/** Trigger error type. */
|
|
1886
|
-
errorType?: TriggerErrorTypeWithLiterals;
|
|
1887
|
-
/**
|
|
1888
|
-
* Related filter field key.
|
|
1889
|
-
* @maxLength 110
|
|
1890
|
-
*/
|
|
1891
|
-
filterFieldKey?: string | null;
|
|
1892
|
-
}
|
|
1893
|
-
export declare enum TriggerErrorType {
|
|
1894
|
-
UNKNOWN_TRIGGER_ERROR_TYPE = "UNKNOWN_TRIGGER_ERROR_TYPE",
|
|
1895
|
-
/** Trigger not found. */
|
|
1896
|
-
NOT_FOUND = "NOT_FOUND",
|
|
1897
|
-
/** App not installed. */
|
|
1898
|
-
APP_NOT_INSTALLED = "APP_NOT_INSTALLED",
|
|
1899
|
-
/** Moderation mismatch. */
|
|
1900
|
-
MODERATION_MISMATCH = "MODERATION_MISMATCH",
|
|
1901
|
-
/** Deprecated. */
|
|
1902
|
-
DEPRECATED = "DEPRECATED",
|
|
1903
|
-
/** Invalid trigger key. */
|
|
1904
|
-
INVALID_TRIGGER_KEY = "INVALID_TRIGGER_KEY",
|
|
1905
|
-
/** Invalid filter field key. */
|
|
1906
|
-
INVALID_FILTER_FIELD_KEY = "INVALID_FILTER_FIELD_KEY",
|
|
1907
|
-
/** Invalid filter expression. */
|
|
1908
|
-
INVALID_FILTER_EXPRESSION = "INVALID_FILTER_EXPRESSION"
|
|
1909
|
-
}
|
|
1910
|
-
/** @enumType */
|
|
1911
|
-
export 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';
|
|
1912
|
-
export interface ProviderConfigurationError {
|
|
1913
|
-
/** Key corresponding to the field in the schema. */
|
|
1914
|
-
fieldKey?: string | null;
|
|
1915
|
-
/** Error message. */
|
|
1916
|
-
message?: string;
|
|
1917
|
-
/** Label for a call-to-action button that's displayed with the error. Translated according to the SPI language context. */
|
|
1918
|
-
ctaLabel?: string | null;
|
|
1919
|
-
/** URL to redirect to when the call-to-action button is clicked. */
|
|
1920
|
-
ctaUrl?: string | null;
|
|
1921
|
-
/** Title for the error. */
|
|
1922
|
-
title?: string;
|
|
1923
|
-
}
|
|
1924
|
-
export declare enum ValidationErrorSeverity {
|
|
1925
|
-
UNKNOWN_VALIDATION_ERROR_SEVERITY = "UNKNOWN_VALIDATION_ERROR_SEVERITY",
|
|
1926
|
-
/** Warning. */
|
|
1927
|
-
WARNING = "WARNING",
|
|
1928
|
-
/** Error. */
|
|
1929
|
-
ERROR = "ERROR"
|
|
1930
|
-
}
|
|
1931
|
-
/** @enumType */
|
|
1932
|
-
export type ValidationErrorSeverityWithLiterals = ValidationErrorSeverity | 'UNKNOWN_VALIDATION_ERROR_SEVERITY' | 'WARNING' | 'ERROR';
|
|
1933
|
-
export interface ActionValidationInfo {
|
|
1934
|
-
/**
|
|
1935
|
-
* Action ID.
|
|
1936
|
-
* @format GUID
|
|
1937
|
-
*/
|
|
1938
|
-
actionId?: string | null;
|
|
1939
|
-
/**
|
|
1940
|
-
* ID of the app that defined the action.
|
|
1941
|
-
* @format GUID
|
|
1942
|
-
*/
|
|
1943
|
-
appId?: string;
|
|
1944
|
-
/**
|
|
1945
|
-
* Human-readable action identifier.
|
|
1946
|
-
* @minLength 1
|
|
1947
|
-
* @maxLength 100
|
|
1948
|
-
*/
|
|
1949
|
-
actionKey?: string;
|
|
1950
|
-
/**
|
|
1951
|
-
* Action validation errors.
|
|
1952
|
-
* @maxSize 100
|
|
1953
|
-
*/
|
|
1954
|
-
validationErrors?: ActionValidationError[];
|
|
1955
|
-
}
|
|
1956
|
-
export interface ActionValidationError extends ActionValidationErrorErrorOneOf {
|
|
1957
|
-
/** Action configuration error. */
|
|
1958
|
-
configurationError?: ActionConfigurationError;
|
|
1959
|
-
/** Provider configuration error. */
|
|
1960
|
-
providerConfigurationError?: ProviderConfigurationError;
|
|
1961
|
-
/** Validation error type. */
|
|
1962
|
-
errorType?: ValidationErrorTypeWithLiterals;
|
|
1963
|
-
/** Validation error severity */
|
|
1964
|
-
severity?: ValidationErrorSeverityWithLiterals;
|
|
1965
|
-
}
|
|
1966
|
-
/** @oneof */
|
|
1967
|
-
export interface ActionValidationErrorErrorOneOf {
|
|
1968
|
-
/** Action configuration error. */
|
|
1969
|
-
configurationError?: ActionConfigurationError;
|
|
1970
|
-
/** Provider configuration error. */
|
|
1971
|
-
providerConfigurationError?: ProviderConfigurationError;
|
|
1972
|
-
}
|
|
1973
|
-
export declare enum ValidationErrorType {
|
|
1974
|
-
UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
|
|
1975
|
-
/** Configuration error. */
|
|
1976
|
-
CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
|
|
1977
|
-
/** Provider error. */
|
|
1978
|
-
PROVIDER_ERROR = "PROVIDER_ERROR"
|
|
1979
|
-
}
|
|
1980
|
-
/** @enumType */
|
|
1981
|
-
export type ValidationErrorTypeWithLiterals = ValidationErrorType | 'UNKNOWN_VALIDATION_ERROR_TYPE' | 'CONFIGURATION_ERROR' | 'PROVIDER_ERROR';
|
|
1982
|
-
export interface ActionConfigurationError {
|
|
1983
|
-
/** Action error type. */
|
|
1984
|
-
errorType?: ActionErrorTypeWithLiterals;
|
|
1985
|
-
/**
|
|
1986
|
-
* Related field key.
|
|
1987
|
-
* @maxLength 110
|
|
1988
|
-
*/
|
|
1989
|
-
fieldKey?: string | null;
|
|
1990
|
-
}
|
|
1991
|
-
export declare enum ActionErrorType {
|
|
1992
|
-
UNKNOWN_ACTION_ERROR_TYPE = "UNKNOWN_ACTION_ERROR_TYPE",
|
|
1993
|
-
NOT_FOUND = "NOT_FOUND",
|
|
1994
|
-
APP_NOT_INSTALLED = "APP_NOT_INSTALLED",
|
|
1995
|
-
MODERATION_MISMATCH = "MODERATION_MISMATCH",
|
|
1996
|
-
DEPRECATED = "DEPRECATED",
|
|
1997
|
-
INVALID_ACTION_KEY = "INVALID_ACTION_KEY",
|
|
1998
|
-
INVALID_MAPPING = "INVALID_MAPPING",
|
|
1999
|
-
MAPPING_TYPE_MISMATCH = "MAPPING_TYPE_MISMATCH",
|
|
2000
|
-
MAPPING_MISSING_REQUIRED_FIELD = "MAPPING_MISSING_REQUIRED_FIELD",
|
|
2001
|
-
MAPPING_SCHEMA_MISMATCH = "MAPPING_SCHEMA_MISMATCH",
|
|
2002
|
-
MAPPING_VARIABLE_MISSING_FROM_SCHEMA = "MAPPING_VARIABLE_MISSING_FROM_SCHEMA"
|
|
2003
|
-
}
|
|
2004
|
-
/** @enumType */
|
|
2005
|
-
export 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';
|
|
2006
|
-
export interface AutomationValidationError extends AutomationValidationErrorErrorOneOf {
|
|
2007
|
-
/** Automation configuration error. */
|
|
2008
|
-
configurationError?: AutomationConfigurationError;
|
|
2009
|
-
/** Provider configuration error. */
|
|
2010
|
-
providerConfigurationError?: ProviderConfigurationError;
|
|
2011
|
-
/** Validation error type. */
|
|
2012
|
-
errorType?: AutomationValidationErrorValidationErrorTypeWithLiterals;
|
|
2013
|
-
/** Validation error severity. */
|
|
2014
|
-
severity?: ValidationErrorSeverityWithLiterals;
|
|
2015
|
-
}
|
|
2016
|
-
/** @oneof */
|
|
2017
|
-
export interface AutomationValidationErrorErrorOneOf {
|
|
2018
|
-
/** Automation configuration error. */
|
|
2019
|
-
configurationError?: AutomationConfigurationError;
|
|
2020
|
-
/** Provider configuration error. */
|
|
2021
|
-
providerConfigurationError?: ProviderConfigurationError;
|
|
2022
|
-
}
|
|
2023
|
-
export declare enum AutomationValidationErrorValidationErrorType {
|
|
2024
|
-
UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
|
|
2025
|
-
CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
|
|
2026
|
-
PROVIDER_ERROR = "PROVIDER_ERROR"
|
|
2027
|
-
}
|
|
2028
|
-
/** @enumType */
|
|
2029
|
-
export type AutomationValidationErrorValidationErrorTypeWithLiterals = AutomationValidationErrorValidationErrorType | 'UNKNOWN_VALIDATION_ERROR_TYPE' | 'CONFIGURATION_ERROR' | 'PROVIDER_ERROR';
|
|
2030
|
-
export interface AutomationConfigurationError {
|
|
2031
|
-
/** Automation error type. */
|
|
2032
|
-
errorType?: AutomationErrorTypeWithLiterals;
|
|
2033
|
-
}
|
|
2034
|
-
export declare enum AutomationErrorType {
|
|
2035
|
-
UNKNOWN_AUTOMATION_ERROR_TYPE = "UNKNOWN_AUTOMATION_ERROR_TYPE"
|
|
2036
|
-
}
|
|
2037
|
-
/** @enumType */
|
|
2038
|
-
export type AutomationErrorTypeWithLiterals = AutomationErrorType | 'UNKNOWN_AUTOMATION_ERROR_TYPE';
|
|
2039
|
-
export interface ValidateAutomationByIdRequest {
|
|
2040
|
-
/**
|
|
2041
|
-
* Automation ID.
|
|
2042
|
-
* @format GUID
|
|
2043
|
-
*/
|
|
2044
|
-
automationId: string;
|
|
2045
|
-
/** Validation settings. */
|
|
2046
|
-
validationSettings?: ValidationSettings;
|
|
2047
|
-
}
|
|
2048
|
-
export interface ValidateAutomationByIdResponse {
|
|
2049
|
-
/** Whether the automation is valid. */
|
|
2050
|
-
valid?: boolean;
|
|
2051
|
-
/**
|
|
2052
|
-
* Validation errors generated by the automation trigger.
|
|
2053
|
-
* @maxSize 100
|
|
2054
|
-
*/
|
|
2055
|
-
triggerValidationErrors?: TriggerValidationError[];
|
|
2056
|
-
/**
|
|
2057
|
-
* Validation information generated by the automation actions.
|
|
2058
|
-
* @maxSize 100
|
|
2059
|
-
*/
|
|
2060
|
-
actionValidationInfo?: ActionValidationInfo[];
|
|
2061
|
-
/**
|
|
2062
|
-
* Additional validation errors generated by the automation.
|
|
2063
|
-
* @maxSize 100
|
|
2064
|
-
*/
|
|
2065
|
-
automationValidationErrors?: AutomationValidationError[];
|
|
2066
|
-
}
|
|
2067
|
-
export interface GetAutomationActionSchemaRequest {
|
|
2068
|
-
/**
|
|
2069
|
-
* Automation ID.
|
|
2070
|
-
* @format GUID
|
|
2071
|
-
*/
|
|
2072
|
-
automationId?: string;
|
|
2073
|
-
/**
|
|
2074
|
-
* Action ID.
|
|
2075
|
-
* @format GUID
|
|
2076
|
-
*/
|
|
2077
|
-
actionId?: string;
|
|
2078
|
-
}
|
|
2079
|
-
export interface GetAutomationActionSchemaResponse {
|
|
2080
|
-
/** The accumulated payload schema for an action. */
|
|
2081
|
-
schema?: Record<string, any> | null;
|
|
2082
|
-
}
|
|
2083
|
-
export interface GetActionsQuotaInfoRequest {
|
|
2084
|
-
}
|
|
2085
|
-
export interface GetActionsQuotaInfoResponse {
|
|
2086
|
-
/** Action quotas. */
|
|
2087
|
-
actionProviderQuotaInfo?: ActionProviderQuotaInfo[];
|
|
2088
|
-
}
|
|
2089
|
-
export interface ActionProviderQuotaInfo {
|
|
2090
|
-
/**
|
|
2091
|
-
* ID of the app that defined the action.
|
|
2092
|
-
* @format GUID
|
|
2093
|
-
*/
|
|
2094
|
-
appId?: string;
|
|
2095
|
-
/**
|
|
2096
|
-
* Action key.
|
|
2097
|
-
* @minLength 1
|
|
2098
|
-
* @maxLength 80
|
|
2099
|
-
*/
|
|
2100
|
-
actionKey?: string;
|
|
2101
|
-
/** Action quota information. */
|
|
2102
|
-
actionQuotaInfo?: ActionQuotaInfo;
|
|
2103
|
-
}
|
|
2104
|
-
export interface ActionQuotaInfo {
|
|
2105
|
-
/**
|
|
2106
|
-
* Whether the quotas for your action are enforced. If you mark this as `true` in the response body,
|
|
2107
|
-
* Wix displays the information in the quota object on the site dashboard. If you mark this as `false` for
|
|
2108
|
-
* a user, Wix does not display any quota info on the site dashboard for your service.
|
|
2109
|
-
*/
|
|
2110
|
-
enforced?: boolean;
|
|
2111
|
-
/**
|
|
2112
|
-
* The plans your service provides, together with the quotas enforced by each plan. A site may be enrolled
|
|
2113
|
-
* in multiple plans. Plans and quotas can be related as follows:
|
|
2114
|
-
*
|
|
2115
|
-
* + A single plan has a single quota.
|
|
2116
|
-
* + A single plan has multiple quotas.
|
|
2117
|
-
* + Multiple plans are associated with multiple quotas.
|
|
2118
|
-
*
|
|
2119
|
-
* Plans and quotas that are related should be grouped together in a single `quotaInfo`
|
|
2120
|
-
* object.
|
|
2121
|
-
*/
|
|
2122
|
-
quotaInfo?: QuotaInfo[];
|
|
2123
|
-
}
|
|
2124
|
-
export interface QuotaInfo {
|
|
2125
|
-
/** List of plans associated with the site making the request. */
|
|
2126
|
-
plans?: Plan[];
|
|
2127
|
-
/**
|
|
2128
|
-
* List of quotas associated with the plans the site is enrolled in.
|
|
2129
|
-
* @minSize 1
|
|
2130
|
-
*/
|
|
2131
|
-
quotas?: Quota[];
|
|
2132
|
-
/**
|
|
2133
|
-
* Details for an upgrade call-to-action button.
|
|
2134
|
-
* Displayed in the Wix user’s site dashboard together with the quota details.
|
|
2135
|
-
*/
|
|
2136
|
-
upgradeCta?: UpgradeCTA;
|
|
2137
|
-
}
|
|
2138
|
-
export interface Plan {
|
|
2139
|
-
/** Plan ID defined by the action provider. */
|
|
2140
|
-
id?: string;
|
|
2141
|
-
/** Plan name to display in the Wix user’s site dashboard. */
|
|
2142
|
-
name?: string;
|
|
2143
|
-
}
|
|
2144
|
-
export interface Quota {
|
|
2145
|
-
/**
|
|
2146
|
-
* Name of the feature the quota is related to. For example, "Messages sent".
|
|
2147
|
-
* @minLength 1
|
|
2148
|
-
*/
|
|
2149
|
-
featureName?: string;
|
|
2150
|
-
/**
|
|
2151
|
-
* Quota renewal date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
2152
|
-
* For example, 10 July 2020 at 15:00 is written as `2020-07-10 15:00:00.000`.
|
|
2153
|
-
*/
|
|
2154
|
-
renewalDate?: Date | null;
|
|
2155
|
-
/** The user's current quota usage. */
|
|
2156
|
-
currentUsage?: string;
|
|
2157
|
-
/** Quota limit data. */
|
|
2158
|
-
limit?: string | null;
|
|
2159
|
-
/** Additional information about the quota. Displayed as a tooltip in the Wix user’s dashboard. */
|
|
2160
|
-
additionalInfo?: AdditionalInfo;
|
|
2161
|
-
}
|
|
2162
|
-
export interface CTA {
|
|
2163
|
-
/**
|
|
2164
|
-
* Call-to-action redirect URL.
|
|
2165
|
-
* @minLength 1
|
|
2166
|
-
*/
|
|
2167
|
-
url?: string;
|
|
2168
|
-
/**
|
|
2169
|
-
* Call-to-action label.
|
|
2170
|
-
* @minLength 1
|
|
2171
|
-
*/
|
|
2172
|
-
label?: string;
|
|
2173
|
-
}
|
|
2174
|
-
export interface AdditionalInfo {
|
|
2175
|
-
/**
|
|
2176
|
-
* Tooltip content.
|
|
2177
|
-
* @minLength 1
|
|
2178
|
-
*/
|
|
2179
|
-
description?: string;
|
|
2180
|
-
/** Details for an options call-to-action link that appears in the tooltip. */
|
|
2181
|
-
cta?: CTA;
|
|
2182
|
-
}
|
|
2183
|
-
export interface UpgradeCTA {
|
|
2184
|
-
/**
|
|
2185
|
-
* CTA button redirect URL.
|
|
2186
|
-
* @minLength 1
|
|
2187
|
-
*/
|
|
2188
|
-
url?: string;
|
|
2189
|
-
/**
|
|
2190
|
-
* CTA button label.
|
|
2191
|
-
* @minLength 1
|
|
2192
|
-
*/
|
|
2193
|
-
label?: string;
|
|
2194
|
-
}
|
|
2195
|
-
export interface MigrateVeloActionAutomationsRequest {
|
|
2196
|
-
/** @format GUID */
|
|
2197
|
-
oldAppId?: string;
|
|
2198
|
-
/** @format GUID */
|
|
2199
|
-
newAppId?: string;
|
|
2200
|
-
/** @format GUID */
|
|
2201
|
-
newComponentId?: string;
|
|
2202
|
-
}
|
|
2203
|
-
export interface MigrateVeloActionAutomationsResponse {
|
|
2204
|
-
}
|
|
2205
|
-
export interface GetAutomationRevisionRequest {
|
|
2206
|
-
/**
|
|
2207
|
-
* Automation ID.
|
|
2208
|
-
* @format GUID
|
|
2209
|
-
*/
|
|
2210
|
-
automationId: string;
|
|
2211
|
-
/** Revision number. */
|
|
2212
|
-
revision?: string | null;
|
|
2213
|
-
/**
|
|
2214
|
-
* Requested fields.
|
|
2215
|
-
* @maxSize 20
|
|
2216
|
-
*/
|
|
2217
|
-
fields?: RequestedFieldsWithLiterals[];
|
|
2218
|
-
}
|
|
2219
|
-
export interface GetAutomationRevisionResponse {
|
|
2220
|
-
/** Automation revision. */
|
|
2221
|
-
automation?: Automation;
|
|
2222
|
-
}
|