@wix/auto_sdk_members_members 1.0.71 → 1.0.73
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/meta.d.ts +932 -1
- package/build/cjs/meta.js +121 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/es/meta.d.mts +932 -1
- package/build/es/meta.mjs +111 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/meta.d.ts +932 -1
- package/build/internal/cjs/meta.js +121 -0
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/meta.d.mts +932 -1
- package/build/internal/es/meta.mjs +111 -0
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +3 -3
package/build/cjs/meta.d.ts
CHANGED
|
@@ -249,6 +249,132 @@ declare enum ActivityStatusStatus {
|
|
|
249
249
|
}
|
|
250
250
|
/** @enumType */
|
|
251
251
|
type ActivityStatusStatusWithLiterals = ActivityStatusStatus | 'UNKNOWN' | 'ACTIVE' | 'MUTED';
|
|
252
|
+
interface ExtendedFields {
|
|
253
|
+
/**
|
|
254
|
+
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
255
|
+
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
256
|
+
*
|
|
257
|
+
* You can only access fields for which you have the appropriate permissions.
|
|
258
|
+
*
|
|
259
|
+
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
260
|
+
*/
|
|
261
|
+
namespaces?: Record<string, Record<string, any>>;
|
|
262
|
+
}
|
|
263
|
+
interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
264
|
+
/**
|
|
265
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
266
|
+
* @format GUID
|
|
267
|
+
*/
|
|
268
|
+
metaSiteId?: string;
|
|
269
|
+
/**
|
|
270
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
271
|
+
* @format GUID
|
|
272
|
+
*/
|
|
273
|
+
siteId?: string;
|
|
274
|
+
/** Invalidate by App */
|
|
275
|
+
app?: App;
|
|
276
|
+
/** Invalidate by page id */
|
|
277
|
+
page?: Page;
|
|
278
|
+
/** Invalidate by URI path */
|
|
279
|
+
uri?: URI;
|
|
280
|
+
/** Invalidate by file (for media files such as PDFs) */
|
|
281
|
+
file?: File;
|
|
282
|
+
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
283
|
+
customTag?: CustomTag;
|
|
284
|
+
/**
|
|
285
|
+
* tell us why you're invalidating the cache. You don't need to add your app name
|
|
286
|
+
* @maxLength 256
|
|
287
|
+
*/
|
|
288
|
+
reason?: string | null;
|
|
289
|
+
/** Is local DS */
|
|
290
|
+
localDc?: boolean;
|
|
291
|
+
hardPurge?: boolean;
|
|
292
|
+
}
|
|
293
|
+
/** @oneof */
|
|
294
|
+
interface InvalidateCacheGetByOneOf {
|
|
295
|
+
/**
|
|
296
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
297
|
+
* @format GUID
|
|
298
|
+
*/
|
|
299
|
+
metaSiteId?: string;
|
|
300
|
+
/**
|
|
301
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
302
|
+
* @format GUID
|
|
303
|
+
*/
|
|
304
|
+
siteId?: string;
|
|
305
|
+
/** Invalidate by App */
|
|
306
|
+
app?: App;
|
|
307
|
+
/** Invalidate by page id */
|
|
308
|
+
page?: Page;
|
|
309
|
+
/** Invalidate by URI path */
|
|
310
|
+
uri?: URI;
|
|
311
|
+
/** Invalidate by file (for media files such as PDFs) */
|
|
312
|
+
file?: File;
|
|
313
|
+
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
314
|
+
customTag?: CustomTag;
|
|
315
|
+
}
|
|
316
|
+
interface App {
|
|
317
|
+
/**
|
|
318
|
+
* The AppDefId
|
|
319
|
+
* @minLength 1
|
|
320
|
+
*/
|
|
321
|
+
appDefId?: string;
|
|
322
|
+
/**
|
|
323
|
+
* The instance Id
|
|
324
|
+
* @format GUID
|
|
325
|
+
*/
|
|
326
|
+
instanceId?: string;
|
|
327
|
+
}
|
|
328
|
+
interface Page {
|
|
329
|
+
/**
|
|
330
|
+
* the msid the page is on
|
|
331
|
+
* @format GUID
|
|
332
|
+
*/
|
|
333
|
+
metaSiteId?: string;
|
|
334
|
+
/**
|
|
335
|
+
* Invalidate by Page ID
|
|
336
|
+
* @minLength 1
|
|
337
|
+
*/
|
|
338
|
+
pageId?: string;
|
|
339
|
+
}
|
|
340
|
+
interface URI {
|
|
341
|
+
/**
|
|
342
|
+
* the msid the URI is on
|
|
343
|
+
* @format GUID
|
|
344
|
+
*/
|
|
345
|
+
metaSiteId?: string;
|
|
346
|
+
/**
|
|
347
|
+
* URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
348
|
+
* @minLength 1
|
|
349
|
+
*/
|
|
350
|
+
uriPath?: string;
|
|
351
|
+
}
|
|
352
|
+
interface File {
|
|
353
|
+
/**
|
|
354
|
+
* the msid the file is related to
|
|
355
|
+
* @format GUID
|
|
356
|
+
*/
|
|
357
|
+
metaSiteId?: string;
|
|
358
|
+
/**
|
|
359
|
+
* Invalidate by filename (for media files such as PDFs)
|
|
360
|
+
* @minLength 1
|
|
361
|
+
* @maxLength 256
|
|
362
|
+
*/
|
|
363
|
+
fileName?: string;
|
|
364
|
+
}
|
|
365
|
+
interface CustomTag {
|
|
366
|
+
/**
|
|
367
|
+
* the msid the tag is related to
|
|
368
|
+
* @format GUID
|
|
369
|
+
*/
|
|
370
|
+
metaSiteId?: string;
|
|
371
|
+
/**
|
|
372
|
+
* Tag to invalidate by
|
|
373
|
+
* @minLength 1
|
|
374
|
+
* @maxLength 256
|
|
375
|
+
*/
|
|
376
|
+
tag?: string;
|
|
377
|
+
}
|
|
252
378
|
interface UpdateMySlugRequest {
|
|
253
379
|
/**
|
|
254
380
|
* New slug.
|
|
@@ -260,6 +386,9 @@ interface UpdateMySlugResponse {
|
|
|
260
386
|
/** Updated member. */
|
|
261
387
|
member?: Member;
|
|
262
388
|
}
|
|
389
|
+
interface SlugAlreadyExistsPayload {
|
|
390
|
+
slug?: string;
|
|
391
|
+
}
|
|
263
392
|
interface UpdateMemberSlugRequest {
|
|
264
393
|
/**
|
|
265
394
|
* Member ID.
|
|
@@ -283,6 +412,14 @@ interface JoinCommunityResponse {
|
|
|
283
412
|
/** The updated member. */
|
|
284
413
|
member?: Member;
|
|
285
414
|
}
|
|
415
|
+
interface MemberJoinedCommunity {
|
|
416
|
+
/**
|
|
417
|
+
* ID of the member who joined the community.
|
|
418
|
+
* @format GUID
|
|
419
|
+
* @readonly
|
|
420
|
+
*/
|
|
421
|
+
memberId?: string;
|
|
422
|
+
}
|
|
286
423
|
interface LeaveCommunityRequest {
|
|
287
424
|
}
|
|
288
425
|
/** Member profile. */
|
|
@@ -290,6 +427,14 @@ interface LeaveCommunityResponse {
|
|
|
290
427
|
/** The updated member. */
|
|
291
428
|
member?: Member;
|
|
292
429
|
}
|
|
430
|
+
interface MemberLeftCommunity {
|
|
431
|
+
/**
|
|
432
|
+
* ID of the site member who left the community.
|
|
433
|
+
* @format GUID
|
|
434
|
+
* @readonly
|
|
435
|
+
*/
|
|
436
|
+
memberId?: string;
|
|
437
|
+
}
|
|
293
438
|
interface GetMyMemberRequest {
|
|
294
439
|
/**
|
|
295
440
|
* Predefined set of fields to return.
|
|
@@ -335,6 +480,13 @@ interface GetMemberResponse {
|
|
|
335
480
|
/** The requested member. */
|
|
336
481
|
member?: Member;
|
|
337
482
|
}
|
|
483
|
+
interface MemberToMemberBlockedPayload {
|
|
484
|
+
/**
|
|
485
|
+
* Member ID.
|
|
486
|
+
* @format GUID
|
|
487
|
+
*/
|
|
488
|
+
memberId?: string;
|
|
489
|
+
}
|
|
338
490
|
interface ListMembersRequest {
|
|
339
491
|
paging?: Paging;
|
|
340
492
|
/**
|
|
@@ -367,6 +519,21 @@ declare enum SortOrder {
|
|
|
367
519
|
}
|
|
368
520
|
/** @enumType */
|
|
369
521
|
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
522
|
+
interface CursorPaging {
|
|
523
|
+
/**
|
|
524
|
+
* Maximum number of items to return in the results.
|
|
525
|
+
* @max 100
|
|
526
|
+
*/
|
|
527
|
+
limit?: number | null;
|
|
528
|
+
/**
|
|
529
|
+
* Pointer to the next or previous page in the list of results.
|
|
530
|
+
*
|
|
531
|
+
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
532
|
+
* Not relevant for the first request.
|
|
533
|
+
* @maxLength 16000
|
|
534
|
+
*/
|
|
535
|
+
cursor?: string | null;
|
|
536
|
+
}
|
|
370
537
|
interface ListMembersResponse {
|
|
371
538
|
/** List of members. */
|
|
372
539
|
members?: Member[];
|
|
@@ -383,6 +550,31 @@ interface PagingMetadata {
|
|
|
383
550
|
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
384
551
|
tooManyToCount?: boolean | null;
|
|
385
552
|
}
|
|
553
|
+
interface CursorPagingMetadata {
|
|
554
|
+
/** Number of items returned in the response. */
|
|
555
|
+
count?: number | null;
|
|
556
|
+
/** Cursor strings that point to the next page, previous page, or both. */
|
|
557
|
+
cursors?: Cursors;
|
|
558
|
+
/**
|
|
559
|
+
* Whether there are more pages to retrieve following the current page.
|
|
560
|
+
*
|
|
561
|
+
* + `true`: Another page of results can be retrieved.
|
|
562
|
+
* + `false`: This is the last page.
|
|
563
|
+
*/
|
|
564
|
+
hasNext?: boolean | null;
|
|
565
|
+
}
|
|
566
|
+
interface Cursors {
|
|
567
|
+
/**
|
|
568
|
+
* Cursor string pointing to the next page in the list of results.
|
|
569
|
+
* @maxLength 16000
|
|
570
|
+
*/
|
|
571
|
+
next?: string | null;
|
|
572
|
+
/**
|
|
573
|
+
* Cursor pointing to the previous page in the list of results.
|
|
574
|
+
* @maxLength 16000
|
|
575
|
+
*/
|
|
576
|
+
prev?: string | null;
|
|
577
|
+
}
|
|
386
578
|
interface QueryMembersRequest {
|
|
387
579
|
/** Query options. */
|
|
388
580
|
query?: Query;
|
|
@@ -444,6 +636,14 @@ interface MuteMemberResponse {
|
|
|
444
636
|
/** Muted member. */
|
|
445
637
|
member?: Member;
|
|
446
638
|
}
|
|
639
|
+
interface MemberMuted {
|
|
640
|
+
/**
|
|
641
|
+
* ID of the member who got muted.
|
|
642
|
+
* @format GUID
|
|
643
|
+
* @readonly
|
|
644
|
+
*/
|
|
645
|
+
memberId?: string;
|
|
646
|
+
}
|
|
447
647
|
interface UnmuteMemberRequest {
|
|
448
648
|
/**
|
|
449
649
|
* ID of the member to unmute.
|
|
@@ -455,6 +655,14 @@ interface UnmuteMemberResponse {
|
|
|
455
655
|
/** Unmuted member. */
|
|
456
656
|
member?: Member;
|
|
457
657
|
}
|
|
658
|
+
interface MemberUnmuted {
|
|
659
|
+
/**
|
|
660
|
+
* ID of the member who got unmuted.
|
|
661
|
+
* @format GUID
|
|
662
|
+
* @readonly
|
|
663
|
+
*/
|
|
664
|
+
memberId?: string;
|
|
665
|
+
}
|
|
458
666
|
interface ApproveMemberRequest {
|
|
459
667
|
/**
|
|
460
668
|
* ID of the member to approve.
|
|
@@ -466,6 +674,14 @@ interface ApproveMemberResponse {
|
|
|
466
674
|
/** Approved member. */
|
|
467
675
|
member?: Member;
|
|
468
676
|
}
|
|
677
|
+
interface MemberApproved {
|
|
678
|
+
/**
|
|
679
|
+
* ID of the member who got approved.
|
|
680
|
+
* @format GUID
|
|
681
|
+
* @readonly
|
|
682
|
+
*/
|
|
683
|
+
memberId?: string;
|
|
684
|
+
}
|
|
469
685
|
interface BlockMemberRequest {
|
|
470
686
|
/**
|
|
471
687
|
* ID of a member to block.
|
|
@@ -477,6 +693,35 @@ interface BlockMemberResponse {
|
|
|
477
693
|
/** Blocked member. */
|
|
478
694
|
member?: Member;
|
|
479
695
|
}
|
|
696
|
+
interface MemberBlocked {
|
|
697
|
+
/**
|
|
698
|
+
* ID of the member who got blocked.
|
|
699
|
+
* @format GUID
|
|
700
|
+
* @readonly
|
|
701
|
+
*/
|
|
702
|
+
memberId?: string;
|
|
703
|
+
}
|
|
704
|
+
interface MemberSelfBlockForbiddenPayload {
|
|
705
|
+
/**
|
|
706
|
+
* Target's member ID.
|
|
707
|
+
* @format GUID
|
|
708
|
+
*/
|
|
709
|
+
memberId?: string;
|
|
710
|
+
}
|
|
711
|
+
interface OwnerMemberBlockForbiddenPayload {
|
|
712
|
+
/**
|
|
713
|
+
* Owner's member ID.
|
|
714
|
+
* @format GUID
|
|
715
|
+
*/
|
|
716
|
+
memberId?: string;
|
|
717
|
+
}
|
|
718
|
+
interface ActiveSubscriptionMemberBlockForbiddenPayload {
|
|
719
|
+
/**
|
|
720
|
+
* Active subscription member ID.
|
|
721
|
+
* @format GUID
|
|
722
|
+
*/
|
|
723
|
+
memberId?: string;
|
|
724
|
+
}
|
|
480
725
|
interface DisconnectMemberRequest {
|
|
481
726
|
/**
|
|
482
727
|
* ID of a member to disconnect.
|
|
@@ -497,6 +742,27 @@ interface DeleteMemberRequest {
|
|
|
497
742
|
}
|
|
498
743
|
interface DeleteMemberResponse {
|
|
499
744
|
}
|
|
745
|
+
interface ContentReassignmentRequested {
|
|
746
|
+
fromMember?: Member;
|
|
747
|
+
toMember?: Member;
|
|
748
|
+
}
|
|
749
|
+
interface ContentDeletionRequested {
|
|
750
|
+
member?: Member;
|
|
751
|
+
}
|
|
752
|
+
interface OwnerOrContributorDeleteForbiddenPayload {
|
|
753
|
+
/**
|
|
754
|
+
* Owner's or contributor's member ID.
|
|
755
|
+
* @format GUID
|
|
756
|
+
*/
|
|
757
|
+
memberId?: string;
|
|
758
|
+
}
|
|
759
|
+
interface ActiveSubscriptionMemberDeleteForbiddenPayload {
|
|
760
|
+
/**
|
|
761
|
+
* Active subscription member ID.
|
|
762
|
+
* @format GUID
|
|
763
|
+
*/
|
|
764
|
+
memberId?: string;
|
|
765
|
+
}
|
|
500
766
|
interface DeleteMyMemberRequest {
|
|
501
767
|
/**
|
|
502
768
|
* ID of a member receiving the deleted member's content.
|
|
@@ -609,6 +875,10 @@ interface UpdateMemberResponse {
|
|
|
609
875
|
/** Updated member. */
|
|
610
876
|
member?: Member;
|
|
611
877
|
}
|
|
878
|
+
interface InvalidCustomFieldUrlPayload {
|
|
879
|
+
/** Custom field key and invalid URL. */
|
|
880
|
+
fields?: Record<string, string>;
|
|
881
|
+
}
|
|
612
882
|
interface DeleteMemberPhonesRequest {
|
|
613
883
|
/**
|
|
614
884
|
* ID of the member whose phone numbers will be deleted.
|
|
@@ -642,6 +912,667 @@ interface DeleteMemberAddressesResponse {
|
|
|
642
912
|
/** Updated member. */
|
|
643
913
|
member?: Member;
|
|
644
914
|
}
|
|
915
|
+
interface Empty {
|
|
916
|
+
}
|
|
917
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
918
|
+
createdEvent?: EntityCreatedEvent;
|
|
919
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
920
|
+
deletedEvent?: EntityDeletedEvent;
|
|
921
|
+
actionEvent?: ActionEvent;
|
|
922
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
923
|
+
id?: string;
|
|
924
|
+
/**
|
|
925
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
926
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
927
|
+
*/
|
|
928
|
+
entityFqdn?: string;
|
|
929
|
+
/**
|
|
930
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
931
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
932
|
+
*/
|
|
933
|
+
slug?: string;
|
|
934
|
+
/** ID of the entity associated with the event. */
|
|
935
|
+
entityId?: string;
|
|
936
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
937
|
+
eventTime?: Date | null;
|
|
938
|
+
/**
|
|
939
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
940
|
+
* (for example, GDPR).
|
|
941
|
+
*/
|
|
942
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
943
|
+
/** If present, indicates the action that triggered the event. */
|
|
944
|
+
originatedFrom?: string | null;
|
|
945
|
+
/**
|
|
946
|
+
* 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.
|
|
947
|
+
* 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.
|
|
948
|
+
*/
|
|
949
|
+
entityEventSequence?: string | null;
|
|
950
|
+
}
|
|
951
|
+
/** @oneof */
|
|
952
|
+
interface DomainEventBodyOneOf {
|
|
953
|
+
createdEvent?: EntityCreatedEvent;
|
|
954
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
955
|
+
deletedEvent?: EntityDeletedEvent;
|
|
956
|
+
actionEvent?: ActionEvent;
|
|
957
|
+
}
|
|
958
|
+
interface EntityCreatedEvent {
|
|
959
|
+
entityAsJson?: string;
|
|
960
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
961
|
+
restoreInfo?: RestoreInfo;
|
|
962
|
+
}
|
|
963
|
+
interface RestoreInfo {
|
|
964
|
+
deletedDate?: Date | null;
|
|
965
|
+
}
|
|
966
|
+
interface EntityUpdatedEvent {
|
|
967
|
+
/**
|
|
968
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
969
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
970
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
971
|
+
*/
|
|
972
|
+
currentEntityAsJson?: string;
|
|
973
|
+
}
|
|
974
|
+
interface EntityDeletedEvent {
|
|
975
|
+
/** Entity that was deleted. */
|
|
976
|
+
deletedEntityAsJson?: string | null;
|
|
977
|
+
}
|
|
978
|
+
interface ActionEvent {
|
|
979
|
+
bodyAsJson?: string;
|
|
980
|
+
}
|
|
981
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
982
|
+
/** Emitted on a meta site creation. */
|
|
983
|
+
siteCreated?: SiteCreated;
|
|
984
|
+
/** Emitted on a meta site transfer completion. */
|
|
985
|
+
siteTransferred?: SiteTransferred;
|
|
986
|
+
/** Emitted on a meta site deletion. */
|
|
987
|
+
siteDeleted?: SiteDeleted;
|
|
988
|
+
/** Emitted on a meta site restoration. */
|
|
989
|
+
siteUndeleted?: SiteUndeleted;
|
|
990
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
991
|
+
sitePublished?: SitePublished;
|
|
992
|
+
/** Emitted on a meta site unpublish. */
|
|
993
|
+
siteUnpublished?: SiteUnpublished;
|
|
994
|
+
/** Emitted when meta site is marked as template. */
|
|
995
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
996
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
997
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
998
|
+
/** Emitted when an application is provisioned (installed). */
|
|
999
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
1000
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
1001
|
+
serviceRemoved?: ServiceRemoved;
|
|
1002
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
1003
|
+
siteRenamedPayload?: SiteRenamed;
|
|
1004
|
+
/** Emitted when meta site was permanently deleted. */
|
|
1005
|
+
hardDeleted?: SiteHardDeleted;
|
|
1006
|
+
/** Emitted on a namespace change. */
|
|
1007
|
+
namespaceChanged?: NamespaceChanged;
|
|
1008
|
+
/** Emitted when Studio is attached. */
|
|
1009
|
+
studioAssigned?: StudioAssigned;
|
|
1010
|
+
/** Emitted when Studio is detached. */
|
|
1011
|
+
studioUnassigned?: StudioUnassigned;
|
|
1012
|
+
/**
|
|
1013
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
1014
|
+
* the actual URL.
|
|
1015
|
+
*
|
|
1016
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
1017
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
1018
|
+
*/
|
|
1019
|
+
urlChanged?: SiteUrlChanged;
|
|
1020
|
+
/** Site is marked as PurgedExternally */
|
|
1021
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
1022
|
+
/** Emitted when Odeditor is attached. */
|
|
1023
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
1024
|
+
/** Emitted when Odeditor is detached. */
|
|
1025
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
1026
|
+
/** Emitted when Picasso is attached. */
|
|
1027
|
+
picassoAssigned?: PicassoAssigned;
|
|
1028
|
+
/** Emitted when Picasso is detached. */
|
|
1029
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
1030
|
+
/**
|
|
1031
|
+
* A meta site id.
|
|
1032
|
+
* @format GUID
|
|
1033
|
+
*/
|
|
1034
|
+
metaSiteId?: string;
|
|
1035
|
+
/** A meta site version. Monotonically increasing. */
|
|
1036
|
+
version?: string;
|
|
1037
|
+
/** A timestamp of the event. */
|
|
1038
|
+
timestamp?: string;
|
|
1039
|
+
/**
|
|
1040
|
+
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
1041
|
+
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
1042
|
+
* @maxSize 4000
|
|
1043
|
+
*/
|
|
1044
|
+
assets?: Asset[];
|
|
1045
|
+
}
|
|
1046
|
+
/** @oneof */
|
|
1047
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
1048
|
+
/** Emitted on a meta site creation. */
|
|
1049
|
+
siteCreated?: SiteCreated;
|
|
1050
|
+
/** Emitted on a meta site transfer completion. */
|
|
1051
|
+
siteTransferred?: SiteTransferred;
|
|
1052
|
+
/** Emitted on a meta site deletion. */
|
|
1053
|
+
siteDeleted?: SiteDeleted;
|
|
1054
|
+
/** Emitted on a meta site restoration. */
|
|
1055
|
+
siteUndeleted?: SiteUndeleted;
|
|
1056
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
1057
|
+
sitePublished?: SitePublished;
|
|
1058
|
+
/** Emitted on a meta site unpublish. */
|
|
1059
|
+
siteUnpublished?: SiteUnpublished;
|
|
1060
|
+
/** Emitted when meta site is marked as template. */
|
|
1061
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
1062
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
1063
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
1064
|
+
/** Emitted when an application is provisioned (installed). */
|
|
1065
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
1066
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
1067
|
+
serviceRemoved?: ServiceRemoved;
|
|
1068
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
1069
|
+
siteRenamedPayload?: SiteRenamed;
|
|
1070
|
+
/** Emitted when meta site was permanently deleted. */
|
|
1071
|
+
hardDeleted?: SiteHardDeleted;
|
|
1072
|
+
/** Emitted on a namespace change. */
|
|
1073
|
+
namespaceChanged?: NamespaceChanged;
|
|
1074
|
+
/** Emitted when Studio is attached. */
|
|
1075
|
+
studioAssigned?: StudioAssigned;
|
|
1076
|
+
/** Emitted when Studio is detached. */
|
|
1077
|
+
studioUnassigned?: StudioUnassigned;
|
|
1078
|
+
/**
|
|
1079
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
1080
|
+
* the actual URL.
|
|
1081
|
+
*
|
|
1082
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
1083
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
1084
|
+
*/
|
|
1085
|
+
urlChanged?: SiteUrlChanged;
|
|
1086
|
+
/** Site is marked as PurgedExternally */
|
|
1087
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
1088
|
+
/** Emitted when Odeditor is attached. */
|
|
1089
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
1090
|
+
/** Emitted when Odeditor is detached. */
|
|
1091
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
1092
|
+
/** Emitted when Picasso is attached. */
|
|
1093
|
+
picassoAssigned?: PicassoAssigned;
|
|
1094
|
+
/** Emitted when Picasso is detached. */
|
|
1095
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
1096
|
+
}
|
|
1097
|
+
interface Asset {
|
|
1098
|
+
/**
|
|
1099
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
1100
|
+
* @maxLength 36
|
|
1101
|
+
*/
|
|
1102
|
+
appDefId?: string;
|
|
1103
|
+
/**
|
|
1104
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
1105
|
+
* @maxLength 200
|
|
1106
|
+
*/
|
|
1107
|
+
instanceId?: string;
|
|
1108
|
+
/** An application state. */
|
|
1109
|
+
state?: StateWithLiterals;
|
|
1110
|
+
}
|
|
1111
|
+
declare enum State {
|
|
1112
|
+
UNKNOWN = "UNKNOWN",
|
|
1113
|
+
ENABLED = "ENABLED",
|
|
1114
|
+
DISABLED = "DISABLED",
|
|
1115
|
+
PENDING = "PENDING",
|
|
1116
|
+
DEMO = "DEMO"
|
|
1117
|
+
}
|
|
1118
|
+
/** @enumType */
|
|
1119
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
1120
|
+
interface SiteCreated {
|
|
1121
|
+
/**
|
|
1122
|
+
* A template identifier (empty if not created from a template).
|
|
1123
|
+
* @maxLength 36
|
|
1124
|
+
*/
|
|
1125
|
+
originTemplateId?: string;
|
|
1126
|
+
/**
|
|
1127
|
+
* An account id of the owner.
|
|
1128
|
+
* @format GUID
|
|
1129
|
+
*/
|
|
1130
|
+
ownerId?: string;
|
|
1131
|
+
/** A context in which meta site was created. */
|
|
1132
|
+
context?: SiteCreatedContextWithLiterals;
|
|
1133
|
+
/**
|
|
1134
|
+
* A meta site id from which this site was created.
|
|
1135
|
+
*
|
|
1136
|
+
* In case of a creation from a template it's a template id.
|
|
1137
|
+
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
1138
|
+
* @format GUID
|
|
1139
|
+
*/
|
|
1140
|
+
originMetaSiteId?: string | null;
|
|
1141
|
+
/**
|
|
1142
|
+
* A meta site name (URL slug).
|
|
1143
|
+
* @maxLength 20
|
|
1144
|
+
*/
|
|
1145
|
+
siteName?: string;
|
|
1146
|
+
/** A namespace. */
|
|
1147
|
+
namespace?: NamespaceWithLiterals;
|
|
1148
|
+
}
|
|
1149
|
+
declare enum SiteCreatedContext {
|
|
1150
|
+
/** A valid option, we don't expose all reasons why site might be created. */
|
|
1151
|
+
OTHER = "OTHER",
|
|
1152
|
+
/** A meta site was created from template. */
|
|
1153
|
+
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
1154
|
+
/** A meta site was created by copying of the transfferred meta site. */
|
|
1155
|
+
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
1156
|
+
/** A copy of existing meta site. */
|
|
1157
|
+
DUPLICATE = "DUPLICATE",
|
|
1158
|
+
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
1159
|
+
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
1160
|
+
/** deprecated A meta site was created for Flash editor. */
|
|
1161
|
+
FLASH = "FLASH"
|
|
1162
|
+
}
|
|
1163
|
+
/** @enumType */
|
|
1164
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
1165
|
+
declare enum Namespace {
|
|
1166
|
+
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
1167
|
+
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
1168
|
+
WIX = "WIX",
|
|
1169
|
+
/** 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. */
|
|
1170
|
+
SHOUT_OUT = "SHOUT_OUT",
|
|
1171
|
+
/** 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. */
|
|
1172
|
+
ALBUMS = "ALBUMS",
|
|
1173
|
+
/** 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. */
|
|
1174
|
+
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
1175
|
+
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1176
|
+
HOTELS = "HOTELS",
|
|
1177
|
+
/** 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. */
|
|
1178
|
+
CLUBS = "CLUBS",
|
|
1179
|
+
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1180
|
+
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
1181
|
+
/** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1182
|
+
DEV_SITE = "DEV_SITE",
|
|
1183
|
+
/** 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. */
|
|
1184
|
+
LOGOS = "LOGOS",
|
|
1185
|
+
/** 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. */
|
|
1186
|
+
VIDEO_MAKER = "VIDEO_MAKER",
|
|
1187
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1188
|
+
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
1189
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1190
|
+
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
1191
|
+
/**
|
|
1192
|
+
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
1193
|
+
*
|
|
1194
|
+
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
1195
|
+
*/
|
|
1196
|
+
HTML_DRAFT = "HTML_DRAFT",
|
|
1197
|
+
/**
|
|
1198
|
+
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
1199
|
+
* Will be accessible from Site List and will not have a website app.
|
|
1200
|
+
* Once the user attaches a site, the site will become a regular wixsite.
|
|
1201
|
+
*/
|
|
1202
|
+
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
1203
|
+
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
1204
|
+
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
1205
|
+
/** It is to be used in the Business First efforts. */
|
|
1206
|
+
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
1207
|
+
/** Bookings business flow with no site. */
|
|
1208
|
+
ANYWHERE = "ANYWHERE",
|
|
1209
|
+
/** Namespace for Headless Backoffice with no editor */
|
|
1210
|
+
HEADLESS = "HEADLESS",
|
|
1211
|
+
/**
|
|
1212
|
+
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
1213
|
+
* The site will be used for account level CSM feature for enterprise
|
|
1214
|
+
*/
|
|
1215
|
+
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
1216
|
+
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
1217
|
+
RISE = "RISE",
|
|
1218
|
+
/**
|
|
1219
|
+
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
1220
|
+
* There's a blank site behind the scene but it's blank).
|
|
1221
|
+
* The Mobile company will be the owner of this namespace.
|
|
1222
|
+
*/
|
|
1223
|
+
BRANDED_FIRST = "BRANDED_FIRST",
|
|
1224
|
+
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
1225
|
+
NOWNIA = "NOWNIA",
|
|
1226
|
+
/**
|
|
1227
|
+
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
1228
|
+
* The Partners company owns this namespace.
|
|
1229
|
+
*/
|
|
1230
|
+
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
1231
|
+
/** Codux Headless Sites */
|
|
1232
|
+
CODUX = "CODUX",
|
|
1233
|
+
/** Bobb - AI Design Creator. */
|
|
1234
|
+
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
1235
|
+
/**
|
|
1236
|
+
* Shared Blog Site is a unique single site across Enterprise account,
|
|
1237
|
+
* This site will hold all Blog posts related to the Marketing product.
|
|
1238
|
+
*/
|
|
1239
|
+
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
1240
|
+
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1241
|
+
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
1242
|
+
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1243
|
+
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
1244
|
+
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
1245
|
+
MIMIR = "MIMIR",
|
|
1246
|
+
/** Wix Twins platform. */
|
|
1247
|
+
TWINS = "TWINS",
|
|
1248
|
+
/** Wix Nano. */
|
|
1249
|
+
NANO = "NANO"
|
|
1250
|
+
}
|
|
1251
|
+
/** @enumType */
|
|
1252
|
+
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';
|
|
1253
|
+
/** Site transferred to another user. */
|
|
1254
|
+
interface SiteTransferred {
|
|
1255
|
+
/**
|
|
1256
|
+
* A previous owner id (user that transfers meta site).
|
|
1257
|
+
* @format GUID
|
|
1258
|
+
*/
|
|
1259
|
+
oldOwnerId?: string;
|
|
1260
|
+
/**
|
|
1261
|
+
* A new owner id (user that accepts meta site).
|
|
1262
|
+
* @format GUID
|
|
1263
|
+
*/
|
|
1264
|
+
newOwnerId?: string;
|
|
1265
|
+
}
|
|
1266
|
+
/** Soft deletion of the meta site. Could be restored. */
|
|
1267
|
+
interface SiteDeleted {
|
|
1268
|
+
/** A deletion context. */
|
|
1269
|
+
deleteContext?: DeleteContext;
|
|
1270
|
+
}
|
|
1271
|
+
interface DeleteContext {
|
|
1272
|
+
/** When the meta site was deleted. */
|
|
1273
|
+
dateDeleted?: Date | null;
|
|
1274
|
+
/** A status. */
|
|
1275
|
+
deleteStatus?: DeleteStatusWithLiterals;
|
|
1276
|
+
/**
|
|
1277
|
+
* A reason (flow).
|
|
1278
|
+
* @maxLength 255
|
|
1279
|
+
*/
|
|
1280
|
+
deleteOrigin?: string;
|
|
1281
|
+
/**
|
|
1282
|
+
* A service that deleted it.
|
|
1283
|
+
* @maxLength 255
|
|
1284
|
+
*/
|
|
1285
|
+
initiatorId?: string | null;
|
|
1286
|
+
}
|
|
1287
|
+
declare enum DeleteStatus {
|
|
1288
|
+
UNKNOWN = "UNKNOWN",
|
|
1289
|
+
TRASH = "TRASH",
|
|
1290
|
+
DELETED = "DELETED",
|
|
1291
|
+
PENDING_PURGE = "PENDING_PURGE",
|
|
1292
|
+
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
1293
|
+
}
|
|
1294
|
+
/** @enumType */
|
|
1295
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
1296
|
+
/** Restoration of the meta site. */
|
|
1297
|
+
interface SiteUndeleted {
|
|
1298
|
+
}
|
|
1299
|
+
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
1300
|
+
interface SitePublished {
|
|
1301
|
+
}
|
|
1302
|
+
interface SiteUnpublished {
|
|
1303
|
+
/**
|
|
1304
|
+
* A list of URLs previously associated with the meta site.
|
|
1305
|
+
* @maxLength 4000
|
|
1306
|
+
* @maxSize 10000
|
|
1307
|
+
*/
|
|
1308
|
+
urls?: string[];
|
|
1309
|
+
}
|
|
1310
|
+
interface SiteMarkedAsTemplate {
|
|
1311
|
+
}
|
|
1312
|
+
interface SiteMarkedAsWixSite {
|
|
1313
|
+
}
|
|
1314
|
+
/**
|
|
1315
|
+
* Represents a service provisioned a site.
|
|
1316
|
+
*
|
|
1317
|
+
* Note on `origin_instance_id`:
|
|
1318
|
+
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
1319
|
+
* This is because of the following scenario:
|
|
1320
|
+
*
|
|
1321
|
+
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
1322
|
+
* such as a product catalog. When you create a site from this template, you inherit this
|
|
1323
|
+
* default product catalog. However, if the template's product catalog is modified,
|
|
1324
|
+
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
1325
|
+
* your site remains consistent with what you initially received and does not include any
|
|
1326
|
+
* changes made to the original template afterward.
|
|
1327
|
+
* To ensure this, the TPA on the template gets a new instance_id.
|
|
1328
|
+
*/
|
|
1329
|
+
interface ServiceProvisioned {
|
|
1330
|
+
/**
|
|
1331
|
+
* Either UUID or EmbeddedServiceType.
|
|
1332
|
+
* @maxLength 36
|
|
1333
|
+
*/
|
|
1334
|
+
appDefId?: string;
|
|
1335
|
+
/**
|
|
1336
|
+
* Not only UUID. Something here could be something weird.
|
|
1337
|
+
* @maxLength 36
|
|
1338
|
+
*/
|
|
1339
|
+
instanceId?: string;
|
|
1340
|
+
/**
|
|
1341
|
+
* An instance id from which this instance is originated.
|
|
1342
|
+
* @maxLength 36
|
|
1343
|
+
*/
|
|
1344
|
+
originInstanceId?: string;
|
|
1345
|
+
/**
|
|
1346
|
+
* A version.
|
|
1347
|
+
* @maxLength 500
|
|
1348
|
+
*/
|
|
1349
|
+
version?: string | null;
|
|
1350
|
+
/**
|
|
1351
|
+
* The origin meta site id
|
|
1352
|
+
* @format GUID
|
|
1353
|
+
*/
|
|
1354
|
+
originMetaSiteId?: string | null;
|
|
1355
|
+
}
|
|
1356
|
+
interface ServiceRemoved {
|
|
1357
|
+
/**
|
|
1358
|
+
* Either UUID or EmbeddedServiceType.
|
|
1359
|
+
* @maxLength 36
|
|
1360
|
+
*/
|
|
1361
|
+
appDefId?: string;
|
|
1362
|
+
/**
|
|
1363
|
+
* Not only UUID. Something here could be something weird.
|
|
1364
|
+
* @maxLength 36
|
|
1365
|
+
*/
|
|
1366
|
+
instanceId?: string;
|
|
1367
|
+
/**
|
|
1368
|
+
* A version.
|
|
1369
|
+
* @maxLength 500
|
|
1370
|
+
*/
|
|
1371
|
+
version?: string | null;
|
|
1372
|
+
}
|
|
1373
|
+
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
1374
|
+
interface SiteRenamed {
|
|
1375
|
+
/**
|
|
1376
|
+
* A new meta site name (URL slug).
|
|
1377
|
+
* @maxLength 20
|
|
1378
|
+
*/
|
|
1379
|
+
newSiteName?: string;
|
|
1380
|
+
/**
|
|
1381
|
+
* A previous meta site name (URL slug).
|
|
1382
|
+
* @maxLength 255
|
|
1383
|
+
*/
|
|
1384
|
+
oldSiteName?: string;
|
|
1385
|
+
}
|
|
1386
|
+
/**
|
|
1387
|
+
* Hard deletion of the meta site.
|
|
1388
|
+
*
|
|
1389
|
+
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
1390
|
+
*/
|
|
1391
|
+
interface SiteHardDeleted {
|
|
1392
|
+
/** A deletion context. */
|
|
1393
|
+
deleteContext?: DeleteContext;
|
|
1394
|
+
}
|
|
1395
|
+
interface NamespaceChanged {
|
|
1396
|
+
/** A previous namespace. */
|
|
1397
|
+
oldNamespace?: NamespaceWithLiterals;
|
|
1398
|
+
/** A new namespace. */
|
|
1399
|
+
newNamespace?: NamespaceWithLiterals;
|
|
1400
|
+
}
|
|
1401
|
+
/** Assigned Studio editor */
|
|
1402
|
+
interface StudioAssigned {
|
|
1403
|
+
}
|
|
1404
|
+
/** Unassigned Studio editor */
|
|
1405
|
+
interface StudioUnassigned {
|
|
1406
|
+
}
|
|
1407
|
+
/**
|
|
1408
|
+
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
1409
|
+
*
|
|
1410
|
+
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
1411
|
+
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
1412
|
+
*
|
|
1413
|
+
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
1414
|
+
*/
|
|
1415
|
+
interface SiteUrlChanged {
|
|
1416
|
+
}
|
|
1417
|
+
/**
|
|
1418
|
+
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
1419
|
+
* Consumed by other teams to remove relevant data.
|
|
1420
|
+
*/
|
|
1421
|
+
interface SitePurgedExternally {
|
|
1422
|
+
/**
|
|
1423
|
+
* @maxLength 2048
|
|
1424
|
+
* @maxSize 100
|
|
1425
|
+
* @deprecated
|
|
1426
|
+
* @targetRemovalDate 2025-04-15
|
|
1427
|
+
*/
|
|
1428
|
+
appDefId?: string[];
|
|
1429
|
+
}
|
|
1430
|
+
/** Assigned Odeditor */
|
|
1431
|
+
interface OdeditorAssigned {
|
|
1432
|
+
}
|
|
1433
|
+
/** Unassigned Odeditor */
|
|
1434
|
+
interface OdeditorUnassigned {
|
|
1435
|
+
}
|
|
1436
|
+
/** Assigned Picasso editor */
|
|
1437
|
+
interface PicassoAssigned {
|
|
1438
|
+
}
|
|
1439
|
+
/** Unassigned Picasso */
|
|
1440
|
+
interface PicassoUnassigned {
|
|
1441
|
+
}
|
|
1442
|
+
interface MemberOwnershipTransferred {
|
|
1443
|
+
fromMember?: Member;
|
|
1444
|
+
toMember?: Member;
|
|
1445
|
+
}
|
|
1446
|
+
interface MemberIdChanged {
|
|
1447
|
+
/** @format GUID */
|
|
1448
|
+
fromId?: string;
|
|
1449
|
+
/** @format GUID */
|
|
1450
|
+
toId?: string;
|
|
1451
|
+
}
|
|
1452
|
+
interface MessageEnvelope {
|
|
1453
|
+
/**
|
|
1454
|
+
* App instance ID.
|
|
1455
|
+
* @format GUID
|
|
1456
|
+
*/
|
|
1457
|
+
instanceId?: string | null;
|
|
1458
|
+
/**
|
|
1459
|
+
* Event type.
|
|
1460
|
+
* @maxLength 150
|
|
1461
|
+
*/
|
|
1462
|
+
eventType?: string;
|
|
1463
|
+
/** The identification type and identity data. */
|
|
1464
|
+
identity?: IdentificationData;
|
|
1465
|
+
/** Stringify payload. */
|
|
1466
|
+
data?: string;
|
|
1467
|
+
}
|
|
1468
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1469
|
+
/**
|
|
1470
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1471
|
+
* @format GUID
|
|
1472
|
+
*/
|
|
1473
|
+
anonymousVisitorId?: string;
|
|
1474
|
+
/**
|
|
1475
|
+
* ID of a site visitor that has logged in to the site.
|
|
1476
|
+
* @format GUID
|
|
1477
|
+
*/
|
|
1478
|
+
memberId?: string;
|
|
1479
|
+
/**
|
|
1480
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1481
|
+
* @format GUID
|
|
1482
|
+
*/
|
|
1483
|
+
wixUserId?: string;
|
|
1484
|
+
/**
|
|
1485
|
+
* ID of an app.
|
|
1486
|
+
* @format GUID
|
|
1487
|
+
*/
|
|
1488
|
+
appId?: string;
|
|
1489
|
+
/** @readonly */
|
|
1490
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1491
|
+
}
|
|
1492
|
+
/** @oneof */
|
|
1493
|
+
interface IdentificationDataIdOneOf {
|
|
1494
|
+
/**
|
|
1495
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1496
|
+
* @format GUID
|
|
1497
|
+
*/
|
|
1498
|
+
anonymousVisitorId?: string;
|
|
1499
|
+
/**
|
|
1500
|
+
* ID of a site visitor that has logged in to the site.
|
|
1501
|
+
* @format GUID
|
|
1502
|
+
*/
|
|
1503
|
+
memberId?: string;
|
|
1504
|
+
/**
|
|
1505
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1506
|
+
* @format GUID
|
|
1507
|
+
*/
|
|
1508
|
+
wixUserId?: string;
|
|
1509
|
+
/**
|
|
1510
|
+
* ID of an app.
|
|
1511
|
+
* @format GUID
|
|
1512
|
+
*/
|
|
1513
|
+
appId?: string;
|
|
1514
|
+
}
|
|
1515
|
+
declare enum WebhookIdentityType {
|
|
1516
|
+
UNKNOWN = "UNKNOWN",
|
|
1517
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1518
|
+
MEMBER = "MEMBER",
|
|
1519
|
+
WIX_USER = "WIX_USER",
|
|
1520
|
+
APP = "APP"
|
|
1521
|
+
}
|
|
1522
|
+
/** @enumType */
|
|
1523
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1524
|
+
/** @docsIgnore */
|
|
1525
|
+
type UpdateMySlugApplicationErrors = {
|
|
1526
|
+
code?: 'SLUG_ALREADY_EXISTS';
|
|
1527
|
+
description?: string;
|
|
1528
|
+
data?: SlugAlreadyExistsPayload;
|
|
1529
|
+
};
|
|
1530
|
+
/** @docsIgnore */
|
|
1531
|
+
type UpdateMemberSlugApplicationErrors = {
|
|
1532
|
+
code?: 'SLUG_ALREADY_EXISTS';
|
|
1533
|
+
description?: string;
|
|
1534
|
+
data?: SlugAlreadyExistsPayload;
|
|
1535
|
+
};
|
|
1536
|
+
/** @docsIgnore */
|
|
1537
|
+
type JoinCommunityApplicationErrors = {
|
|
1538
|
+
code?: 'COMMUNITY_JOIN_IMPOSSIBLE';
|
|
1539
|
+
description?: string;
|
|
1540
|
+
data?: Record<string, any>;
|
|
1541
|
+
};
|
|
1542
|
+
/** @docsIgnore */
|
|
1543
|
+
type GetMemberApplicationErrors = {
|
|
1544
|
+
code?: 'MEMBER_TO_MEMBER_BLOCKED';
|
|
1545
|
+
description?: string;
|
|
1546
|
+
data?: MemberToMemberBlockedPayload;
|
|
1547
|
+
};
|
|
1548
|
+
/** @docsIgnore */
|
|
1549
|
+
type BlockMemberApplicationErrors = {
|
|
1550
|
+
code?: 'MEMBER_SELF_BLOCK_FORBIDDEN';
|
|
1551
|
+
description?: string;
|
|
1552
|
+
data?: MemberSelfBlockForbiddenPayload;
|
|
1553
|
+
} | {
|
|
1554
|
+
code?: 'OWNER_MEMBER_BLOCK_FORBIDDEN';
|
|
1555
|
+
description?: string;
|
|
1556
|
+
data?: OwnerMemberBlockForbiddenPayload;
|
|
1557
|
+
} | {
|
|
1558
|
+
code?: 'ACTIVE_SUBSCRIPTION_MEMBER_BLOCK_FORBIDDEN';
|
|
1559
|
+
description?: string;
|
|
1560
|
+
data?: ActiveSubscriptionMemberBlockForbiddenPayload;
|
|
1561
|
+
};
|
|
1562
|
+
/** @docsIgnore */
|
|
1563
|
+
type DeleteMemberValidationErrors = {
|
|
1564
|
+
ruleName?: 'OWNER_OR_CONTRIBUTOR_MEMBER_DELETE_FORBIDDEN';
|
|
1565
|
+
} | {
|
|
1566
|
+
ruleName?: 'ACTIVE_SUBSCRIPTION_MEMBER_DELETE_FORBIDDEN';
|
|
1567
|
+
};
|
|
1568
|
+
/** @docsIgnore */
|
|
1569
|
+
type DeleteMyMemberValidationErrors = {
|
|
1570
|
+
ruleName?: 'OWNER_OR_CONTRIBUTOR_MEMBER_DELETE_FORBIDDEN';
|
|
1571
|
+
};
|
|
1572
|
+
/** @docsIgnore */
|
|
1573
|
+
type UpdateMemberValidationErrors = {
|
|
1574
|
+
ruleName?: 'INVALID_CUSTOM_FIELD_URL';
|
|
1575
|
+
};
|
|
645
1576
|
|
|
646
1577
|
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
647
1578
|
getUrl: (context: any) => string;
|
|
@@ -702,4 +1633,4 @@ declare function deleteMemberAddresses(): __PublicMethodMetaInfo<'DELETE', {
|
|
|
702
1633
|
id: string;
|
|
703
1634
|
}, DeleteMemberAddressesRequest$1, DeleteMemberAddressesRequest, DeleteMemberAddressesResponse$1, DeleteMemberAddressesResponse>;
|
|
704
1635
|
|
|
705
|
-
export { type __PublicMethodMetaInfo, approveMember, blockMember, bulkApproveMembers, bulkBlockMembers, bulkDeleteMembers, bulkDeleteMembersByFilter, createMember, deleteMember, deleteMemberAddresses, deleteMemberEmails, deleteMemberPhones, deleteMyMember, disconnectMember, getCurrentMember, getMember, joinCommunity, leaveCommunity, listMembers, muteMember, queryMembers, unmuteMember, updateCurrentMemberSlug, updateMember, updateMemberSlug };
|
|
1636
|
+
export { type ActionEvent as ActionEventOriginal, type ActiveSubscriptionMemberBlockForbiddenPayload as ActiveSubscriptionMemberBlockForbiddenPayloadOriginal, type ActiveSubscriptionMemberDeleteForbiddenPayload as ActiveSubscriptionMemberDeleteForbiddenPayloadOriginal, ActivityStatusStatus as ActivityStatusStatusOriginal, type ActivityStatusStatusWithLiterals as ActivityStatusStatusWithLiteralsOriginal, type Address as AddressOriginal, type AddressStreetOneOf as AddressStreetOneOfOriginal, type App as AppOriginal, type ApplicationError as ApplicationErrorOriginal, type ApproveMemberRequest as ApproveMemberRequestOriginal, type ApproveMemberResponse as ApproveMemberResponseOriginal, type Asset as AssetOriginal, type BlockMemberApplicationErrors as BlockMemberApplicationErrorsOriginal, type BlockMemberRequest as BlockMemberRequestOriginal, type BlockMemberResponse as BlockMemberResponseOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkApproveMembersRequest as BulkApproveMembersRequestOriginal, type BulkApproveMembersResponse as BulkApproveMembersResponseOriginal, type BulkBlockMembersRequest as BulkBlockMembersRequestOriginal, type BulkBlockMembersResponse as BulkBlockMembersResponseOriginal, type BulkDeleteMembersByFilterRequest as BulkDeleteMembersByFilterRequestOriginal, type BulkDeleteMembersByFilterResponse as BulkDeleteMembersByFilterResponseOriginal, type BulkDeleteMembersRequest as BulkDeleteMembersRequestOriginal, type BulkDeleteMembersResponse as BulkDeleteMembersResponseOriginal, type BulkMemberResult as BulkMemberResultOriginal, type Contact as ContactOriginal, type ContentDeletionRequested as ContentDeletionRequestedOriginal, type ContentReassignmentRequested as ContentReassignmentRequestedOriginal, type CreateMemberRequest as CreateMemberRequestOriginal, type CreateMemberResponse as CreateMemberResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type CustomField as CustomFieldOriginal, type CustomTag as CustomTagOriginal, type DeleteContext as DeleteContextOriginal, type DeleteMemberAddressesRequest as DeleteMemberAddressesRequestOriginal, type DeleteMemberAddressesResponse as DeleteMemberAddressesResponseOriginal, type DeleteMemberEmailsRequest as DeleteMemberEmailsRequestOriginal, type DeleteMemberEmailsResponse as DeleteMemberEmailsResponseOriginal, type DeleteMemberPhonesRequest as DeleteMemberPhonesRequestOriginal, type DeleteMemberPhonesResponse as DeleteMemberPhonesResponseOriginal, type DeleteMemberRequest as DeleteMemberRequestOriginal, type DeleteMemberResponse as DeleteMemberResponseOriginal, type DeleteMemberValidationErrors as DeleteMemberValidationErrorsOriginal, type DeleteMyMemberRequest as DeleteMyMemberRequestOriginal, type DeleteMyMemberResponse as DeleteMyMemberResponseOriginal, type DeleteMyMemberValidationErrors as DeleteMyMemberValidationErrorsOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DisconnectMemberRequest as DisconnectMemberRequestOriginal, type DisconnectMemberResponse as DisconnectMemberResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type File as FileOriginal, type GetMemberApplicationErrors as GetMemberApplicationErrorsOriginal, type GetMemberRequest as GetMemberRequestOriginal, type GetMemberResponse as GetMemberResponseOriginal, type GetMyMemberRequest as GetMyMemberRequestOriginal, type GetMyMemberResponse as GetMyMemberResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type InvalidCustomFieldUrlPayload as InvalidCustomFieldUrlPayloadOriginal, type InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOfOriginal, type InvalidateCache as InvalidateCacheOriginal, type ItemMetadata as ItemMetadataOriginal, type JoinCommunityApplicationErrors as JoinCommunityApplicationErrorsOriginal, type JoinCommunityRequest as JoinCommunityRequestOriginal, type JoinCommunityResponse as JoinCommunityResponseOriginal, type LeaveCommunityRequest as LeaveCommunityRequestOriginal, type LeaveCommunityResponse as LeaveCommunityResponseOriginal, type ListMembersRequest as ListMembersRequestOriginal, type ListMembersResponse as ListMembersResponseOriginal, type MemberApproved as MemberApprovedOriginal, type MemberBlocked as MemberBlockedOriginal, type MemberIdChanged as MemberIdChangedOriginal, type MemberJoinedCommunity as MemberJoinedCommunityOriginal, type MemberLeftCommunity as MemberLeftCommunityOriginal, type MemberMuted as MemberMutedOriginal, type Member as MemberOriginal, type MemberOwnershipTransferred as MemberOwnershipTransferredOriginal, type MemberSelfBlockForbiddenPayload as MemberSelfBlockForbiddenPayloadOriginal, type MemberToMemberBlockedPayload as MemberToMemberBlockedPayloadOriginal, type MemberUnmuted as MemberUnmutedOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type MuteMemberRequest as MuteMemberRequestOriginal, type MuteMemberResponse as MuteMemberResponseOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, type OwnerMemberBlockForbiddenPayload as OwnerMemberBlockForbiddenPayloadOriginal, type OwnerOrContributorDeleteForbiddenPayload as OwnerOrContributorDeleteForbiddenPayloadOriginal, type Page as PageOriginal, type PagingMetadata as PagingMetadataOriginal, type Paging as PagingOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, PrivacyStatusStatus as PrivacyStatusStatusOriginal, type PrivacyStatusStatusWithLiterals as PrivacyStatusStatusWithLiteralsOriginal, type Profile as ProfileOriginal, type QueryMembersRequest as QueryMembersRequestOriginal, type QueryMembersResponse as QueryMembersResponseOriginal, type Query as QueryOriginal, type RestoreInfo as RestoreInfoOriginal, type Search as SearchOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, Set as SetOriginal, type SetWithLiterals as SetWithLiteralsOriginal, 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, type SlugAlreadyExistsPayload as SlugAlreadyExistsPayloadOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type URI as URIOriginal, type UnmuteMemberRequest as UnmuteMemberRequestOriginal, type UnmuteMemberResponse as UnmuteMemberResponseOriginal, type UpdateMemberRequest as UpdateMemberRequestOriginal, type UpdateMemberResponse as UpdateMemberResponseOriginal, type UpdateMemberSlugApplicationErrors as UpdateMemberSlugApplicationErrorsOriginal, type UpdateMemberSlugRequest as UpdateMemberSlugRequestOriginal, type UpdateMemberSlugResponse as UpdateMemberSlugResponseOriginal, type UpdateMemberValidationErrors as UpdateMemberValidationErrorsOriginal, type UpdateMySlugApplicationErrors as UpdateMySlugApplicationErrorsOriginal, type UpdateMySlugRequest as UpdateMySlugRequestOriginal, type UpdateMySlugResponse as UpdateMySlugResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, approveMember, blockMember, bulkApproveMembers, bulkBlockMembers, bulkDeleteMembers, bulkDeleteMembersByFilter, createMember, deleteMember, deleteMemberAddresses, deleteMemberEmails, deleteMemberPhones, deleteMyMember, disconnectMember, getCurrentMember, getMember, joinCommunity, leaveCommunity, listMembers, muteMember, queryMembers, unmuteMember, updateCurrentMemberSlug, updateMember, updateMemberSlug };
|