@wix/auto_sdk_companion-apps_companion-apps 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +27 -0
- package/build/cjs/index.js +284 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +869 -0
- package/build/cjs/index.typings.js +265 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +865 -0
- package/build/cjs/meta.js +253 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/schemas.d.ts +30 -0
- package/build/cjs/schemas.js +77 -0
- package/build/cjs/schemas.js.map +1 -0
- package/build/es/index.d.mts +27 -0
- package/build/es/index.mjs +253 -0
- package/build/es/index.mjs.map +1 -0
- package/build/es/index.typings.d.mts +869 -0
- package/build/es/index.typings.mjs +234 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/es/meta.d.mts +865 -0
- package/build/es/meta.mjs +219 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/schemas.d.mts +30 -0
- package/build/es/schemas.mjs +37 -0
- package/build/es/schemas.mjs.map +1 -0
- package/build/internal/cjs/index.d.ts +27 -0
- package/build/internal/cjs/index.js +284 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +888 -0
- package/build/internal/cjs/index.typings.js +265 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +926 -0
- package/build/internal/cjs/meta.js +253 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/schemas.d.ts +30 -0
- package/build/internal/cjs/schemas.js +77 -0
- package/build/internal/cjs/schemas.js.map +1 -0
- package/build/internal/es/index.d.mts +27 -0
- package/build/internal/es/index.mjs +253 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/internal/es/index.typings.d.mts +888 -0
- package/build/internal/es/index.typings.mjs +234 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +926 -0
- package/build/internal/es/meta.mjs +219 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/build/internal/es/schemas.d.mts +30 -0
- package/build/internal/es/schemas.mjs +37 -0
- package/build/internal/es/schemas.mjs.map +1 -0
- package/meta/package.json +3 -0
- package/package.json +61 -0
- package/schemas/package.json +3 -0
|
@@ -0,0 +1,869 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* A companion app is a site-tenanted app, coupled to one Wix site only, that lets the site use
|
|
5
|
+
* app-provided features to customize itself.
|
|
6
|
+
*/
|
|
7
|
+
interface CompanionApp {
|
|
8
|
+
/**
|
|
9
|
+
* Companion app ID.
|
|
10
|
+
* @format GUID
|
|
11
|
+
* @readonly
|
|
12
|
+
*/
|
|
13
|
+
_id?: string;
|
|
14
|
+
/**
|
|
15
|
+
* Status of the companion app. `READY` means the companion app can be used,
|
|
16
|
+
* `CLONING` means site duplication is still in progress, and
|
|
17
|
+
* `CLONE_FAILED` means the duplication process didn't complete successfully.
|
|
18
|
+
*/
|
|
19
|
+
status?: CompanionAppStatusWithLiterals;
|
|
20
|
+
/**
|
|
21
|
+
* Date and time the companion app was created.
|
|
22
|
+
* @readonly
|
|
23
|
+
*/
|
|
24
|
+
_createdDate?: Date | null;
|
|
25
|
+
/**
|
|
26
|
+
* Date and time the companion app was last updated.
|
|
27
|
+
* @readonly
|
|
28
|
+
*/
|
|
29
|
+
_updatedDate?: Date | null;
|
|
30
|
+
}
|
|
31
|
+
declare enum CompanionAppStatus {
|
|
32
|
+
/** The companion app is being prepared during site duplication and may not be ready to use. */
|
|
33
|
+
CLONING = "CLONING",
|
|
34
|
+
/** The companion app is ready to use on the current site. */
|
|
35
|
+
READY = "READY",
|
|
36
|
+
/** The companion app couldn't be prepared during site duplication. Retry duplication later or show the failure to the user. */
|
|
37
|
+
CLONE_FAILED = "CLONE_FAILED"
|
|
38
|
+
}
|
|
39
|
+
/** @enumType */
|
|
40
|
+
type CompanionAppStatusWithLiterals = CompanionAppStatus | 'CLONING' | 'READY' | 'CLONE_FAILED';
|
|
41
|
+
interface ComponentsMetadata {
|
|
42
|
+
}
|
|
43
|
+
interface CompanionAppCloneStarted {
|
|
44
|
+
/** The companion app entity being cloned. */
|
|
45
|
+
companionApp?: CompanionApp;
|
|
46
|
+
/**
|
|
47
|
+
* The ID of the origin companion app being cloned.
|
|
48
|
+
* @format GUID
|
|
49
|
+
*/
|
|
50
|
+
originAppId?: string;
|
|
51
|
+
/**
|
|
52
|
+
* The target Wix site ID to which the companion app is being cloned.
|
|
53
|
+
* @format GUID
|
|
54
|
+
*/
|
|
55
|
+
targetMetaSiteId?: string;
|
|
56
|
+
/**
|
|
57
|
+
* Account ID of the initiator, captured at publish time so consumers don't
|
|
58
|
+
* need to read it off the call session (which won't carry a Person identity
|
|
59
|
+
* when the clone is triggered service-to-service, e.g. from meta-site-manager).
|
|
60
|
+
* @format GUID
|
|
61
|
+
*/
|
|
62
|
+
targetAccountId?: string;
|
|
63
|
+
/**
|
|
64
|
+
* When true (async path), the consumer registers the cloned app in legacy (REGISTER_ONLY, no version;
|
|
65
|
+
* components and the version come later on clone-completed). When false, the publisher already registered
|
|
66
|
+
* it inline (sync) or no registration is needed (off).
|
|
67
|
+
*/
|
|
68
|
+
registerInConsumer?: boolean;
|
|
69
|
+
}
|
|
70
|
+
interface CompanionAppCloneCompleted {
|
|
71
|
+
/** The companion app entity that has been cloned. */
|
|
72
|
+
companionApp?: CompanionApp;
|
|
73
|
+
/**
|
|
74
|
+
* The ID of the origin companion app that was cloned.
|
|
75
|
+
* @format GUID
|
|
76
|
+
*/
|
|
77
|
+
originAppId?: string;
|
|
78
|
+
/**
|
|
79
|
+
* The target Wix site ID to which the companion app was cloned.
|
|
80
|
+
* @format GUID
|
|
81
|
+
*/
|
|
82
|
+
targetMetaSiteId?: string;
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* Emitted by GetOrCreateCompanionApp (async registration path) so the companion app registration and first
|
|
86
|
+
* (empty) production version release happens off the request path, in the ConsumeCompanionAppsEvent consumer,
|
|
87
|
+
* instead of inline. The event's sole purpose is register + create-empty-version, so it needs no mode field.
|
|
88
|
+
*/
|
|
89
|
+
interface CompanionAppRegistrationRequested {
|
|
90
|
+
/**
|
|
91
|
+
* Companion backing app ID to register and release.
|
|
92
|
+
* @format GUID
|
|
93
|
+
*/
|
|
94
|
+
appId?: string;
|
|
95
|
+
/**
|
|
96
|
+
* Account ID of the initiator, captured at publish time so the consumer can register
|
|
97
|
+
* in legacy without relying on the call session (which won't carry a Person identity
|
|
98
|
+
* when get-or-create is triggered service-to-service during site provisioning).
|
|
99
|
+
* @format GUID
|
|
100
|
+
*/
|
|
101
|
+
targetAccountId?: string;
|
|
102
|
+
}
|
|
103
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
104
|
+
createdEvent?: EntityCreatedEvent;
|
|
105
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
106
|
+
deletedEvent?: EntityDeletedEvent;
|
|
107
|
+
actionEvent?: ActionEvent;
|
|
108
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
109
|
+
_id?: string;
|
|
110
|
+
/**
|
|
111
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
112
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
113
|
+
*/
|
|
114
|
+
entityFqdn?: string;
|
|
115
|
+
/**
|
|
116
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
117
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
118
|
+
*/
|
|
119
|
+
slug?: string;
|
|
120
|
+
/** ID of the entity associated with the event. */
|
|
121
|
+
entityId?: string;
|
|
122
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
123
|
+
eventTime?: Date | null;
|
|
124
|
+
/**
|
|
125
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
126
|
+
* (for example, GDPR).
|
|
127
|
+
*/
|
|
128
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
129
|
+
/** If present, indicates the action that triggered the event. */
|
|
130
|
+
originatedFrom?: string | null;
|
|
131
|
+
/**
|
|
132
|
+
* 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.
|
|
133
|
+
* 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.
|
|
134
|
+
*/
|
|
135
|
+
entityEventSequence?: string | null;
|
|
136
|
+
}
|
|
137
|
+
/** @oneof */
|
|
138
|
+
interface DomainEventBodyOneOf {
|
|
139
|
+
createdEvent?: EntityCreatedEvent;
|
|
140
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
141
|
+
deletedEvent?: EntityDeletedEvent;
|
|
142
|
+
actionEvent?: ActionEvent;
|
|
143
|
+
}
|
|
144
|
+
interface EntityCreatedEvent {
|
|
145
|
+
entity?: string;
|
|
146
|
+
}
|
|
147
|
+
interface RestoreInfo {
|
|
148
|
+
deletedDate?: Date | null;
|
|
149
|
+
}
|
|
150
|
+
interface EntityUpdatedEvent {
|
|
151
|
+
/**
|
|
152
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
153
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
154
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
155
|
+
*/
|
|
156
|
+
currentEntity?: string;
|
|
157
|
+
}
|
|
158
|
+
interface EntityDeletedEvent {
|
|
159
|
+
/** Entity that was deleted. */
|
|
160
|
+
deletedEntity?: string | null;
|
|
161
|
+
}
|
|
162
|
+
interface ActionEvent {
|
|
163
|
+
body?: string;
|
|
164
|
+
}
|
|
165
|
+
interface MessageEnvelope {
|
|
166
|
+
/**
|
|
167
|
+
* App instance ID.
|
|
168
|
+
* @format GUID
|
|
169
|
+
*/
|
|
170
|
+
instanceId?: string | null;
|
|
171
|
+
/**
|
|
172
|
+
* Event type.
|
|
173
|
+
* @maxLength 150
|
|
174
|
+
*/
|
|
175
|
+
eventType?: string;
|
|
176
|
+
/** The identification type and identity data. */
|
|
177
|
+
identity?: IdentificationData;
|
|
178
|
+
/** Stringify payload. */
|
|
179
|
+
data?: string;
|
|
180
|
+
/** Details related to the account */
|
|
181
|
+
accountInfo?: AccountInfo;
|
|
182
|
+
}
|
|
183
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
184
|
+
/**
|
|
185
|
+
* ID of a site visitor that has not logged in to the site.
|
|
186
|
+
* @format GUID
|
|
187
|
+
*/
|
|
188
|
+
anonymousVisitorId?: string;
|
|
189
|
+
/**
|
|
190
|
+
* ID of a site visitor that has logged in to the site.
|
|
191
|
+
* @format GUID
|
|
192
|
+
*/
|
|
193
|
+
memberId?: string;
|
|
194
|
+
/**
|
|
195
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
196
|
+
* @format GUID
|
|
197
|
+
*/
|
|
198
|
+
wixUserId?: string;
|
|
199
|
+
/**
|
|
200
|
+
* ID of an app.
|
|
201
|
+
* @format GUID
|
|
202
|
+
*/
|
|
203
|
+
appId?: string;
|
|
204
|
+
/** @readonly */
|
|
205
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
206
|
+
}
|
|
207
|
+
/** @oneof */
|
|
208
|
+
interface IdentificationDataIdOneOf {
|
|
209
|
+
/**
|
|
210
|
+
* ID of a site visitor that has not logged in to the site.
|
|
211
|
+
* @format GUID
|
|
212
|
+
*/
|
|
213
|
+
anonymousVisitorId?: string;
|
|
214
|
+
/**
|
|
215
|
+
* ID of a site visitor that has logged in to the site.
|
|
216
|
+
* @format GUID
|
|
217
|
+
*/
|
|
218
|
+
memberId?: string;
|
|
219
|
+
/**
|
|
220
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
221
|
+
* @format GUID
|
|
222
|
+
*/
|
|
223
|
+
wixUserId?: string;
|
|
224
|
+
/**
|
|
225
|
+
* ID of an app.
|
|
226
|
+
* @format GUID
|
|
227
|
+
*/
|
|
228
|
+
appId?: string;
|
|
229
|
+
}
|
|
230
|
+
declare enum WebhookIdentityType {
|
|
231
|
+
UNKNOWN = "UNKNOWN",
|
|
232
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
233
|
+
MEMBER = "MEMBER",
|
|
234
|
+
WIX_USER = "WIX_USER",
|
|
235
|
+
APP = "APP"
|
|
236
|
+
}
|
|
237
|
+
/** @enumType */
|
|
238
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
239
|
+
interface AccountInfo {
|
|
240
|
+
/**
|
|
241
|
+
* ID of the Wix account associated with the event.
|
|
242
|
+
* @format GUID
|
|
243
|
+
*/
|
|
244
|
+
accountId?: string | null;
|
|
245
|
+
/**
|
|
246
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
247
|
+
* @format GUID
|
|
248
|
+
*/
|
|
249
|
+
parentAccountId?: string | null;
|
|
250
|
+
/**
|
|
251
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
252
|
+
* @format GUID
|
|
253
|
+
*/
|
|
254
|
+
siteId?: string | null;
|
|
255
|
+
}
|
|
256
|
+
interface GetOrCreateCompanionAppRequest {
|
|
257
|
+
}
|
|
258
|
+
interface GetOrCreateCompanionAppResponse {
|
|
259
|
+
/** Companion app that was retrieved, or created and installed. */
|
|
260
|
+
companionApp?: CompanionApp;
|
|
261
|
+
}
|
|
262
|
+
interface GetCompanionAppRequest {
|
|
263
|
+
}
|
|
264
|
+
interface GetCompanionAppResponse {
|
|
265
|
+
/** Retrieved companion app. */
|
|
266
|
+
companionApp?: CompanionApp;
|
|
267
|
+
}
|
|
268
|
+
interface GetComponentsMetadataRequest {
|
|
269
|
+
}
|
|
270
|
+
interface GetComponentsMetadataResponse {
|
|
271
|
+
/**
|
|
272
|
+
* Full component metadata map for the companion app.
|
|
273
|
+
* @maxSize 200
|
|
274
|
+
*/
|
|
275
|
+
componentsMetadata?: Record<string, ComponentsMetadata>;
|
|
276
|
+
}
|
|
277
|
+
interface SetComponentsMetadataRequest {
|
|
278
|
+
/**
|
|
279
|
+
* Component metadata to set. The controlling app ID is taken from the server signature.
|
|
280
|
+
* @maxSize 200
|
|
281
|
+
*/
|
|
282
|
+
componentsMetadata?: Record<string, ComponentsMetadata>;
|
|
283
|
+
}
|
|
284
|
+
interface SetComponentsMetadataResponse {
|
|
285
|
+
/** Full component metadata map after the update. */
|
|
286
|
+
componentsMetadata?: Record<string, ComponentsMetadata>;
|
|
287
|
+
}
|
|
288
|
+
interface CloneCompanionAppRequest {
|
|
289
|
+
/**
|
|
290
|
+
* Origin Wix site ID from which to clone the companion app.
|
|
291
|
+
* @format GUID
|
|
292
|
+
*/
|
|
293
|
+
originMetaSiteId?: string;
|
|
294
|
+
/**
|
|
295
|
+
* Target Wix site ID to which to clone the companion app.
|
|
296
|
+
* @format GUID
|
|
297
|
+
*/
|
|
298
|
+
targetMetaSiteId?: string;
|
|
299
|
+
}
|
|
300
|
+
interface CloneCompanionAppResponse {
|
|
301
|
+
/** Cloned companion app. */
|
|
302
|
+
companionApp?: CompanionApp;
|
|
303
|
+
}
|
|
304
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
305
|
+
/** Emitted on a meta site creation. */
|
|
306
|
+
siteCreated?: SiteCreated;
|
|
307
|
+
/** Emitted on a meta site transfer completion. */
|
|
308
|
+
siteTransferred?: SiteTransferred;
|
|
309
|
+
/** Emitted on a meta site deletion. */
|
|
310
|
+
siteDeleted?: SiteDeleted;
|
|
311
|
+
/** Emitted on a meta site restoration. */
|
|
312
|
+
siteUndeleted?: SiteUndeleted;
|
|
313
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
314
|
+
sitePublished?: SitePublished;
|
|
315
|
+
/** Emitted on a meta site unpublish. */
|
|
316
|
+
siteUnpublished?: SiteUnpublished;
|
|
317
|
+
/** Emitted when meta site is marked as template. */
|
|
318
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
319
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
320
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
321
|
+
/** Emitted when an application is provisioned (installed). */
|
|
322
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
323
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
324
|
+
serviceRemoved?: ServiceRemoved;
|
|
325
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
326
|
+
siteRenamedPayload?: SiteRenamed;
|
|
327
|
+
/** Emitted when meta site was permanently deleted. */
|
|
328
|
+
hardDeleted?: SiteHardDeleted;
|
|
329
|
+
/** Emitted on a namespace change. */
|
|
330
|
+
namespaceChanged?: NamespaceChanged;
|
|
331
|
+
/** Emitted when Studio is attached. */
|
|
332
|
+
studioAssigned?: StudioAssigned;
|
|
333
|
+
/** Emitted when Studio is detached. */
|
|
334
|
+
studioUnassigned?: StudioUnassigned;
|
|
335
|
+
/**
|
|
336
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
337
|
+
* the actual URL.
|
|
338
|
+
*
|
|
339
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
340
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
341
|
+
*/
|
|
342
|
+
urlChanged?: SiteUrlChanged;
|
|
343
|
+
/** Site is marked as PurgedExternally */
|
|
344
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
345
|
+
/** Emitted when Odeditor is attached. */
|
|
346
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
347
|
+
/** Emitted when Odeditor is detached. */
|
|
348
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
349
|
+
/** Emitted when Picasso is attached. */
|
|
350
|
+
picassoAssigned?: PicassoAssigned;
|
|
351
|
+
/** Emitted when Picasso is detached. */
|
|
352
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
353
|
+
/** Emitted when Wixel is attached. */
|
|
354
|
+
wixelAssigned?: WixelAssigned;
|
|
355
|
+
/** Emitted when Wixel is detached. */
|
|
356
|
+
wixelUnassigned?: WixelUnassigned;
|
|
357
|
+
/** Emitted when StudioTwo is attached. */
|
|
358
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
359
|
+
/** Emitted when StudioTwo is detached. */
|
|
360
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
361
|
+
/** Emitted when media from user domain is enabled. */
|
|
362
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
363
|
+
/** Emitted when media from user domain is disabled. */
|
|
364
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
365
|
+
/** Emitted when Editorless is attached. */
|
|
366
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
367
|
+
/** Emitted when Editorless is detached. */
|
|
368
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
369
|
+
/**
|
|
370
|
+
* A meta site id.
|
|
371
|
+
* @format GUID
|
|
372
|
+
*/
|
|
373
|
+
metaSiteId?: string;
|
|
374
|
+
/** A meta site version. Monotonically increasing. */
|
|
375
|
+
version?: string;
|
|
376
|
+
/** A timestamp of the event. */
|
|
377
|
+
timestamp?: string;
|
|
378
|
+
/**
|
|
379
|
+
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
380
|
+
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
381
|
+
* @maxSize 4000
|
|
382
|
+
*/
|
|
383
|
+
assets?: Asset[];
|
|
384
|
+
}
|
|
385
|
+
/** @oneof */
|
|
386
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
387
|
+
/** Emitted on a meta site creation. */
|
|
388
|
+
siteCreated?: SiteCreated;
|
|
389
|
+
/** Emitted on a meta site transfer completion. */
|
|
390
|
+
siteTransferred?: SiteTransferred;
|
|
391
|
+
/** Emitted on a meta site deletion. */
|
|
392
|
+
siteDeleted?: SiteDeleted;
|
|
393
|
+
/** Emitted on a meta site restoration. */
|
|
394
|
+
siteUndeleted?: SiteUndeleted;
|
|
395
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
396
|
+
sitePublished?: SitePublished;
|
|
397
|
+
/** Emitted on a meta site unpublish. */
|
|
398
|
+
siteUnpublished?: SiteUnpublished;
|
|
399
|
+
/** Emitted when meta site is marked as template. */
|
|
400
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
401
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
402
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
403
|
+
/** Emitted when an application is provisioned (installed). */
|
|
404
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
405
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
406
|
+
serviceRemoved?: ServiceRemoved;
|
|
407
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
408
|
+
siteRenamedPayload?: SiteRenamed;
|
|
409
|
+
/** Emitted when meta site was permanently deleted. */
|
|
410
|
+
hardDeleted?: SiteHardDeleted;
|
|
411
|
+
/** Emitted on a namespace change. */
|
|
412
|
+
namespaceChanged?: NamespaceChanged;
|
|
413
|
+
/** Emitted when Studio is attached. */
|
|
414
|
+
studioAssigned?: StudioAssigned;
|
|
415
|
+
/** Emitted when Studio is detached. */
|
|
416
|
+
studioUnassigned?: StudioUnassigned;
|
|
417
|
+
/**
|
|
418
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
419
|
+
* the actual URL.
|
|
420
|
+
*
|
|
421
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
422
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
423
|
+
*/
|
|
424
|
+
urlChanged?: SiteUrlChanged;
|
|
425
|
+
/** Site is marked as PurgedExternally */
|
|
426
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
427
|
+
/** Emitted when Odeditor is attached. */
|
|
428
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
429
|
+
/** Emitted when Odeditor is detached. */
|
|
430
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
431
|
+
/** Emitted when Picasso is attached. */
|
|
432
|
+
picassoAssigned?: PicassoAssigned;
|
|
433
|
+
/** Emitted when Picasso is detached. */
|
|
434
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
435
|
+
/** Emitted when Wixel is attached. */
|
|
436
|
+
wixelAssigned?: WixelAssigned;
|
|
437
|
+
/** Emitted when Wixel is detached. */
|
|
438
|
+
wixelUnassigned?: WixelUnassigned;
|
|
439
|
+
/** Emitted when StudioTwo is attached. */
|
|
440
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
441
|
+
/** Emitted when StudioTwo is detached. */
|
|
442
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
443
|
+
/** Emitted when media from user domain is enabled. */
|
|
444
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
445
|
+
/** Emitted when media from user domain is disabled. */
|
|
446
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
447
|
+
/** Emitted when Editorless is attached. */
|
|
448
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
449
|
+
/** Emitted when Editorless is detached. */
|
|
450
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
451
|
+
}
|
|
452
|
+
interface Asset {
|
|
453
|
+
/**
|
|
454
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
455
|
+
* @maxLength 36
|
|
456
|
+
*/
|
|
457
|
+
appDefId?: string;
|
|
458
|
+
/**
|
|
459
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
460
|
+
* @maxLength 200
|
|
461
|
+
*/
|
|
462
|
+
instanceId?: string;
|
|
463
|
+
/** An application state. */
|
|
464
|
+
state?: StateWithLiterals;
|
|
465
|
+
}
|
|
466
|
+
declare enum State {
|
|
467
|
+
UNKNOWN = "UNKNOWN",
|
|
468
|
+
ENABLED = "ENABLED",
|
|
469
|
+
DISABLED = "DISABLED",
|
|
470
|
+
PENDING = "PENDING",
|
|
471
|
+
DEMO = "DEMO"
|
|
472
|
+
}
|
|
473
|
+
/** @enumType */
|
|
474
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
475
|
+
interface SiteCreated {
|
|
476
|
+
/**
|
|
477
|
+
* A template identifier (empty if not created from a template).
|
|
478
|
+
* @maxLength 36
|
|
479
|
+
*/
|
|
480
|
+
originTemplateId?: string;
|
|
481
|
+
/**
|
|
482
|
+
* An account id of the owner.
|
|
483
|
+
* @format GUID
|
|
484
|
+
*/
|
|
485
|
+
ownerId?: string;
|
|
486
|
+
/** A context in which meta site was created. */
|
|
487
|
+
context?: SiteCreatedContextWithLiterals;
|
|
488
|
+
/**
|
|
489
|
+
* A meta site id from which this site was created.
|
|
490
|
+
*
|
|
491
|
+
* In case of a creation from a template it's a template id.
|
|
492
|
+
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
493
|
+
* @format GUID
|
|
494
|
+
*/
|
|
495
|
+
originMetaSiteId?: string | null;
|
|
496
|
+
/**
|
|
497
|
+
* A meta site name (URL slug).
|
|
498
|
+
* @maxLength 20
|
|
499
|
+
*/
|
|
500
|
+
siteName?: string;
|
|
501
|
+
/** A namespace. */
|
|
502
|
+
namespace?: NamespaceWithLiterals;
|
|
503
|
+
}
|
|
504
|
+
declare enum SiteCreatedContext {
|
|
505
|
+
/** A valid option, we don't expose all reasons why site might be created. */
|
|
506
|
+
OTHER = "OTHER",
|
|
507
|
+
/** A meta site was created from template. */
|
|
508
|
+
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
509
|
+
/** A meta site was created by copying of the transfferred meta site. */
|
|
510
|
+
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
511
|
+
/** A copy of existing meta site. */
|
|
512
|
+
DUPLICATE = "DUPLICATE",
|
|
513
|
+
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
514
|
+
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
515
|
+
/** deprecated A meta site was created for Flash editor. */
|
|
516
|
+
FLASH = "FLASH"
|
|
517
|
+
}
|
|
518
|
+
/** @enumType */
|
|
519
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
520
|
+
declare enum Namespace {
|
|
521
|
+
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
522
|
+
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
523
|
+
WIX = "WIX",
|
|
524
|
+
/** 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. */
|
|
525
|
+
SHOUT_OUT = "SHOUT_OUT",
|
|
526
|
+
/** 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. */
|
|
527
|
+
ALBUMS = "ALBUMS",
|
|
528
|
+
/** 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. */
|
|
529
|
+
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
530
|
+
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
531
|
+
HOTELS = "HOTELS",
|
|
532
|
+
/** 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. */
|
|
533
|
+
CLUBS = "CLUBS",
|
|
534
|
+
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
535
|
+
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
536
|
+
/** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
537
|
+
DEV_SITE = "DEV_SITE",
|
|
538
|
+
/** 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. */
|
|
539
|
+
LOGOS = "LOGOS",
|
|
540
|
+
/** 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. */
|
|
541
|
+
VIDEO_MAKER = "VIDEO_MAKER",
|
|
542
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
543
|
+
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
544
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
545
|
+
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
546
|
+
/**
|
|
547
|
+
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
548
|
+
*
|
|
549
|
+
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
550
|
+
*/
|
|
551
|
+
HTML_DRAFT = "HTML_DRAFT",
|
|
552
|
+
/**
|
|
553
|
+
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
554
|
+
* Will be accessible from Site List and will not have a website app.
|
|
555
|
+
* Once the user attaches a site, the site will become a regular wixsite.
|
|
556
|
+
*/
|
|
557
|
+
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
558
|
+
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
559
|
+
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
560
|
+
/** It is to be used in the Business First efforts. */
|
|
561
|
+
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
562
|
+
/** Bookings business flow with no site. */
|
|
563
|
+
ANYWHERE = "ANYWHERE",
|
|
564
|
+
/** Namespace for Headless Backoffice with no editor */
|
|
565
|
+
HEADLESS = "HEADLESS",
|
|
566
|
+
/**
|
|
567
|
+
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
568
|
+
* The site will be used for account level CSM feature for enterprise
|
|
569
|
+
*/
|
|
570
|
+
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
571
|
+
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
572
|
+
RISE = "RISE",
|
|
573
|
+
/**
|
|
574
|
+
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
575
|
+
* There's a blank site behind the scene but it's blank).
|
|
576
|
+
* The Mobile company will be the owner of this namespace.
|
|
577
|
+
*/
|
|
578
|
+
BRANDED_FIRST = "BRANDED_FIRST",
|
|
579
|
+
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
580
|
+
NOWNIA = "NOWNIA",
|
|
581
|
+
/**
|
|
582
|
+
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
583
|
+
* The Partners company owns this namespace.
|
|
584
|
+
*/
|
|
585
|
+
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
586
|
+
/** Codux Headless Sites */
|
|
587
|
+
CODUX = "CODUX",
|
|
588
|
+
/** Bobb - AI Design Creator. */
|
|
589
|
+
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
590
|
+
/**
|
|
591
|
+
* Shared Blog Site is a unique single site across Enterprise account,
|
|
592
|
+
* This site will hold all Blog posts related to the Marketing product.
|
|
593
|
+
*/
|
|
594
|
+
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
595
|
+
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
596
|
+
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
597
|
+
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
598
|
+
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
599
|
+
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
600
|
+
MIMIR = "MIMIR",
|
|
601
|
+
/** Wix Twins platform. */
|
|
602
|
+
TWINS = "TWINS",
|
|
603
|
+
/** Wix Nano. */
|
|
604
|
+
NANO = "NANO",
|
|
605
|
+
/** Base44 headless sites. */
|
|
606
|
+
BASE44 = "BASE44",
|
|
607
|
+
/** Wix Channels Sites */
|
|
608
|
+
CHANNELS = "CHANNELS",
|
|
609
|
+
/** Nautilus platform. */
|
|
610
|
+
NAUTILUS = "NAUTILUS",
|
|
611
|
+
/**
|
|
612
|
+
* Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
|
|
613
|
+
* Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
|
|
614
|
+
*/
|
|
615
|
+
SYMPHONY = "SYMPHONY",
|
|
616
|
+
/** Nautilus platform app. */
|
|
617
|
+
NAUTILUS_APPS = "NAUTILUS_APPS",
|
|
618
|
+
/**
|
|
619
|
+
* Vibu — a siteless site representing a project built with Vibu (the AI app builder).
|
|
620
|
+
* Holds the project's generated code, conversations, assets, and manages collaborators for the project.
|
|
621
|
+
*/
|
|
622
|
+
VIBU = "VIBU",
|
|
623
|
+
/**
|
|
624
|
+
* Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
|
|
625
|
+
* (an Enterprise account may have several), holding that BrandKit's brand definition
|
|
626
|
+
* (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
|
|
627
|
+
* MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
628
|
+
*/
|
|
629
|
+
ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT"
|
|
630
|
+
}
|
|
631
|
+
/** @enumType */
|
|
632
|
+
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' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS' | 'SYMPHONY' | 'NAUTILUS_APPS' | 'VIBU' | 'ENTERPRISE_BRAND_KIT';
|
|
633
|
+
/** Site transferred to another user. */
|
|
634
|
+
interface SiteTransferred {
|
|
635
|
+
/**
|
|
636
|
+
* A previous owner id (user that transfers meta site).
|
|
637
|
+
* @format GUID
|
|
638
|
+
*/
|
|
639
|
+
oldOwnerId?: string;
|
|
640
|
+
/**
|
|
641
|
+
* A new owner id (user that accepts meta site).
|
|
642
|
+
* @format GUID
|
|
643
|
+
*/
|
|
644
|
+
newOwnerId?: string;
|
|
645
|
+
}
|
|
646
|
+
/** Soft deletion of the meta site. Could be restored. */
|
|
647
|
+
interface SiteDeleted {
|
|
648
|
+
/** A deletion context. */
|
|
649
|
+
deleteContext?: DeleteContext;
|
|
650
|
+
}
|
|
651
|
+
interface DeleteContext {
|
|
652
|
+
/** When the meta site was deleted. */
|
|
653
|
+
dateDeleted?: Date | null;
|
|
654
|
+
/** A status. */
|
|
655
|
+
deleteStatus?: DeleteStatusWithLiterals;
|
|
656
|
+
/**
|
|
657
|
+
* A reason (flow).
|
|
658
|
+
* @maxLength 255
|
|
659
|
+
*/
|
|
660
|
+
deleteOrigin?: string;
|
|
661
|
+
/**
|
|
662
|
+
* A service that deleted it.
|
|
663
|
+
* @maxLength 255
|
|
664
|
+
*/
|
|
665
|
+
initiatorId?: string | null;
|
|
666
|
+
}
|
|
667
|
+
declare enum DeleteStatus {
|
|
668
|
+
UNKNOWN = "UNKNOWN",
|
|
669
|
+
TRASH = "TRASH",
|
|
670
|
+
DELETED = "DELETED",
|
|
671
|
+
PENDING_PURGE = "PENDING_PURGE",
|
|
672
|
+
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
673
|
+
}
|
|
674
|
+
/** @enumType */
|
|
675
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
676
|
+
/** Restoration of the meta site. */
|
|
677
|
+
interface SiteUndeleted {
|
|
678
|
+
}
|
|
679
|
+
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
680
|
+
interface SitePublished {
|
|
681
|
+
}
|
|
682
|
+
interface SiteUnpublished {
|
|
683
|
+
/**
|
|
684
|
+
* A list of URLs previously associated with the meta site.
|
|
685
|
+
* @maxLength 4000
|
|
686
|
+
* @maxSize 10000
|
|
687
|
+
*/
|
|
688
|
+
urls?: string[];
|
|
689
|
+
}
|
|
690
|
+
interface SiteMarkedAsTemplate {
|
|
691
|
+
}
|
|
692
|
+
interface SiteMarkedAsWixSite {
|
|
693
|
+
}
|
|
694
|
+
/**
|
|
695
|
+
* Represents a service provisioned a site.
|
|
696
|
+
*
|
|
697
|
+
* Note on `origin_instance_id`:
|
|
698
|
+
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
699
|
+
* This is because of the following scenario:
|
|
700
|
+
*
|
|
701
|
+
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
702
|
+
* such as a product catalog. When you create a site from this template, you inherit this
|
|
703
|
+
* default product catalog. However, if the template's product catalog is modified,
|
|
704
|
+
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
705
|
+
* your site remains consistent with what you initially received and does not include any
|
|
706
|
+
* changes made to the original template afterward.
|
|
707
|
+
* To ensure this, the TPA on the template gets a new instance_id.
|
|
708
|
+
*/
|
|
709
|
+
interface ServiceProvisioned {
|
|
710
|
+
/**
|
|
711
|
+
* Either UUID or EmbeddedServiceType.
|
|
712
|
+
* @maxLength 36
|
|
713
|
+
*/
|
|
714
|
+
appDefId?: string;
|
|
715
|
+
/**
|
|
716
|
+
* Not only UUID. Something here could be something weird.
|
|
717
|
+
* @maxLength 36
|
|
718
|
+
*/
|
|
719
|
+
instanceId?: string;
|
|
720
|
+
/**
|
|
721
|
+
* An instance id from which this instance is originated.
|
|
722
|
+
* @maxLength 36
|
|
723
|
+
*/
|
|
724
|
+
originInstanceId?: string;
|
|
725
|
+
/**
|
|
726
|
+
* A version.
|
|
727
|
+
* @maxLength 500
|
|
728
|
+
*/
|
|
729
|
+
version?: string | null;
|
|
730
|
+
/**
|
|
731
|
+
* The origin meta site id
|
|
732
|
+
* @format GUID
|
|
733
|
+
*/
|
|
734
|
+
originMetaSiteId?: string | null;
|
|
735
|
+
}
|
|
736
|
+
interface ServiceRemoved {
|
|
737
|
+
/**
|
|
738
|
+
* Either UUID or EmbeddedServiceType.
|
|
739
|
+
* @maxLength 36
|
|
740
|
+
*/
|
|
741
|
+
appDefId?: string;
|
|
742
|
+
/**
|
|
743
|
+
* Not only UUID. Something here could be something weird.
|
|
744
|
+
* @maxLength 36
|
|
745
|
+
*/
|
|
746
|
+
instanceId?: string;
|
|
747
|
+
/**
|
|
748
|
+
* A version.
|
|
749
|
+
* @maxLength 500
|
|
750
|
+
*/
|
|
751
|
+
version?: string | null;
|
|
752
|
+
}
|
|
753
|
+
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
754
|
+
interface SiteRenamed {
|
|
755
|
+
/**
|
|
756
|
+
* A new meta site name (URL slug).
|
|
757
|
+
* @maxLength 20
|
|
758
|
+
*/
|
|
759
|
+
newSiteName?: string;
|
|
760
|
+
/**
|
|
761
|
+
* A previous meta site name (URL slug).
|
|
762
|
+
* @maxLength 255
|
|
763
|
+
*/
|
|
764
|
+
oldSiteName?: string;
|
|
765
|
+
}
|
|
766
|
+
/**
|
|
767
|
+
* Hard deletion of the meta site.
|
|
768
|
+
*
|
|
769
|
+
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
770
|
+
*/
|
|
771
|
+
interface SiteHardDeleted {
|
|
772
|
+
/** A deletion context. */
|
|
773
|
+
deleteContext?: DeleteContext;
|
|
774
|
+
}
|
|
775
|
+
interface NamespaceChanged {
|
|
776
|
+
/** A previous namespace. */
|
|
777
|
+
oldNamespace?: NamespaceWithLiterals;
|
|
778
|
+
/** A new namespace. */
|
|
779
|
+
newNamespace?: NamespaceWithLiterals;
|
|
780
|
+
}
|
|
781
|
+
/** Assigned Studio editor */
|
|
782
|
+
interface StudioAssigned {
|
|
783
|
+
}
|
|
784
|
+
/** Unassigned Studio editor */
|
|
785
|
+
interface StudioUnassigned {
|
|
786
|
+
}
|
|
787
|
+
/**
|
|
788
|
+
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
789
|
+
*
|
|
790
|
+
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
791
|
+
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
792
|
+
*
|
|
793
|
+
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
794
|
+
*/
|
|
795
|
+
interface SiteUrlChanged {
|
|
796
|
+
}
|
|
797
|
+
/**
|
|
798
|
+
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
799
|
+
* Consumed by other teams to remove relevant data.
|
|
800
|
+
*/
|
|
801
|
+
interface SitePurgedExternally {
|
|
802
|
+
/**
|
|
803
|
+
* @maxLength 2048
|
|
804
|
+
* @maxSize 100
|
|
805
|
+
* @deprecated
|
|
806
|
+
* @targetRemovalDate 2025-04-15
|
|
807
|
+
*/
|
|
808
|
+
appDefId?: string[];
|
|
809
|
+
}
|
|
810
|
+
/** Assigned Odeditor */
|
|
811
|
+
interface OdeditorAssigned {
|
|
812
|
+
}
|
|
813
|
+
/** Unassigned Odeditor */
|
|
814
|
+
interface OdeditorUnassigned {
|
|
815
|
+
}
|
|
816
|
+
/** Assigned Picasso editor */
|
|
817
|
+
interface PicassoAssigned {
|
|
818
|
+
}
|
|
819
|
+
/** Unassigned Picasso */
|
|
820
|
+
interface PicassoUnassigned {
|
|
821
|
+
}
|
|
822
|
+
/** Assigned Wixel */
|
|
823
|
+
interface WixelAssigned {
|
|
824
|
+
}
|
|
825
|
+
/** Unassigned Wixel */
|
|
826
|
+
interface WixelUnassigned {
|
|
827
|
+
}
|
|
828
|
+
/** Assigned StudioTwo */
|
|
829
|
+
interface StudioTwoAssigned {
|
|
830
|
+
}
|
|
831
|
+
/** Unassigned StudioTwo */
|
|
832
|
+
interface StudioTwoUnassigned {
|
|
833
|
+
}
|
|
834
|
+
/** Media from user domain is enabled. */
|
|
835
|
+
interface UserDomainMediaEnabled {
|
|
836
|
+
}
|
|
837
|
+
/** Media from user domain is disabled. */
|
|
838
|
+
interface UserDomainMediaDisabled {
|
|
839
|
+
}
|
|
840
|
+
/** Assigned Editorless */
|
|
841
|
+
interface EditorlessAssigned {
|
|
842
|
+
}
|
|
843
|
+
/** Unassigned Editorless */
|
|
844
|
+
interface EditorlessUnassigned {
|
|
845
|
+
}
|
|
846
|
+
interface Empty {
|
|
847
|
+
}
|
|
848
|
+
/**
|
|
849
|
+
* Retrieves the companion app for the current site, creating and installing it if it doesn't exist.
|
|
850
|
+
*
|
|
851
|
+
* The request must be made in the context of a Wix site.
|
|
852
|
+
* @public
|
|
853
|
+
* @documentationMaturity preview
|
|
854
|
+
* @permissionId DEV_CENTER.WRITE_COMPANION_APPS
|
|
855
|
+
* @fqn wix.devcenter.apps.companionapps.v1.CompanionApps.GetOrCreateCompanionApp
|
|
856
|
+
*/
|
|
857
|
+
declare function getOrCreateCompanionApp(): Promise<NonNullablePaths<GetOrCreateCompanionAppResponse, `companionApp._id` | `companionApp.status`, 3>>;
|
|
858
|
+
/**
|
|
859
|
+
* Retrieves the companion app for the current site.
|
|
860
|
+
*
|
|
861
|
+
* Fails if the current site doesn't have a companion app.
|
|
862
|
+
* @public
|
|
863
|
+
* @documentationMaturity preview
|
|
864
|
+
* @permissionId DEV_CENTER.READ_COMPANION_APPS
|
|
865
|
+
* @fqn wix.devcenter.apps.companionapps.v1.CompanionApps.GetCompanionApp
|
|
866
|
+
*/
|
|
867
|
+
declare function getCompanionApp(): Promise<NonNullablePaths<GetCompanionAppResponse, `companionApp._id` | `companionApp.status`, 3>>;
|
|
868
|
+
|
|
869
|
+
export { type AccountInfo, type ActionEvent, type Asset, type CloneCompanionAppRequest, type CloneCompanionAppResponse, type CompanionApp, type CompanionAppCloneCompleted, type CompanionAppCloneStarted, type CompanionAppRegistrationRequested, CompanionAppStatus, type CompanionAppStatusWithLiterals, type ComponentsMetadata, type DeleteContext, DeleteStatus, type DeleteStatusWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type EditorlessAssigned, type EditorlessUnassigned, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type GetCompanionAppRequest, type GetCompanionAppResponse, type GetComponentsMetadataRequest, type GetComponentsMetadataResponse, type GetOrCreateCompanionAppRequest, type GetOrCreateCompanionAppResponse, type IdentificationData, type IdentificationDataIdOneOf, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type PicassoAssigned, type PicassoUnassigned, type RestoreInfo, type ServiceProvisioned, type ServiceRemoved, type SetComponentsMetadataRequest, type SetComponentsMetadataResponse, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, State, type StateWithLiterals, type StudioAssigned, type StudioTwoAssigned, type StudioTwoUnassigned, type StudioUnassigned, type UserDomainMediaDisabled, type UserDomainMediaEnabled, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixelAssigned, type WixelUnassigned, getCompanionApp, getOrCreateCompanionApp };
|