@wix/auto_sdk_editor-branches_branches 1.0.19 → 1.0.21
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 +15 -9
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +54 -77
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +721 -31
- package/build/cjs/meta.js +112 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +15 -9
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +54 -77
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +721 -31
- package/build/es/meta.mjs +103 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +15 -9
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +54 -77
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +721 -31
- package/build/internal/cjs/meta.js +112 -0
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +15 -9
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +54 -77
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +721 -31
- package/build/internal/es/meta.mjs +103 -0
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +3 -3
package/build/cjs/meta.d.ts
CHANGED
|
@@ -6,9 +6,9 @@ import '@wix/sdk-types';
|
|
|
6
6
|
* Read more about branches in this [article](https://support.wix.com/en/article/about-test-sites).
|
|
7
7
|
*/
|
|
8
8
|
interface Branch extends BranchSourceOneOf {
|
|
9
|
-
/** Source branch properties. Use when
|
|
9
|
+
/** Source branch properties. Use when `sourceType` = `SOURCE_BRANCH`. */
|
|
10
10
|
sourceBranchProperties?: SourceBranch;
|
|
11
|
-
/** Source template properties. Use when
|
|
11
|
+
/** Source template properties. Use when `sourceType` = `SOURCE_TEMPLATE`. */
|
|
12
12
|
sourceTemplateProperties?: SourceTemplate;
|
|
13
13
|
/**
|
|
14
14
|
* Branch ID.
|
|
@@ -30,7 +30,7 @@ interface Branch extends BranchSourceOneOf {
|
|
|
30
30
|
* @maxLength 50
|
|
31
31
|
*/
|
|
32
32
|
name?: string | null;
|
|
33
|
-
/** Source type. Must be aligned with the corresponding source properties
|
|
33
|
+
/** Source type. Must be aligned with the corresponding source properties below. */
|
|
34
34
|
sourceType?: SourceTypeWithLiterals;
|
|
35
35
|
/**
|
|
36
36
|
* Date and time the branch was last published, if relevant.
|
|
@@ -38,12 +38,12 @@ interface Branch extends BranchSourceOneOf {
|
|
|
38
38
|
*/
|
|
39
39
|
lastPublishDate?: string | null;
|
|
40
40
|
/**
|
|
41
|
-
*
|
|
41
|
+
* Wix editor type.
|
|
42
42
|
* @readonly
|
|
43
43
|
*/
|
|
44
44
|
editorType?: EditorType;
|
|
45
45
|
/**
|
|
46
|
-
*
|
|
46
|
+
* Whether this branch is the default.
|
|
47
47
|
* @readonly
|
|
48
48
|
*/
|
|
49
49
|
default?: boolean | null;
|
|
@@ -65,19 +65,19 @@ interface Branch extends BranchSourceOneOf {
|
|
|
65
65
|
}
|
|
66
66
|
/** @oneof */
|
|
67
67
|
interface BranchSourceOneOf {
|
|
68
|
-
/** Source branch properties. Use when
|
|
68
|
+
/** Source branch properties. Use when `sourceType` = `SOURCE_BRANCH`. */
|
|
69
69
|
sourceBranchProperties?: SourceBranch;
|
|
70
|
-
/** Source template properties. Use when
|
|
70
|
+
/** Source template properties. Use when `sourceType` = `SOURCE_TEMPLATE`. */
|
|
71
71
|
sourceTemplateProperties?: SourceTemplate;
|
|
72
72
|
}
|
|
73
73
|
declare enum Type {
|
|
74
74
|
/** Unknown branch type. */
|
|
75
75
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
76
|
-
/** A branch created by a Wix user, that can be accessed for editing and publishing
|
|
76
|
+
/** A branch created by a Wix user, that can be accessed for editing and publishing in the editor UI. */
|
|
77
77
|
USER = "USER",
|
|
78
|
-
/** A branch created for technical purposes, unrelated to the Wix user. For internal use, can't be accessed
|
|
78
|
+
/** A branch created for technical purposes, unrelated to the Wix user. For internal use, can't be accessed in the editor UI. */
|
|
79
79
|
TECHNICAL = "TECHNICAL",
|
|
80
|
-
/** The original branch of the site, created when the site is created. Can be accessed for editing and publishing in the editor. */
|
|
80
|
+
/** The original branch of the site, created when the site is created. Can be accessed for editing and publishing in the editor UI. */
|
|
81
81
|
ORIGINAL_BRANCH = "ORIGINAL_BRANCH"
|
|
82
82
|
}
|
|
83
83
|
/** @enumType */
|
|
@@ -85,23 +85,23 @@ type TypeWithLiterals = Type | 'UNKNOWN_TYPE' | 'USER' | 'TECHNICAL' | 'ORIGINAL
|
|
|
85
85
|
declare enum SourceType {
|
|
86
86
|
/** Unknown source type. Do not use - will cause ILLEGAL_SOURCE_TYPE error. */
|
|
87
87
|
UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
|
|
88
|
-
/** This branch's source was a branch. Must be used with
|
|
88
|
+
/** This branch's source was a branch. Must be used with `sourceBranchProperties`. */
|
|
89
89
|
SOURCE_BRANCH = "SOURCE_BRANCH",
|
|
90
|
-
/** This branch's source was a template. Must be used with
|
|
90
|
+
/** This branch's source was a template. Must be used with `sourceTemplateProperties`. For internal use. */
|
|
91
91
|
SOURCE_TEMPLATE = "SOURCE_TEMPLATE"
|
|
92
92
|
}
|
|
93
93
|
/** @enumType */
|
|
94
94
|
type SourceTypeWithLiterals = SourceType | 'UNKNOWN_SOURCE_TYPE' | 'SOURCE_BRANCH' | 'SOURCE_TEMPLATE';
|
|
95
95
|
interface EditorType {
|
|
96
|
-
/**
|
|
96
|
+
/** Wix editor types. */
|
|
97
97
|
editorTypeOptions?: EditorTypeOptionsWithLiterals;
|
|
98
98
|
}
|
|
99
99
|
declare enum EditorTypeOptions {
|
|
100
|
-
/** Unknown editor type */
|
|
100
|
+
/** Unknown editor type. Not supported. */
|
|
101
101
|
UNKNOWN_EDITOR_TYPE = "UNKNOWN_EDITOR_TYPE",
|
|
102
|
-
/**
|
|
102
|
+
/** Wix Studio Editor. */
|
|
103
103
|
STUDIO = "STUDIO",
|
|
104
|
-
/**
|
|
104
|
+
/** Wix's Classic Editor. */
|
|
105
105
|
CLASSIC = "CLASSIC"
|
|
106
106
|
}
|
|
107
107
|
/** @enumType */
|
|
@@ -112,7 +112,7 @@ interface SourceBranch {
|
|
|
112
112
|
* @format GUID
|
|
113
113
|
*/
|
|
114
114
|
branchId?: string;
|
|
115
|
-
/**
|
|
115
|
+
/** Revision number, which increments by 1 each time the branch is updated. To prevent conflicting changes, the current revision must be passed when updating the branch. */
|
|
116
116
|
branchRevision?: string | null;
|
|
117
117
|
}
|
|
118
118
|
interface SourceTemplate {
|
|
@@ -170,7 +170,7 @@ interface DeleteBranchRequest {
|
|
|
170
170
|
interface DeleteBranchResponse {
|
|
171
171
|
}
|
|
172
172
|
interface QueryBranchesRequest {
|
|
173
|
-
/**
|
|
173
|
+
/** Query options. */
|
|
174
174
|
query?: CursorQuery;
|
|
175
175
|
}
|
|
176
176
|
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
@@ -181,13 +181,13 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
181
181
|
*
|
|
182
182
|
* Filterable fields:
|
|
183
183
|
*
|
|
184
|
-
* `type
|
|
185
|
-
* `name
|
|
186
|
-
* `updatedDate
|
|
187
|
-
* `createdDate
|
|
188
|
-
* `lastPublishDate
|
|
189
|
-
* `sourceBranchProperties.branchId
|
|
190
|
-
* `sourceBranchProperties.branchRevision`
|
|
184
|
+
* - `type`,
|
|
185
|
+
* - `name`,
|
|
186
|
+
* - `updatedDate`,
|
|
187
|
+
* - `createdDate`,
|
|
188
|
+
* - `lastPublishDate`,
|
|
189
|
+
* - `sourceBranchProperties.branchId`,
|
|
190
|
+
* - `sourceBranchProperties.branchRevision`
|
|
191
191
|
*
|
|
192
192
|
* All operators are valid.
|
|
193
193
|
*/
|
|
@@ -197,9 +197,9 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
197
197
|
*
|
|
198
198
|
* Sortable fields:
|
|
199
199
|
*
|
|
200
|
-
* `updatedDate
|
|
201
|
-
* `createdDate
|
|
202
|
-
* `lastPublishDate`
|
|
200
|
+
* - `updatedDate`,
|
|
201
|
+
* - `createdDate`,
|
|
202
|
+
* - `lastPublishDate`
|
|
203
203
|
* @maxSize 5
|
|
204
204
|
*/
|
|
205
205
|
sort?: Sorting[];
|
|
@@ -242,7 +242,7 @@ interface CursorPaging {
|
|
|
242
242
|
interface QueryBranchesResponse {
|
|
243
243
|
/** List of branches. */
|
|
244
244
|
branches?: Branch[];
|
|
245
|
-
/**
|
|
245
|
+
/** Metadata of the paginated results. */
|
|
246
246
|
pagingMetadata?: CursorPagingMetadata;
|
|
247
247
|
}
|
|
248
248
|
interface CursorPagingMetadata {
|
|
@@ -270,9 +270,521 @@ interface Cursors {
|
|
|
270
270
|
*/
|
|
271
271
|
prev?: string | null;
|
|
272
272
|
}
|
|
273
|
+
interface UpdateExtendedFieldsRequest {
|
|
274
|
+
/** ID of the entity to update. */
|
|
275
|
+
id?: string;
|
|
276
|
+
/** Identifier for the app whose extended fields are being updated. */
|
|
277
|
+
namespace?: string;
|
|
278
|
+
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
279
|
+
namespaceData?: Record<string, any> | null;
|
|
280
|
+
}
|
|
281
|
+
interface UpdateExtendedFieldsResponse {
|
|
282
|
+
/** Updated branch. */
|
|
283
|
+
branch?: Branch;
|
|
284
|
+
}
|
|
285
|
+
interface HtmlSitePublished {
|
|
286
|
+
/**
|
|
287
|
+
* Application instance ID
|
|
288
|
+
* @maxLength 50
|
|
289
|
+
*/
|
|
290
|
+
appInstanceId?: string;
|
|
291
|
+
/**
|
|
292
|
+
* Application type
|
|
293
|
+
* @maxLength 100
|
|
294
|
+
*/
|
|
295
|
+
appType?: string;
|
|
296
|
+
/** Revision */
|
|
297
|
+
revision?: string;
|
|
298
|
+
/**
|
|
299
|
+
* MSID
|
|
300
|
+
* @maxLength 100
|
|
301
|
+
*/
|
|
302
|
+
metaSiteId?: string | null;
|
|
303
|
+
/**
|
|
304
|
+
* optional branch id if publish is done from branch
|
|
305
|
+
* @format GUID
|
|
306
|
+
*/
|
|
307
|
+
branchId?: string | null;
|
|
308
|
+
/** The site's last transactionId */
|
|
309
|
+
lastTransactionId?: string | null;
|
|
310
|
+
/** A list of the site's pages */
|
|
311
|
+
pages?: Page[];
|
|
312
|
+
/** Site's publish date */
|
|
313
|
+
publishDate?: string;
|
|
314
|
+
}
|
|
315
|
+
interface Page {
|
|
316
|
+
/**
|
|
317
|
+
* Page's Id
|
|
318
|
+
* @maxLength 100
|
|
319
|
+
*/
|
|
320
|
+
id?: string;
|
|
321
|
+
}
|
|
322
|
+
interface Empty {
|
|
323
|
+
}
|
|
324
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
325
|
+
/** Emitted on a meta site creation. */
|
|
326
|
+
siteCreated?: SiteCreated;
|
|
327
|
+
/** Emitted on a meta site transfer completion. */
|
|
328
|
+
siteTransferred?: SiteTransferred;
|
|
329
|
+
/** Emitted on a meta site deletion. */
|
|
330
|
+
siteDeleted?: SiteDeleted;
|
|
331
|
+
/** Emitted on a meta site restoration. */
|
|
332
|
+
siteUndeleted?: SiteUndeleted;
|
|
333
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
334
|
+
sitePublished?: SitePublished;
|
|
335
|
+
/** Emitted on a meta site unpublish. */
|
|
336
|
+
siteUnpublished?: SiteUnpublished;
|
|
337
|
+
/** Emitted when meta site is marked as template. */
|
|
338
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
339
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
340
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
341
|
+
/** Emitted when an application is provisioned (installed). */
|
|
342
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
343
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
344
|
+
serviceRemoved?: ServiceRemoved;
|
|
345
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
346
|
+
siteRenamedPayload?: SiteRenamed;
|
|
347
|
+
/** Emitted when meta site was permanently deleted. */
|
|
348
|
+
hardDeleted?: SiteHardDeleted;
|
|
349
|
+
/** Emitted on a namespace change. */
|
|
350
|
+
namespaceChanged?: NamespaceChanged;
|
|
351
|
+
/** Emitted when Studio is attached. */
|
|
352
|
+
studioAssigned?: StudioAssigned;
|
|
353
|
+
/** Emitted when Studio is detached. */
|
|
354
|
+
studioUnassigned?: StudioUnassigned;
|
|
355
|
+
/**
|
|
356
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
357
|
+
* the actual URL.
|
|
358
|
+
*
|
|
359
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
360
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
361
|
+
*/
|
|
362
|
+
urlChanged?: SiteUrlChanged;
|
|
363
|
+
/** Site is marked as PurgedExternally */
|
|
364
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
365
|
+
/** Emitted when Odeditor is attached. */
|
|
366
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
367
|
+
/** Emitted when Odeditor is detached. */
|
|
368
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
369
|
+
/** Emitted when Picasso is attached. */
|
|
370
|
+
picassoAssigned?: PicassoAssigned;
|
|
371
|
+
/** Emitted when Picasso is detached. */
|
|
372
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
373
|
+
/**
|
|
374
|
+
* A meta site id.
|
|
375
|
+
* @format GUID
|
|
376
|
+
*/
|
|
377
|
+
metaSiteId?: string;
|
|
378
|
+
/** A meta site version. Monotonically increasing. */
|
|
379
|
+
version?: string;
|
|
380
|
+
/** A timestamp of the event. */
|
|
381
|
+
timestamp?: string;
|
|
382
|
+
/**
|
|
383
|
+
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
384
|
+
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
385
|
+
* @maxSize 4000
|
|
386
|
+
*/
|
|
387
|
+
assets?: Asset[];
|
|
388
|
+
}
|
|
389
|
+
/** @oneof */
|
|
390
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
391
|
+
/** Emitted on a meta site creation. */
|
|
392
|
+
siteCreated?: SiteCreated;
|
|
393
|
+
/** Emitted on a meta site transfer completion. */
|
|
394
|
+
siteTransferred?: SiteTransferred;
|
|
395
|
+
/** Emitted on a meta site deletion. */
|
|
396
|
+
siteDeleted?: SiteDeleted;
|
|
397
|
+
/** Emitted on a meta site restoration. */
|
|
398
|
+
siteUndeleted?: SiteUndeleted;
|
|
399
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
400
|
+
sitePublished?: SitePublished;
|
|
401
|
+
/** Emitted on a meta site unpublish. */
|
|
402
|
+
siteUnpublished?: SiteUnpublished;
|
|
403
|
+
/** Emitted when meta site is marked as template. */
|
|
404
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
405
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
406
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
407
|
+
/** Emitted when an application is provisioned (installed). */
|
|
408
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
409
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
410
|
+
serviceRemoved?: ServiceRemoved;
|
|
411
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
412
|
+
siteRenamedPayload?: SiteRenamed;
|
|
413
|
+
/** Emitted when meta site was permanently deleted. */
|
|
414
|
+
hardDeleted?: SiteHardDeleted;
|
|
415
|
+
/** Emitted on a namespace change. */
|
|
416
|
+
namespaceChanged?: NamespaceChanged;
|
|
417
|
+
/** Emitted when Studio is attached. */
|
|
418
|
+
studioAssigned?: StudioAssigned;
|
|
419
|
+
/** Emitted when Studio is detached. */
|
|
420
|
+
studioUnassigned?: StudioUnassigned;
|
|
421
|
+
/**
|
|
422
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
423
|
+
* the actual URL.
|
|
424
|
+
*
|
|
425
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
426
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
427
|
+
*/
|
|
428
|
+
urlChanged?: SiteUrlChanged;
|
|
429
|
+
/** Site is marked as PurgedExternally */
|
|
430
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
431
|
+
/** Emitted when Odeditor is attached. */
|
|
432
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
433
|
+
/** Emitted when Odeditor is detached. */
|
|
434
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
435
|
+
/** Emitted when Picasso is attached. */
|
|
436
|
+
picassoAssigned?: PicassoAssigned;
|
|
437
|
+
/** Emitted when Picasso is detached. */
|
|
438
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
439
|
+
}
|
|
440
|
+
interface Asset {
|
|
441
|
+
/**
|
|
442
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
443
|
+
* @maxLength 36
|
|
444
|
+
*/
|
|
445
|
+
appDefId?: string;
|
|
446
|
+
/**
|
|
447
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
448
|
+
* @maxLength 200
|
|
449
|
+
*/
|
|
450
|
+
instanceId?: string;
|
|
451
|
+
/** An application state. */
|
|
452
|
+
state?: StateWithLiterals;
|
|
453
|
+
}
|
|
454
|
+
declare enum State {
|
|
455
|
+
UNKNOWN = "UNKNOWN",
|
|
456
|
+
ENABLED = "ENABLED",
|
|
457
|
+
DISABLED = "DISABLED",
|
|
458
|
+
PENDING = "PENDING",
|
|
459
|
+
DEMO = "DEMO"
|
|
460
|
+
}
|
|
461
|
+
/** @enumType */
|
|
462
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
463
|
+
interface SiteCreated {
|
|
464
|
+
/**
|
|
465
|
+
* A template identifier (empty if not created from a template).
|
|
466
|
+
* @maxLength 36
|
|
467
|
+
*/
|
|
468
|
+
originTemplateId?: string;
|
|
469
|
+
/**
|
|
470
|
+
* An account id of the owner.
|
|
471
|
+
* @format GUID
|
|
472
|
+
*/
|
|
473
|
+
ownerId?: string;
|
|
474
|
+
/** A context in which meta site was created. */
|
|
475
|
+
context?: SiteCreatedContextWithLiterals;
|
|
476
|
+
/**
|
|
477
|
+
* A meta site id from which this site was created.
|
|
478
|
+
*
|
|
479
|
+
* In case of a creation from a template it's a template id.
|
|
480
|
+
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
481
|
+
* @format GUID
|
|
482
|
+
*/
|
|
483
|
+
originMetaSiteId?: string | null;
|
|
484
|
+
/**
|
|
485
|
+
* A meta site name (URL slug).
|
|
486
|
+
* @maxLength 20
|
|
487
|
+
*/
|
|
488
|
+
siteName?: string;
|
|
489
|
+
/** A namespace. */
|
|
490
|
+
namespace?: NamespaceWithLiterals;
|
|
491
|
+
}
|
|
492
|
+
declare enum SiteCreatedContext {
|
|
493
|
+
/** A valid option, we don't expose all reasons why site might be created. */
|
|
494
|
+
OTHER = "OTHER",
|
|
495
|
+
/** A meta site was created from template. */
|
|
496
|
+
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
497
|
+
/** A meta site was created by copying of the transfferred meta site. */
|
|
498
|
+
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
499
|
+
/** A copy of existing meta site. */
|
|
500
|
+
DUPLICATE = "DUPLICATE",
|
|
501
|
+
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
502
|
+
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
503
|
+
/** deprecated A meta site was created for Flash editor. */
|
|
504
|
+
FLASH = "FLASH"
|
|
505
|
+
}
|
|
506
|
+
/** @enumType */
|
|
507
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
508
|
+
declare enum Namespace {
|
|
509
|
+
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
510
|
+
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
511
|
+
WIX = "WIX",
|
|
512
|
+
/** 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. */
|
|
513
|
+
SHOUT_OUT = "SHOUT_OUT",
|
|
514
|
+
/** 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. */
|
|
515
|
+
ALBUMS = "ALBUMS",
|
|
516
|
+
/** 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. */
|
|
517
|
+
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
518
|
+
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
519
|
+
HOTELS = "HOTELS",
|
|
520
|
+
/** 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. */
|
|
521
|
+
CLUBS = "CLUBS",
|
|
522
|
+
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
523
|
+
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
524
|
+
/** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
525
|
+
DEV_SITE = "DEV_SITE",
|
|
526
|
+
/** 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. */
|
|
527
|
+
LOGOS = "LOGOS",
|
|
528
|
+
/** 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. */
|
|
529
|
+
VIDEO_MAKER = "VIDEO_MAKER",
|
|
530
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
531
|
+
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
532
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
533
|
+
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
534
|
+
/**
|
|
535
|
+
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
536
|
+
*
|
|
537
|
+
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
538
|
+
*/
|
|
539
|
+
HTML_DRAFT = "HTML_DRAFT",
|
|
540
|
+
/**
|
|
541
|
+
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
542
|
+
* Will be accessible from Site List and will not have a website app.
|
|
543
|
+
* Once the user attaches a site, the site will become a regular wixsite.
|
|
544
|
+
*/
|
|
545
|
+
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
546
|
+
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
547
|
+
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
548
|
+
/** It is to be used in the Business First efforts. */
|
|
549
|
+
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
550
|
+
/** Bookings business flow with no site. */
|
|
551
|
+
ANYWHERE = "ANYWHERE",
|
|
552
|
+
/** Namespace for Headless Backoffice with no editor */
|
|
553
|
+
HEADLESS = "HEADLESS",
|
|
554
|
+
/**
|
|
555
|
+
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
556
|
+
* The site will be used for account level CSM feature for enterprise
|
|
557
|
+
*/
|
|
558
|
+
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
559
|
+
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
560
|
+
RISE = "RISE",
|
|
561
|
+
/**
|
|
562
|
+
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
563
|
+
* There's a blank site behind the scene but it's blank).
|
|
564
|
+
* The Mobile company will be the owner of this namespace.
|
|
565
|
+
*/
|
|
566
|
+
BRANDED_FIRST = "BRANDED_FIRST",
|
|
567
|
+
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
568
|
+
NOWNIA = "NOWNIA",
|
|
569
|
+
/**
|
|
570
|
+
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
571
|
+
* The Partners company owns this namespace.
|
|
572
|
+
*/
|
|
573
|
+
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
574
|
+
/** Codux Headless Sites */
|
|
575
|
+
CODUX = "CODUX",
|
|
576
|
+
/** Bobb - AI Design Creator. */
|
|
577
|
+
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
578
|
+
/**
|
|
579
|
+
* Shared Blog Site is a unique single site across Enterprise account,
|
|
580
|
+
* This site will hold all Blog posts related to the Marketing product.
|
|
581
|
+
*/
|
|
582
|
+
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
583
|
+
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
584
|
+
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
585
|
+
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
586
|
+
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
587
|
+
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
588
|
+
MIMIR = "MIMIR",
|
|
589
|
+
/** Wix Twins platform. */
|
|
590
|
+
TWINS = "TWINS",
|
|
591
|
+
/** Wix Nano. */
|
|
592
|
+
NANO = "NANO"
|
|
593
|
+
}
|
|
594
|
+
/** @enumType */
|
|
595
|
+
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';
|
|
596
|
+
/** Site transferred to another user. */
|
|
597
|
+
interface SiteTransferred {
|
|
598
|
+
/**
|
|
599
|
+
* A previous owner id (user that transfers meta site).
|
|
600
|
+
* @format GUID
|
|
601
|
+
*/
|
|
602
|
+
oldOwnerId?: string;
|
|
603
|
+
/**
|
|
604
|
+
* A new owner id (user that accepts meta site).
|
|
605
|
+
* @format GUID
|
|
606
|
+
*/
|
|
607
|
+
newOwnerId?: string;
|
|
608
|
+
}
|
|
609
|
+
/** Soft deletion of the meta site. Could be restored. */
|
|
610
|
+
interface SiteDeleted {
|
|
611
|
+
/** A deletion context. */
|
|
612
|
+
deleteContext?: DeleteContext;
|
|
613
|
+
}
|
|
614
|
+
interface DeleteContext {
|
|
615
|
+
/** When the meta site was deleted. */
|
|
616
|
+
dateDeleted?: Date | null;
|
|
617
|
+
/** A status. */
|
|
618
|
+
deleteStatus?: DeleteStatusWithLiterals;
|
|
619
|
+
/**
|
|
620
|
+
* A reason (flow).
|
|
621
|
+
* @maxLength 255
|
|
622
|
+
*/
|
|
623
|
+
deleteOrigin?: string;
|
|
624
|
+
/**
|
|
625
|
+
* A service that deleted it.
|
|
626
|
+
* @maxLength 255
|
|
627
|
+
*/
|
|
628
|
+
initiatorId?: string | null;
|
|
629
|
+
}
|
|
630
|
+
declare enum DeleteStatus {
|
|
631
|
+
UNKNOWN = "UNKNOWN",
|
|
632
|
+
TRASH = "TRASH",
|
|
633
|
+
DELETED = "DELETED",
|
|
634
|
+
PENDING_PURGE = "PENDING_PURGE",
|
|
635
|
+
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
636
|
+
}
|
|
637
|
+
/** @enumType */
|
|
638
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
639
|
+
/** Restoration of the meta site. */
|
|
640
|
+
interface SiteUndeleted {
|
|
641
|
+
}
|
|
642
|
+
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
643
|
+
interface SitePublished {
|
|
644
|
+
}
|
|
645
|
+
interface SiteUnpublished {
|
|
646
|
+
/**
|
|
647
|
+
* A list of URLs previously associated with the meta site.
|
|
648
|
+
* @maxLength 4000
|
|
649
|
+
* @maxSize 10000
|
|
650
|
+
*/
|
|
651
|
+
urls?: string[];
|
|
652
|
+
}
|
|
653
|
+
interface SiteMarkedAsTemplate {
|
|
654
|
+
}
|
|
655
|
+
interface SiteMarkedAsWixSite {
|
|
656
|
+
}
|
|
657
|
+
/**
|
|
658
|
+
* Represents a service provisioned a site.
|
|
659
|
+
*
|
|
660
|
+
* Note on `origin_instance_id`:
|
|
661
|
+
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
662
|
+
* This is because of the following scenario:
|
|
663
|
+
*
|
|
664
|
+
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
665
|
+
* such as a product catalog. When you create a site from this template, you inherit this
|
|
666
|
+
* default product catalog. However, if the template's product catalog is modified,
|
|
667
|
+
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
668
|
+
* your site remains consistent with what you initially received and does not include any
|
|
669
|
+
* changes made to the original template afterward.
|
|
670
|
+
* To ensure this, the TPA on the template gets a new instance_id.
|
|
671
|
+
*/
|
|
672
|
+
interface ServiceProvisioned {
|
|
673
|
+
/**
|
|
674
|
+
* Either UUID or EmbeddedServiceType.
|
|
675
|
+
* @maxLength 36
|
|
676
|
+
*/
|
|
677
|
+
appDefId?: string;
|
|
678
|
+
/**
|
|
679
|
+
* Not only UUID. Something here could be something weird.
|
|
680
|
+
* @maxLength 36
|
|
681
|
+
*/
|
|
682
|
+
instanceId?: string;
|
|
683
|
+
/**
|
|
684
|
+
* An instance id from which this instance is originated.
|
|
685
|
+
* @maxLength 36
|
|
686
|
+
*/
|
|
687
|
+
originInstanceId?: string;
|
|
688
|
+
/**
|
|
689
|
+
* A version.
|
|
690
|
+
* @maxLength 500
|
|
691
|
+
*/
|
|
692
|
+
version?: string | null;
|
|
693
|
+
/**
|
|
694
|
+
* The origin meta site id
|
|
695
|
+
* @format GUID
|
|
696
|
+
*/
|
|
697
|
+
originMetaSiteId?: string | null;
|
|
698
|
+
}
|
|
699
|
+
interface ServiceRemoved {
|
|
700
|
+
/**
|
|
701
|
+
* Either UUID or EmbeddedServiceType.
|
|
702
|
+
* @maxLength 36
|
|
703
|
+
*/
|
|
704
|
+
appDefId?: string;
|
|
705
|
+
/**
|
|
706
|
+
* Not only UUID. Something here could be something weird.
|
|
707
|
+
* @maxLength 36
|
|
708
|
+
*/
|
|
709
|
+
instanceId?: string;
|
|
710
|
+
/**
|
|
711
|
+
* A version.
|
|
712
|
+
* @maxLength 500
|
|
713
|
+
*/
|
|
714
|
+
version?: string | null;
|
|
715
|
+
}
|
|
716
|
+
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
717
|
+
interface SiteRenamed {
|
|
718
|
+
/**
|
|
719
|
+
* A new meta site name (URL slug).
|
|
720
|
+
* @maxLength 20
|
|
721
|
+
*/
|
|
722
|
+
newSiteName?: string;
|
|
723
|
+
/**
|
|
724
|
+
* A previous meta site name (URL slug).
|
|
725
|
+
* @maxLength 255
|
|
726
|
+
*/
|
|
727
|
+
oldSiteName?: string;
|
|
728
|
+
}
|
|
729
|
+
/**
|
|
730
|
+
* Hard deletion of the meta site.
|
|
731
|
+
*
|
|
732
|
+
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
733
|
+
*/
|
|
734
|
+
interface SiteHardDeleted {
|
|
735
|
+
/** A deletion context. */
|
|
736
|
+
deleteContext?: DeleteContext;
|
|
737
|
+
}
|
|
738
|
+
interface NamespaceChanged {
|
|
739
|
+
/** A previous namespace. */
|
|
740
|
+
oldNamespace?: NamespaceWithLiterals;
|
|
741
|
+
/** A new namespace. */
|
|
742
|
+
newNamespace?: NamespaceWithLiterals;
|
|
743
|
+
}
|
|
744
|
+
/** Assigned Studio editor */
|
|
745
|
+
interface StudioAssigned {
|
|
746
|
+
}
|
|
747
|
+
/** Unassigned Studio editor */
|
|
748
|
+
interface StudioUnassigned {
|
|
749
|
+
}
|
|
750
|
+
/**
|
|
751
|
+
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
752
|
+
*
|
|
753
|
+
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
754
|
+
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
755
|
+
*
|
|
756
|
+
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
757
|
+
*/
|
|
758
|
+
interface SiteUrlChanged {
|
|
759
|
+
}
|
|
760
|
+
/**
|
|
761
|
+
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
762
|
+
* Consumed by other teams to remove relevant data.
|
|
763
|
+
*/
|
|
764
|
+
interface SitePurgedExternally {
|
|
765
|
+
/**
|
|
766
|
+
* @maxLength 2048
|
|
767
|
+
* @maxSize 100
|
|
768
|
+
* @deprecated
|
|
769
|
+
* @targetRemovalDate 2025-04-15
|
|
770
|
+
*/
|
|
771
|
+
appDefId?: string[];
|
|
772
|
+
}
|
|
773
|
+
/** Assigned Odeditor */
|
|
774
|
+
interface OdeditorAssigned {
|
|
775
|
+
}
|
|
776
|
+
/** Unassigned Odeditor */
|
|
777
|
+
interface OdeditorUnassigned {
|
|
778
|
+
}
|
|
779
|
+
/** Assigned Picasso editor */
|
|
780
|
+
interface PicassoAssigned {
|
|
781
|
+
}
|
|
782
|
+
/** Unassigned Picasso */
|
|
783
|
+
interface PicassoUnassigned {
|
|
784
|
+
}
|
|
273
785
|
interface SetDefaultBranchRequest {
|
|
274
786
|
/**
|
|
275
|
-
* Branch
|
|
787
|
+
* Branch ID.
|
|
276
788
|
* @format GUID
|
|
277
789
|
*/
|
|
278
790
|
branchId: string;
|
|
@@ -287,6 +799,184 @@ interface GetDefaultBranchResponse {
|
|
|
287
799
|
/** Default branch. */
|
|
288
800
|
branch?: Branch;
|
|
289
801
|
}
|
|
802
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
803
|
+
createdEvent?: EntityCreatedEvent;
|
|
804
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
805
|
+
deletedEvent?: EntityDeletedEvent;
|
|
806
|
+
actionEvent?: ActionEvent;
|
|
807
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
808
|
+
id?: string;
|
|
809
|
+
/**
|
|
810
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
811
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
812
|
+
*/
|
|
813
|
+
entityFqdn?: string;
|
|
814
|
+
/**
|
|
815
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
816
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
817
|
+
*/
|
|
818
|
+
slug?: string;
|
|
819
|
+
/** ID of the entity associated with the event. */
|
|
820
|
+
entityId?: string;
|
|
821
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
822
|
+
eventTime?: Date | null;
|
|
823
|
+
/**
|
|
824
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
825
|
+
* (for example, GDPR).
|
|
826
|
+
*/
|
|
827
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
828
|
+
/** If present, indicates the action that triggered the event. */
|
|
829
|
+
originatedFrom?: string | null;
|
|
830
|
+
/**
|
|
831
|
+
* 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.
|
|
832
|
+
* 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.
|
|
833
|
+
*/
|
|
834
|
+
entityEventSequence?: string | null;
|
|
835
|
+
}
|
|
836
|
+
/** @oneof */
|
|
837
|
+
interface DomainEventBodyOneOf {
|
|
838
|
+
createdEvent?: EntityCreatedEvent;
|
|
839
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
840
|
+
deletedEvent?: EntityDeletedEvent;
|
|
841
|
+
actionEvent?: ActionEvent;
|
|
842
|
+
}
|
|
843
|
+
interface EntityCreatedEvent {
|
|
844
|
+
entityAsJson?: string;
|
|
845
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
846
|
+
restoreInfo?: RestoreInfo;
|
|
847
|
+
}
|
|
848
|
+
interface RestoreInfo {
|
|
849
|
+
deletedDate?: Date | null;
|
|
850
|
+
}
|
|
851
|
+
interface EntityUpdatedEvent {
|
|
852
|
+
/**
|
|
853
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
854
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
855
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
856
|
+
*/
|
|
857
|
+
currentEntityAsJson?: string;
|
|
858
|
+
}
|
|
859
|
+
interface EntityDeletedEvent {
|
|
860
|
+
/** Entity that was deleted. */
|
|
861
|
+
deletedEntityAsJson?: string | null;
|
|
862
|
+
}
|
|
863
|
+
interface ActionEvent {
|
|
864
|
+
bodyAsJson?: string;
|
|
865
|
+
}
|
|
866
|
+
interface MessageEnvelope {
|
|
867
|
+
/**
|
|
868
|
+
* App instance ID.
|
|
869
|
+
* @format GUID
|
|
870
|
+
*/
|
|
871
|
+
instanceId?: string | null;
|
|
872
|
+
/**
|
|
873
|
+
* Event type.
|
|
874
|
+
* @maxLength 150
|
|
875
|
+
*/
|
|
876
|
+
eventType?: string;
|
|
877
|
+
/** The identification type and identity data. */
|
|
878
|
+
identity?: IdentificationData;
|
|
879
|
+
/** Stringify payload. */
|
|
880
|
+
data?: string;
|
|
881
|
+
}
|
|
882
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
883
|
+
/**
|
|
884
|
+
* ID of a site visitor that has not logged in to the site.
|
|
885
|
+
* @format GUID
|
|
886
|
+
*/
|
|
887
|
+
anonymousVisitorId?: string;
|
|
888
|
+
/**
|
|
889
|
+
* ID of a site visitor that has logged in to the site.
|
|
890
|
+
* @format GUID
|
|
891
|
+
*/
|
|
892
|
+
memberId?: string;
|
|
893
|
+
/**
|
|
894
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
895
|
+
* @format GUID
|
|
896
|
+
*/
|
|
897
|
+
wixUserId?: string;
|
|
898
|
+
/**
|
|
899
|
+
* ID of an app.
|
|
900
|
+
* @format GUID
|
|
901
|
+
*/
|
|
902
|
+
appId?: string;
|
|
903
|
+
/** @readonly */
|
|
904
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
905
|
+
}
|
|
906
|
+
/** @oneof */
|
|
907
|
+
interface IdentificationDataIdOneOf {
|
|
908
|
+
/**
|
|
909
|
+
* ID of a site visitor that has not logged in to the site.
|
|
910
|
+
* @format GUID
|
|
911
|
+
*/
|
|
912
|
+
anonymousVisitorId?: string;
|
|
913
|
+
/**
|
|
914
|
+
* ID of a site visitor that has logged in to the site.
|
|
915
|
+
* @format GUID
|
|
916
|
+
*/
|
|
917
|
+
memberId?: string;
|
|
918
|
+
/**
|
|
919
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
920
|
+
* @format GUID
|
|
921
|
+
*/
|
|
922
|
+
wixUserId?: string;
|
|
923
|
+
/**
|
|
924
|
+
* ID of an app.
|
|
925
|
+
* @format GUID
|
|
926
|
+
*/
|
|
927
|
+
appId?: string;
|
|
928
|
+
}
|
|
929
|
+
declare enum WebhookIdentityType {
|
|
930
|
+
UNKNOWN = "UNKNOWN",
|
|
931
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
932
|
+
MEMBER = "MEMBER",
|
|
933
|
+
WIX_USER = "WIX_USER",
|
|
934
|
+
APP = "APP"
|
|
935
|
+
}
|
|
936
|
+
/** @enumType */
|
|
937
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
938
|
+
/** @docsIgnore */
|
|
939
|
+
type CreateBranchApplicationErrors = {
|
|
940
|
+
code?: 'SOURCE_BRANCH_NOT_FOUND';
|
|
941
|
+
description?: string;
|
|
942
|
+
data?: Record<string, any>;
|
|
943
|
+
} | {
|
|
944
|
+
code?: 'TEMPLATE_ID_NOT_SUPPORTED';
|
|
945
|
+
description?: string;
|
|
946
|
+
data?: Record<string, any>;
|
|
947
|
+
} | {
|
|
948
|
+
code?: 'ORIGINAL_BRANCH_ALREADY_EXISTS';
|
|
949
|
+
description?: string;
|
|
950
|
+
data?: Record<string, any>;
|
|
951
|
+
} | {
|
|
952
|
+
code?: 'TARGET_BRANCH_SITE_HEADER_ALREADY_EXISTS';
|
|
953
|
+
description?: string;
|
|
954
|
+
data?: Record<string, any>;
|
|
955
|
+
} | {
|
|
956
|
+
code?: 'ILLEGAL_SOURCE_TYPE';
|
|
957
|
+
description?: string;
|
|
958
|
+
data?: Record<string, any>;
|
|
959
|
+
} | {
|
|
960
|
+
code?: 'SOURCE_USER_BRANCH_DOES_NOT_EXIST';
|
|
961
|
+
description?: string;
|
|
962
|
+
data?: Record<string, any>;
|
|
963
|
+
};
|
|
964
|
+
/** @docsIgnore */
|
|
965
|
+
type UpdateBranchApplicationErrors = {
|
|
966
|
+
code?: 'FORBIDDEN_UPDATE_ORIGINAL_BRANCH_TYPE';
|
|
967
|
+
description?: string;
|
|
968
|
+
data?: Record<string, any>;
|
|
969
|
+
};
|
|
970
|
+
/** @docsIgnore */
|
|
971
|
+
type DeleteBranchApplicationErrors = {
|
|
972
|
+
code?: 'BRANCH_NOT_FOUND';
|
|
973
|
+
description?: string;
|
|
974
|
+
data?: Record<string, any>;
|
|
975
|
+
} | {
|
|
976
|
+
code?: 'FORBIDDEN_DELETE_ORIGINAL_BRANCH';
|
|
977
|
+
description?: string;
|
|
978
|
+
data?: Record<string, any>;
|
|
979
|
+
};
|
|
290
980
|
|
|
291
981
|
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
292
982
|
getUrl: (context: any) => string;
|
|
@@ -314,4 +1004,4 @@ declare function setDefaultBranch(): __PublicMethodMetaInfo<'POST', {
|
|
|
314
1004
|
}, SetDefaultBranchRequest$1, SetDefaultBranchRequest, SetDefaultBranchResponse$1, SetDefaultBranchResponse>;
|
|
315
1005
|
declare function getDefaultBranch(): __PublicMethodMetaInfo<'GET', {}, GetDefaultBranchRequest$1, GetDefaultBranchRequest, GetDefaultBranchResponse$1, GetDefaultBranchResponse>;
|
|
316
1006
|
|
|
317
|
-
export { type __PublicMethodMetaInfo, createBranch, deleteBranch, getBranch, getDefaultBranch, queryBranches, setDefaultBranch, updateBranch };
|
|
1007
|
+
export { type ActionEvent as ActionEventOriginal, type Asset as AssetOriginal, type Branch as BranchOriginal, type BranchSourceOneOf as BranchSourceOneOfOriginal, type CreateBranchApplicationErrors as CreateBranchApplicationErrorsOriginal, type CreateBranchRequest as CreateBranchRequestOriginal, type CreateBranchResponse as CreateBranchResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type DeleteBranchApplicationErrors as DeleteBranchApplicationErrorsOriginal, type DeleteBranchRequest as DeleteBranchRequestOriginal, type DeleteBranchResponse as DeleteBranchResponseOriginal, type DeleteContext as DeleteContextOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, EditorTypeOptions as EditorTypeOptionsOriginal, type EditorTypeOptionsWithLiterals as EditorTypeOptionsWithLiteralsOriginal, type EditorType as EditorTypeOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type GetBranchRequest as GetBranchRequestOriginal, type GetBranchResponse as GetBranchResponseOriginal, type GetDefaultBranchRequest as GetDefaultBranchRequestOriginal, type GetDefaultBranchResponse as GetDefaultBranchResponseOriginal, type HtmlSitePublished as HtmlSitePublishedOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, type Page as PageOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, type QueryBranchesRequest as QueryBranchesRequestOriginal, type QueryBranchesResponse as QueryBranchesResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type SetDefaultBranchRequest as SetDefaultBranchRequestOriginal, type SetDefaultBranchResponse as SetDefaultBranchResponseOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type SourceBranch as SourceBranchOriginal, type SourceTemplate as SourceTemplateOriginal, SourceType as SourceTypeOriginal, type SourceTypeWithLiterals as SourceTypeWithLiteralsOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, type UpdateBranchApplicationErrors as UpdateBranchApplicationErrorsOriginal, type UpdateBranchRequest as UpdateBranchRequestOriginal, type UpdateBranchResponse as UpdateBranchResponseOriginal, type UpdateExtendedFieldsRequest as UpdateExtendedFieldsRequestOriginal, type UpdateExtendedFieldsResponse as UpdateExtendedFieldsResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, createBranch, deleteBranch, getBranch, getDefaultBranch, queryBranches, setDefaultBranch, updateBranch };
|