@wix/auto_sdk_payments_payment-acceptance-configurations 1.0.30 → 1.0.31

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.
@@ -296,618 +296,190 @@ interface BulkUpdatePaymentAcceptanceConfigurationTagsByFilterResponse {
296
296
  }
297
297
  interface Empty {
298
298
  }
299
- interface MetaSiteFullEvent {
300
- /** The entire DTO, describing MetaSite. */
301
- metaSite?: MetaSite;
302
- /** The context of this event (create, update, delete). */
303
- context?: ContextWithLiterals;
299
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
300
+ /** Emitted on a meta site creation. */
301
+ siteCreated?: SiteCreated;
302
+ /** Emitted on a meta site transfer completion. */
303
+ siteTransferred?: SiteTransferred;
304
+ /** Emitted on a meta site deletion. */
305
+ siteDeleted?: SiteDeleted;
306
+ /** Emitted on a meta site restoration. */
307
+ siteUndeleted?: SiteUndeleted;
308
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
309
+ sitePublished?: SitePublished;
310
+ /** Emitted on a meta site unpublish. */
311
+ siteUnpublished?: SiteUnpublished;
312
+ /** Emitted when meta site is marked as template. */
313
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
314
+ /** Emitted when meta site is marked as a WixSite. */
315
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
316
+ /** Emitted when an application is provisioned (installed). */
317
+ serviceProvisioned?: ServiceProvisioned;
318
+ /** Emitted when an application is removed (uninstalled). */
319
+ serviceRemoved?: ServiceRemoved;
320
+ /** Emitted when meta site name (URL slug) is changed. */
321
+ siteRenamedPayload?: SiteRenamed;
322
+ /** Emitted when meta site was permanently deleted. */
323
+ hardDeleted?: SiteHardDeleted;
324
+ /** Emitted on a namespace change. */
325
+ namespaceChanged?: NamespaceChanged;
326
+ /** Emitted when Studio is attached. */
327
+ studioAssigned?: StudioAssigned;
328
+ /** Emitted when Studio is detached. */
329
+ studioUnassigned?: StudioUnassigned;
304
330
  /**
305
- * Events that triggered this event.
306
- * @maxSize 1000
331
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
332
+ * the actual URL.
333
+ *
334
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
335
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
307
336
  */
308
- events?: MetaSiteEvent[];
309
- }
310
- interface MetaSite {
337
+ urlChanged?: SiteUrlChanged;
338
+ /** Site is marked as PurgedExternally */
339
+ sitePurgedExternally?: SitePurgedExternally;
340
+ /** Emitted when Odeditor is attached. */
341
+ odeditorAssigned?: OdeditorAssigned;
342
+ /** Emitted when Odeditor is detached. */
343
+ odeditorUnassigned?: OdeditorUnassigned;
344
+ /** Emitted when Picasso is attached. */
345
+ picassoAssigned?: PicassoAssigned;
346
+ /** Emitted when Picasso is detached. */
347
+ picassoUnassigned?: PicassoUnassigned;
311
348
  /**
312
349
  * A meta site id.
313
350
  * @format GUID
314
351
  */
315
- _id?: string;
316
- /** A version. */
352
+ metaSiteId?: string;
353
+ /** A meta site version. Monotonically increasing. */
317
354
  version?: string;
355
+ /** A timestamp of the event. */
356
+ timestamp?: string;
318
357
  /**
319
- * TBD.
320
- * @format GUID
321
- */
322
- originTemplateId?: string | null;
323
- /**
324
- * An owner id.
325
- * @format GUID
326
- */
327
- ownerId?: string;
328
- /** A document type. */
329
- documentType?: DocumentTypeWithLiterals;
330
- /**
331
- * A site name (free URL slug). TODO(meta-site): Our actual limit is 20, but we have 1M+ meta sites with longer site name (44034 published).
332
- * @maxLength 255
333
- */
334
- name?: string;
335
- /** A date of creation. */
336
- dateCreated?: string;
337
- /** The last update date. */
338
- dateUpdated?: string;
339
- /**
340
- * Legacy.
341
- * @maxLength 255
342
- */
343
- description?: string | null;
344
- /**
345
- * Legacy.
346
- * @maxSize 10
347
- */
348
- premiumFeatures?: PremiumFeatureWithLiterals[];
349
- /**
350
- * A favicon file name.
351
- * @maxLength 255
352
- */
353
- favicon?: string | null;
354
- /**
355
- * A list of domains.
356
- * @maxSize 1000
357
- */
358
- domains?: Domain[];
359
- /**
360
- * A list of renderers.
361
- * @maxSize 100
362
- */
363
- applications?: Application[];
364
- /**
365
- * A list of apps.
366
- * @maxSize 500
367
- */
368
- embeddedServices?: EmbeddedService[];
369
- /** A default SEO data. */
370
- defaultSeoData?: SeoData;
371
- /** google.protobuf.StringValue published_base_uri = 16; */
372
- wixSiteProperties?: WixSiteProperties;
373
- /**
374
- * A list of entry points.
375
- * @maxSize 10000
376
- */
377
- entryPoints?: EntryPoint[];
378
- /**
379
- * A list of aliases.
380
- * @maxSize 10000
381
- */
382
- aliases?: EntryPoint[];
383
- /**
384
- * A namespace (empty or 1 element always).
385
- * @maxSize 1
386
- */
387
- namespaces?: NamespaceWithLiterals[];
388
- /**
389
- * A list of flags.
390
- * @maxSize 100
391
- */
392
- flags?: FlagWithLiterals[];
393
- /**
394
- * Deprecated.
395
- * @maxSize 10000
396
- * @deprecated
397
- * @replacedBy redirector-server
398
- * @targetRemovalDate 2024-12-31
399
- */
400
- externalUriMappings?: ExternalUriMapping[];
401
- /** Indicates whether a meta site is published (accessible from router-server). */
402
- published?: boolean;
403
- /**
404
- * bool dirty_routes = 24;
405
- * bool dirty_meta_data = 25;
406
- */
407
- pendingApps?: PendingApps;
408
- /**
409
- * TBD.
410
- * @readonly
411
- * @format GUID
412
- */
413
- devSiteAppDefId?: string | null;
414
- /** ML. */
415
- languages?: SiteLanguages;
416
- /** A delete context. */
417
- deleteContext?: DeleteContext;
418
- /** TBD. */
419
- publishedHtmlSiteRevision?: string;
420
- /** A cached data from Routes API. */
421
- routesApiData?: RoutesApiData;
422
- /**
423
- * A date of creation of the account that owns this meta site.
424
- * @readonly
425
- */
426
- accountCreatedDate?: Date | null;
427
- }
428
- declare enum DocumentType {
429
- UNKNOWN_DOCUMENT_TYPE = "UNKNOWN_DOCUMENT_TYPE",
430
- /** User Generated Content - user site */
431
- UGC = "UGC",
432
- /** Sites used for template */
433
- TEMPLATE = "TEMPLATE",
434
- /** Wix's Landing Pages, marketing pages, Wix Home Page etc. */
435
- WIX_SITE = "WIX_SITE"
436
- }
437
- /** @enumType */
438
- type DocumentTypeWithLiterals = DocumentType | 'UNKNOWN_DOCUMENT_TYPE' | 'UGC' | 'TEMPLATE' | 'WIX_SITE';
439
- declare enum PremiumFeature {
440
- UNKNOWN_PREMIUM_FEATURE = "UNKNOWN_PREMIUM_FEATURE",
441
- SHOW_WIX_WHILE_LOADING = "SHOW_WIX_WHILE_LOADING",
442
- ADS_FREE = "ADS_FREE",
443
- HAS_ECOMMERCE = "HAS_ECOMMERCE",
444
- HAS_DOMAIN = "HAS_DOMAIN",
445
- ALWAYS_SHOW_FOOTER = "ALWAYS_SHOW_FOOTER",
446
- NO_ADS_IN_SOCIAL_SITES = "NO_ADS_IN_SOCIAL_SITES"
447
- }
448
- /** @enumType */
449
- type PremiumFeatureWithLiterals = PremiumFeature | 'UNKNOWN_PREMIUM_FEATURE' | 'SHOW_WIX_WHILE_LOADING' | 'ADS_FREE' | 'HAS_ECOMMERCE' | 'HAS_DOMAIN' | 'ALWAYS_SHOW_FOOTER' | 'NO_ADS_IN_SOCIAL_SITES';
450
- interface Domain {
451
- /**
452
- * A domain name.
453
- * @maxLength 253
454
- */
455
- name?: string;
456
- /** Indicates whether the domain is primary. */
457
- primary?: boolean;
458
- /** Indicates whether the domain should have "www." prefix. */
459
- hasWwwPrefix?: boolean;
460
- /** An SEO data. */
461
- trackingData?: TrackingData;
462
- /**
463
- * A registrar.
464
- * @maxLength 255
358
+ * TODO(meta-site): Change validation once validations are disabled for consumers
359
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
360
+ * @maxSize 4000
465
361
  */
466
- registrar?: string;
362
+ assets?: Asset[];
467
363
  }
468
- interface TrackingData {
469
- /**
470
- * Google Analytics ID.
471
- * @maxLength 255
472
- */
473
- googleAnalyticsId?: string | null;
474
- /**
475
- * Google Site verification code.
476
- * @maxLength 255
477
- */
478
- googleSiteVerificationCode?: string | null;
479
- /**
480
- * Google Remarketing ID.
481
- * @maxLength 255
482
- */
483
- googleRemarketingId?: string | null;
484
- /**
485
- * Facebook Remarketing ID.
486
- * @maxLength 255
487
- */
488
- facebookRemarketingId?: string | null;
489
- /**
490
- * Yandex Metrica ID.
491
- * @maxLength 255
492
- */
493
- yandexMetrikaId?: string | null;
364
+ /** @oneof */
365
+ interface MetaSiteSpecialEventPayloadOneOf {
366
+ /** Emitted on a meta site creation. */
367
+ siteCreated?: SiteCreated;
368
+ /** Emitted on a meta site transfer completion. */
369
+ siteTransferred?: SiteTransferred;
370
+ /** Emitted on a meta site deletion. */
371
+ siteDeleted?: SiteDeleted;
372
+ /** Emitted on a meta site restoration. */
373
+ siteUndeleted?: SiteUndeleted;
374
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
375
+ sitePublished?: SitePublished;
376
+ /** Emitted on a meta site unpublish. */
377
+ siteUnpublished?: SiteUnpublished;
378
+ /** Emitted when meta site is marked as template. */
379
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
380
+ /** Emitted when meta site is marked as a WixSite. */
381
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
382
+ /** Emitted when an application is provisioned (installed). */
383
+ serviceProvisioned?: ServiceProvisioned;
384
+ /** Emitted when an application is removed (uninstalled). */
385
+ serviceRemoved?: ServiceRemoved;
386
+ /** Emitted when meta site name (URL slug) is changed. */
387
+ siteRenamedPayload?: SiteRenamed;
388
+ /** Emitted when meta site was permanently deleted. */
389
+ hardDeleted?: SiteHardDeleted;
390
+ /** Emitted on a namespace change. */
391
+ namespaceChanged?: NamespaceChanged;
392
+ /** Emitted when Studio is attached. */
393
+ studioAssigned?: StudioAssigned;
394
+ /** Emitted when Studio is detached. */
395
+ studioUnassigned?: StudioUnassigned;
494
396
  /**
495
- * TBD.
496
- * @maxLength 255
397
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
398
+ * the actual URL.
399
+ *
400
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
401
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
497
402
  */
498
- ipAnonymization?: string | null;
403
+ urlChanged?: SiteUrlChanged;
404
+ /** Site is marked as PurgedExternally */
405
+ sitePurgedExternally?: SitePurgedExternally;
406
+ /** Emitted when Odeditor is attached. */
407
+ odeditorAssigned?: OdeditorAssigned;
408
+ /** Emitted when Odeditor is detached. */
409
+ odeditorUnassigned?: OdeditorUnassigned;
410
+ /** Emitted when Picasso is attached. */
411
+ picassoAssigned?: PicassoAssigned;
412
+ /** Emitted when Picasso is detached. */
413
+ picassoUnassigned?: PicassoUnassigned;
499
414
  }
500
- /** Renderer representation in meta site model (determines to which renderer to call when the request comes to public) */
501
- interface Application {
502
- /** Deprecated. */
503
- intId?: number;
504
- /**
505
- * An instance id. TODO(meta-site): Remove WixLists!!!
506
- * @maxLength 160
507
- */
508
- instanceId?: string;
415
+ interface Asset {
509
416
  /**
510
- * An instance id of a template from which this instance was cloned.
417
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
511
418
  * @maxLength 36
512
419
  */
513
- templateIdInApp?: string | null;
514
- /**
515
- * A language code.
516
- * @maxLength 5
517
- */
518
- languageCode?: string;
519
- /** An application (renderer) type. */
520
- applicationType?: ApplicationTypeWithLiterals;
521
- /** TDB. */
522
- compatibility?: CompatibilityWithLiterals;
523
- /**
524
- * TDB.
525
- * @maxLength 255
526
- */
527
- supportedView?: string;
528
- /** An SEO data. */
529
- seoData?: SeoData;
530
- /** A date of creation. */
531
- dateCreated?: string;
532
- /** A date of the last update. */
533
- dateUpdated?: string;
534
- /** Indicates whether this instance was published (WixApplication SPI is called). */
535
- published?: boolean;
536
- /** An application state. Effectively unused. */
537
- state?: ApiStateWithLiterals;
538
- /**
539
- * TDB.
540
- * @maxLength 255
541
- */
542
- thumbnail?: string | null;
543
- /**
544
- * A list of mappings.
545
- * @maxSize 100
546
- */
547
- urlMappings?: UrlMapping[];
548
- }
549
- declare enum ApplicationType {
550
- UNKNOWN_APPLICATION_TYPE = "UNKNOWN_APPLICATION_TYPE",
551
- FLASH = "FLASH",
552
- FLASH_FACEBOOK = "FLASH_FACEBOOK",
553
- FLASH_WIDGET = "FLASH_WIDGET",
554
- FLASH_BANNER = "FLASH_BANNER",
555
- HTML_MOBILE = "HTML_MOBILE",
556
- HTML_WEB = "HTML_WEB",
557
- HTML_FACEBOOK = "HTML_FACEBOOK",
558
- BLOG = "BLOG",
559
- WIX_LISTS = "WIX_LISTS",
560
- /** Used only for wix sites used only. Basically proxy the request to the source outside of Wix. */
561
- STATIC_MOUNT = "STATIC_MOUNT",
562
- /** Used only for wix sites used only. Basically redirects the request to the source outside of Wix */
563
- STATIC_MOUNT_REDIRECT = "STATIC_MOUNT_REDIRECT",
564
- AMP_BLOG = "AMP_BLOG",
565
- COMMUNITIES_AMP_BLOG = "COMMUNITIES_AMP_BLOG",
566
- HTML_ANYWHERE = "HTML_ANYWHERE",
567
- HOPP = "HOPP"
568
- }
569
- /** @enumType */
570
- type ApplicationTypeWithLiterals = ApplicationType | 'UNKNOWN_APPLICATION_TYPE' | 'FLASH' | 'FLASH_FACEBOOK' | 'FLASH_WIDGET' | 'FLASH_BANNER' | 'HTML_MOBILE' | 'HTML_WEB' | 'HTML_FACEBOOK' | 'BLOG' | 'WIX_LISTS' | 'STATIC_MOUNT' | 'STATIC_MOUNT_REDIRECT' | 'AMP_BLOG' | 'COMMUNITIES_AMP_BLOG' | 'HTML_ANYWHERE' | 'HOPP';
571
- declare enum Compatibility {
572
- UNKNOWN_COMPATIBILITY = "UNKNOWN_COMPATIBILITY",
573
- WEB = "WEB",
574
- MOBILE = "MOBILE",
575
- ALL = "ALL"
576
- }
577
- /** @enumType */
578
- type CompatibilityWithLiterals = Compatibility | 'UNKNOWN_COMPATIBILITY' | 'WEB' | 'MOBILE' | 'ALL';
579
- interface SeoData {
580
- /**
581
- * A title.
582
- * @maxLength 255
583
- */
584
- title?: string | null;
585
- /** Indicates whether the site should be indexable by bots. */
586
- indexable?: boolean;
587
- /** TDB. */
588
- suppressTrackingCookies?: boolean;
589
- /**
590
- * TDB.
591
- * @maxLength 300
592
- */
593
- ogImage?: string | null;
594
- /**
595
- * A list of meta tags.
596
- * @maxSize 100
597
- */
598
- metaTags?: MetaTag[];
599
- /**
600
- * A canonical URL for a site.
601
- * @maxLength 4000
602
- */
603
- canonicalUrl?: string | null;
604
- }
605
- interface MetaTag {
606
- /**
607
- * A name.
608
- * @maxLength 50
609
- */
610
- name?: string;
611
- /**
612
- * A value.
613
- * @maxLength 500
614
- */
615
- value?: string;
616
- /** Indicates whether should be rendered as property. */
617
- property?: boolean;
618
- }
619
- declare enum ApiState {
620
- UNKNOWN_STATE = "UNKNOWN_STATE",
621
- TEMPLATE = "TEMPLATE",
622
- STUB = "STUB",
623
- INITIALIZED = "INITIALIZED"
624
- }
625
- /** @enumType */
626
- type ApiStateWithLiterals = ApiState | 'UNKNOWN_STATE' | 'TEMPLATE' | 'STUB' | 'INITIALIZED';
627
- interface UrlMapping {
628
- /**
629
- * A host.
630
- * @maxLength 253
631
- */
632
- host?: string | null;
420
+ appDefId?: string;
633
421
  /**
634
- * An URI.
635
- * @maxLength 4000
636
- */
637
- uri?: string;
638
- }
639
- interface EmbeddedService extends EmbeddedServiceAttributesOneOf {
640
- /** Deprecated. */
641
- appBuilder?: AppBuilderAttributes;
642
- /** Site members (wix-sm-webapp). */
643
- siteMembers?: SiteMembersAttributes;
644
- /** Deprecated. */
645
- listsApps?: ListsAppsAttributes;
646
- /** ECommerceAttributes ecommerce = 13 [deprecated = true]; */
647
- thirdParty?: ThirdPartyAppsAttributes;
648
- /** Wix code (data). */
649
- wixCode?: WixCodeAttributes;
650
- /** Deprecated. */
651
- mobileApp?: MobileAppAttributes;
652
- /** ADI/Onboarding. */
653
- onboarding?: OnboardingAttributes;
654
- /** Clubs. */
655
- clubs?: ClubsAttributes;
656
- /** Contacts. */
657
- contacts?: ContactsAttributes;
658
- /** Deprecated? */
659
- providedMailingService?: ProvidedMailingServiceAttributes;
660
- /** Deprecated. */
661
- intId?: number;
662
- /**
663
- * An instance id.
664
- * @maxLength 36
422
+ * An instance id. For legacy reasons may be UUID or a string.
423
+ * @maxLength 200
665
424
  */
666
425
  instanceId?: string;
667
- /** A date of creation. */
668
- dateCreated?: string;
669
- /** A date of the last update. */
670
- dateUpdated?: string;
671
- /** A state. */
672
- state?: ApiStateWithLiterals;
673
- /**
674
- * for data sharing will hold the original instance id of the child site
675
- * @maxLength 36
676
- */
677
- nonSharedInstanceId?: string | null;
678
- }
679
- /** @oneof */
680
- interface EmbeddedServiceAttributesOneOf {
681
- /** Deprecated. */
682
- appBuilder?: AppBuilderAttributes;
683
- /** Site members (wix-sm-webapp). */
684
- siteMembers?: SiteMembersAttributes;
685
- /** Deprecated. */
686
- listsApps?: ListsAppsAttributes;
687
- /** ECommerceAttributes ecommerce = 13 [deprecated = true]; */
688
- thirdParty?: ThirdPartyAppsAttributes;
689
- /** Wix code (data). */
690
- wixCode?: WixCodeAttributes;
691
- /** Deprecated. */
692
- mobileApp?: MobileAppAttributes;
693
- /** ADI/Onboarding. */
694
- onboarding?: OnboardingAttributes;
695
- /** Clubs. */
696
- clubs?: ClubsAttributes;
697
- /** Contacts. */
698
- contacts?: ContactsAttributes;
699
- /** Deprecated? */
700
- providedMailingService?: ProvidedMailingServiceAttributes;
701
- }
702
- declare enum Kind {
703
- OPEN = "OPEN",
704
- CLOSED = "CLOSED",
705
- APPLY_FOR_MEMBERSHIP = "APPLY_FOR_MEMBERSHIP"
706
- }
707
- /** @enumType */
708
- type KindWithLiterals = Kind | 'OPEN' | 'CLOSED' | 'APPLY_FOR_MEMBERSHIP';
709
- declare enum FormFace {
710
- REGISTER = "REGISTER",
711
- LOGIN = "LOGIN"
426
+ /** An application state. */
427
+ state?: StateWithLiterals;
712
428
  }
713
- /** @enumType */
714
- type FormFaceWithLiterals = FormFace | 'REGISTER' | 'LOGIN';
715
- declare enum CollectionExposure {
716
- PUBLIC = "PUBLIC",
717
- WIX_INTERNAL = "WIX_INTERNAL"
429
+ declare enum State {
430
+ UNKNOWN = "UNKNOWN",
431
+ ENABLED = "ENABLED",
432
+ DISABLED = "DISABLED",
433
+ PENDING = "PENDING",
434
+ DEMO = "DEMO"
718
435
  }
719
436
  /** @enumType */
720
- type CollectionExposureWithLiterals = CollectionExposure | 'PUBLIC' | 'WIX_INTERNAL';
721
- interface MobileAppBannerInfo {
722
- /**
723
- * Deprecated.
724
- * @maxLength 255
725
- */
726
- name?: string;
727
- /**
728
- * Deprecated.
729
- * @maxLength 4000
730
- */
731
- iconUrl?: string;
732
- }
733
- interface AppBuilderAttributes {
734
- }
735
- interface SiteMembersAttributes {
736
- /** TDB. */
737
- kind?: KindWithLiterals;
738
- /** TDB. */
739
- formFace?: FormFaceWithLiterals;
740
- /** TDB. */
741
- collectionExposure?: CollectionExposureWithLiterals;
742
- }
743
- interface ListsAppsAttributes {
744
- /**
745
- * Deprecated.
746
- * @maxLength 36
747
- */
748
- appId?: string;
749
- /** Deprecated. */
750
- addedInEditor?: boolean | null;
751
- /** Deprecated. */
752
- visibleAtDashboard?: boolean | null;
753
- /**
754
- * Deprecated.
755
- * @maxLength 36
756
- */
757
- originInstanceId?: string | null;
758
- }
759
- interface ThirdPartyAppsAttributes {
760
- /**
761
- * An application definition id (app_id in dev-center).
762
- * @maxLength 36
763
- */
764
- appId?: string;
765
- /** Indicates whether a component was added in the editor. */
766
- addedInEditor?: boolean | null;
767
- /** Indicates whether an app should be hidden from the dashboard. */
768
- visibleAtDashboard?: boolean | null;
437
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
438
+ interface SiteCreated {
769
439
  /**
770
- * Identifier of the originating application.
440
+ * A template identifier (empty if not created from a template).
771
441
  * @maxLength 36
772
442
  */
773
- originInstanceId?: string | null;
774
- /**
775
- * If set -- indicates that it's premium.
776
- * @maxLength 255
777
- */
778
- vendorProductId?: string | null;
779
- /** TBD. */
780
- editorDismissed?: boolean | null;
781
- /** If true - uninstalled. */
782
- revoked?: boolean | null;
783
- /**
784
- * A version.
785
- * @maxLength 500
786
- */
787
- version?: string | null;
788
- /**
789
- * A version for rendering.
790
- * @maxLength 500
791
- */
792
- publishedVersion?: string | null;
793
- }
794
- interface WixCodeAttributes {
795
- }
796
- interface MobileAppAttributes {
797
- /** Deprecated. */
798
- banner?: MobileAppBannerInfo;
799
- }
800
- interface OnboardingAttributes {
801
- /** Indicates whether Onboarding editor is in use. */
802
- inUse?: boolean;
803
- }
804
- interface ClubsAttributes {
805
- }
806
- interface ContactsAttributes {
807
- }
808
- interface ProvidedMailingServiceAttributes {
809
- }
810
- interface WixSiteProperties {
811
- /** TBD. */
812
- userNameInHost?: boolean;
813
- /** TBD. */
814
- footerId?: number;
443
+ originTemplateId?: string;
815
444
  /**
816
- * used to add html embeds to a site. eg: header footer
817
- * @maxLength 255
818
- * @maxSize 100
819
- */
820
- embedTags?: string[];
821
- /** TBD. */
822
- iframeRenderAllowed?: boolean;
823
- /** TBD. */
824
- httpsPolicy?: HttpsPolicyWithLiterals;
825
- }
826
- declare enum HttpsPolicy {
827
- UNKNOWN_HTTPS_POLICY = "UNKNOWN_HTTPS_POLICY",
828
- DISALLOW = "DISALLOW",
829
- ALLOW = "ALLOW",
830
- ENFORCE = "ENFORCE"
831
- }
832
- /** @enumType */
833
- type HttpsPolicyWithLiterals = HttpsPolicy | 'UNKNOWN_HTTPS_POLICY' | 'DISALLOW' | 'ALLOW' | 'ENFORCE';
834
- interface EntryPoint extends EntryPointDataOneOf {
835
- /** TBD. */
836
- userInHost?: UserInHost;
837
- /** TBD. */
838
- userInPath?: UserInPath;
839
- /** TBD. */
840
- domain?: EntryPointDomain;
841
- /** TBD. */
842
- singlePath?: SinglePath;
843
- /** TBD. */
844
- multilingualDomain?: MultilingualDomain;
845
- /** Indicates whether an entry point is primary. */
846
- primary?: boolean;
847
- }
848
- /** @oneof */
849
- interface EntryPointDataOneOf {
850
- /** TBD. */
851
- userInHost?: UserInHost;
852
- /** TBD. */
853
- userInPath?: UserInPath;
854
- /** TBD. */
855
- domain?: EntryPointDomain;
856
- /** TBD. */
857
- singlePath?: SinglePath;
858
- /** TBD. */
859
- multilingualDomain?: MultilingualDomain;
860
- }
861
- interface UserInHost {
862
- /**
863
- * A user name.
864
- * @maxLength 100
865
- */
866
- userName?: string;
867
- /**
868
- * A site name. TODO(meta-site): the limit is 20, but we have meta sites with longer site name.
869
- * @maxLength 255
445
+ * An account id of the owner.
446
+ * @format GUID
870
447
  */
871
- siteName?: string;
872
- }
873
- interface UserInPath {
448
+ ownerId?: string;
449
+ /** A context in which meta site was created. */
450
+ context?: SiteCreatedContextWithLiterals;
874
451
  /**
875
- * A user name.
876
- * @maxLength 100
452
+ * A meta site id from which this site was created.
453
+ *
454
+ * In case of a creation from a template it's a template id.
455
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
456
+ * @format GUID
877
457
  */
878
- userName?: string;
458
+ originMetaSiteId?: string | null;
879
459
  /**
880
- * A site name. TODO(meta-site): the limit is 20, but we have meta sites with longer site name.
881
- * @maxLength 255
460
+ * A meta site name (URL slug).
461
+ * @maxLength 20
882
462
  */
883
463
  siteName?: string;
464
+ /** A namespace. */
465
+ namespace?: NamespaceWithLiterals;
884
466
  }
885
- interface EntryPointDomain {
886
- /**
887
- * A domain name.
888
- * @maxLength 253
889
- */
890
- name?: string;
891
- }
892
- interface SinglePath {
893
- /**
894
- * A full URL.
895
- * @maxLength 4000
896
- */
897
- path?: string;
898
- }
899
- interface MultilingualDomain {
900
- /**
901
- * this is the full domain including language code e.g. fr.domain.com
902
- * @maxLength 253
903
- */
904
- name?: string;
905
- /**
906
- * A language code.
907
- * @maxLength 5
908
- */
909
- languageCode?: string;
467
+ declare enum SiteCreatedContext {
468
+ /** A valid option, we don't expose all reasons why site might be created. */
469
+ OTHER = "OTHER",
470
+ /** A meta site was created from template. */
471
+ FROM_TEMPLATE = "FROM_TEMPLATE",
472
+ /** A meta site was created by copying of the transfferred meta site. */
473
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
474
+ /** A copy of existing meta site. */
475
+ DUPLICATE = "DUPLICATE",
476
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
477
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
478
+ /** deprecated A meta site was created for Flash editor. */
479
+ FLASH = "FLASH"
910
480
  }
481
+ /** @enumType */
482
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
911
483
  declare enum Namespace {
912
484
  UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
913
485
  /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
@@ -948,361 +520,54 @@ declare enum Namespace {
948
520
  SITELESS_BUSINESS = "SITELESS_BUSINESS",
949
521
  /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
950
522
  CREATOR_ECONOMY = "CREATOR_ECONOMY",
951
- /** It is to be used in the Business First efforts. */
952
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
953
- /** Bookings business flow with no site. */
954
- ANYWHERE = "ANYWHERE",
955
- /** Namespace for Headless Backoffice with no editor */
956
- HEADLESS = "HEADLESS",
957
- /**
958
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
959
- * The site will be used for account level CSM feature for enterprise
960
- */
961
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
962
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
963
- RISE = "RISE",
964
- /**
965
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
966
- * There's a blank site behind the scene but it's blank).
967
- * The Mobile company will be the owner of this namespace.
968
- */
969
- BRANDED_FIRST = "BRANDED_FIRST",
970
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
971
- NOWNIA = "NOWNIA",
972
- /**
973
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
974
- * The Partners company owns this namespace.
975
- */
976
- UGC_TEMPLATE = "UGC_TEMPLATE",
977
- /** Codux Headless Sites */
978
- CODUX = "CODUX",
979
- /** Bobb - AI Design Creator. */
980
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
981
- /**
982
- * Shared Blog Site is a unique single site across Enterprise account,
983
- * This site will hold all Blog posts related to the Marketing product.
984
- */
985
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
986
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
987
- STANDALONE_FORMS = "STANDALONE_FORMS",
988
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
989
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
990
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
991
- MIMIR = "MIMIR",
992
- /** Wix Twins platform. */
993
- TWINS = "TWINS",
994
- /** Wix Nano. */
995
- NANO = "NANO"
996
- }
997
- /** @enumType */
998
- 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';
999
- declare enum Flag {
1000
- /** Unknown flag. */
1001
- UNKNOWN_FLAG = "UNKNOWN_FLAG",
1002
- /**
1003
- * ECOM_TEST_DRIVE = 1 [deprecated = true];
1004
- * ECOM_MIGRATED = 2 [deprecated = true];
1005
- * If present, forces usage of wixsite.com/editorx.io for free site + no usage of #!.
1006
- */
1007
- URL_MIGRATED = "URL_MIGRATED",
1008
- /** Indicates whether HTTPS is used for accessing site. */
1009
- USE_HTTPS = "USE_HTTPS",
1010
- /** Indicates that the site is managed by Editor X. Implications: different domain (editorx.com and editorx.io). */
1011
- EDITOR_X = "EDITOR_X",
1012
- /** Indicates metasite blocked from publishing and added additional filtering in listing API (MSS). READ_ONLY. */
1013
- BLOCKED = "BLOCKED",
1014
- /**
1015
- * Indicates that default routing won't be used for this meta site. Additionally it means that this meta site
1016
- * doesn't have viewer url based on meta site data.
1017
- *
1018
- * Default routing is based on domains, free url, ML etc. None of it will be used. This feature is needed
1019
- * when routing is defined completely in Routes API (routes-writer or meta-site-routes).
1020
- */
1021
- DONT_USE_DEFAULT_ROUTING = "DONT_USE_DEFAULT_ROUTING",
1022
- /** Indicates the site is managed bv Wix Studio. Implications: different domain */
1023
- STUDIO = "STUDIO",
1024
- /** Indicates the site is used as critical asset and as such is protected. You would be only able to provision applications to this meta site. */
1025
- CRITICAL_ASSET = "CRITICAL_ASSET",
1026
- /** Indicates that site is managed by Odeditor */
1027
- ODEDITOR = "ODEDITOR",
1028
- /** Indicates that site is managed by Picasso */
1029
- PICASSO = "PICASSO"
1030
- }
1031
- /** @enumType */
1032
- type FlagWithLiterals = Flag | 'UNKNOWN_FLAG' | 'URL_MIGRATED' | 'USE_HTTPS' | 'EDITOR_X' | 'BLOCKED' | 'DONT_USE_DEFAULT_ROUTING' | 'STUDIO' | 'CRITICAL_ASSET' | 'ODEDITOR' | 'PICASSO';
1033
- interface ExternalUriMapping {
1034
- /**
1035
- * Deprecated.
1036
- * @maxLength 255
1037
- */
1038
- fromExternalUri?: string;
1039
- /**
1040
- * Deprecated.
1041
- * @maxLength 255
1042
- */
1043
- toWixUri?: string;
1044
- /**
1045
- * Deprecated.
1046
- * @maxLength 255
1047
- */
1048
- oldToWixUri?: string | null;
1049
- /** Deprecated. */
1050
- requireDomain?: boolean | null;
1051
- }
1052
- interface PendingApps {
1053
- /**
1054
- * A list of pending apps.
1055
- * @maxSize 100
1056
- */
1057
- apps?: PendingApp[];
1058
- }
1059
- declare enum PendingReason {
1060
- UNKNOWN = "UNKNOWN",
1061
- PREMIUM = "PREMIUM",
1062
- APP_MARKET = "APP_MARKET"
1063
- }
1064
- /** @enumType */
1065
- type PendingReasonWithLiterals = PendingReason | 'UNKNOWN' | 'PREMIUM' | 'APP_MARKET';
1066
- interface PendingApp {
1067
- /**
1068
- * App definition id.
1069
- * @maxLength 36
1070
- */
1071
- appId?: string;
1072
- /**
1073
- * A reason.
1074
- * @maxSize 2
1075
- */
1076
- reasons?: PendingReasonWithLiterals[];
1077
- }
1078
- /** Determined by Multilingual via SiteProperties */
1079
- interface SiteLanguages {
1080
- /** A primary language. */
1081
- primary?: SiteLanguage;
1082
- /**
1083
- * All secondaries.
1084
- * @maxSize 1000
1085
- */
1086
- secondaries?: SiteLanguage[];
1087
- }
1088
- interface SiteLanguage {
1089
- /**
1090
- * A language code.
1091
- * @maxLength 5
1092
- */
1093
- languageCode?: string;
1094
- /** A resolution method. */
1095
- resolutionMethod?: ResolutionMethodWithLiterals;
1096
- }
1097
- declare enum ResolutionMethod {
1098
- /** Render site for language using query param. eg: https://www.alonkochba.com/?lang=fr */
1099
- QUERY_PARAM = "QUERY_PARAM",
1100
- /** Render site for language using subdomain. eg: https://fr.alonkochba.com/ */
1101
- SUBDOMAIN = "SUBDOMAIN",
1102
- /** Render site for language using subdirectory. eg: https://www.alonkochba.com/fr */
1103
- SUBDIRECTORY = "SUBDIRECTORY"
1104
- }
1105
- /** @enumType */
1106
- type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
1107
- interface DeleteContext {
1108
- /** When the meta site was deleted. */
1109
- dateDeleted?: Date | null;
1110
- /** A status. */
1111
- deleteStatus?: DeleteStatusWithLiterals;
1112
- /**
1113
- * A reason (flow).
1114
- * @maxLength 255
1115
- */
1116
- deleteOrigin?: string;
1117
- /**
1118
- * A service that deleted it.
1119
- * @maxLength 255
1120
- */
1121
- initiatorId?: string | null;
1122
- }
1123
- declare enum DeleteStatus {
1124
- UNKNOWN = "UNKNOWN",
1125
- TRASH = "TRASH",
1126
- DELETED = "DELETED",
1127
- PENDING_PURGE = "PENDING_PURGE",
1128
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
1129
- }
1130
- /** @enumType */
1131
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
1132
- /** Contains data related to Routes API (routes-writer service). */
1133
- interface RoutesApiData {
1134
- /** A primary URL selected in Routes API. */
1135
- primaryUrl?: PrimaryUrl;
1136
- }
1137
- interface PrimaryUrl {
1138
- /**
1139
- * A route id of the primary URL.
1140
- * @maxLength 36
1141
- */
1142
- routeId?: string;
1143
- /**
1144
- * A URL.
1145
- * @maxLength 4000
1146
- */
1147
- url?: string;
1148
- }
1149
- declare enum Context {
1150
- UNKNOWN = "UNKNOWN",
1151
- /** Creation of the site (might be from template, clone, blank site, etc). */
1152
- CREATE = "CREATE",
1153
- /** Update of the existing site. */
1154
- UPDATE = "UPDATE",
1155
- /** Deletion of the site FOREVER (shouldn't present in db anymore). */
1156
- HARD_DELETE = "HARD_DELETE",
1157
- /** Soft deletion of the site (could be restored). */
1158
- ARCHIVE = "ARCHIVE",
1159
- /** Restoration of a soft deleted site. */
1160
- RESTORE = "RESTORE",
1161
- /** Update of deleted meta site. Happens rarely, only because of data migrations. */
1162
- UPDATE_DELETED = "UPDATE_DELETED",
1163
- /** notify about deleted site. */
1164
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
1165
- }
1166
- /** @enumType */
1167
- type ContextWithLiterals = Context | 'UNKNOWN' | 'CREATE' | 'UPDATE' | 'HARD_DELETE' | 'ARCHIVE' | 'RESTORE' | 'UPDATE_DELETED' | 'PURGED_EXTERNALLY';
1168
- interface MetaSiteEvent extends MetaSiteEventPayloadOneOf {
1169
- /** Site is created. */
1170
- created?: SiteCreated;
1171
- /** Site is transferred. */
1172
- transferred?: SiteTransferred;
1173
- /** Site is deleted. */
1174
- deleted?: SiteDeleted;
1175
- /** Site is undeleted (restored)., */
1176
- undeleted?: SiteUndeleted;
1177
- /** Site is published. */
1178
- published?: SitePublished;
1179
- /** Site is unpublished. */
1180
- unpublished?: SiteUnpublished;
1181
- /** Marked as Template. */
1182
- markedAsTemplate?: SiteMarkedAsTemplate;
1183
- /** Marked as WixSite. */
1184
- markedAsWixSite?: SiteMarkedAsWixSite;
1185
- /** A service is provisioned. */
1186
- serviceProvisioned?: ServiceProvisioned;
1187
- /** A service is removed. */
1188
- serviceRemoved?: ServiceRemoved;
1189
- /** Site is renamed. */
1190
- renamed?: SiteRenamed;
1191
- /** Site is hard deleted. */
1192
- hardDeleted?: SiteHardDeleted;
1193
- /** Site's namespace is changed. */
1194
- namespaceChanged?: NamespaceChanged;
1195
- /** Site's URLs are changed. */
1196
- urlChanged?: SiteUrlChanged;
1197
- /** Site is marked/created as Wix Studio site */
1198
- studioAssigned?: StudioAssigned;
1199
- /** Site is no longer WIx Studio site */
1200
- studioUnassigned?: StudioUnassigned;
1201
- /** A service mentioned in one of the payloads is a Virtual Tpa */
1202
- virtualTpaMentioned?: VirtualTpaMentioned;
1203
- /** Site is marked as PurgedExternally */
1204
- sitePurgedExternally?: SitePurgedExternally;
1205
- /** Site is marked/created as Odeditor site */
1206
- odeditorAssigned?: OdeditorAssigned;
1207
- /** Site is no longer Odeditor site */
1208
- odeditorUnassigned?: OdeditorUnassigned;
1209
- /** Site is marked/created as Picasso site */
1210
- picassoAssigned?: PicassoAssigned;
1211
- /** Site is no longer Picasso site */
1212
- picassoUnassigned?: PicassoUnassigned;
1213
- }
1214
- /** @oneof */
1215
- interface MetaSiteEventPayloadOneOf {
1216
- /** Site is created. */
1217
- created?: SiteCreated;
1218
- /** Site is transferred. */
1219
- transferred?: SiteTransferred;
1220
- /** Site is deleted. */
1221
- deleted?: SiteDeleted;
1222
- /** Site is undeleted (restored)., */
1223
- undeleted?: SiteUndeleted;
1224
- /** Site is published. */
1225
- published?: SitePublished;
1226
- /** Site is unpublished. */
1227
- unpublished?: SiteUnpublished;
1228
- /** Marked as Template. */
1229
- markedAsTemplate?: SiteMarkedAsTemplate;
1230
- /** Marked as WixSite. */
1231
- markedAsWixSite?: SiteMarkedAsWixSite;
1232
- /** A service is provisioned. */
1233
- serviceProvisioned?: ServiceProvisioned;
1234
- /** A service is removed. */
1235
- serviceRemoved?: ServiceRemoved;
1236
- /** Site is renamed. */
1237
- renamed?: SiteRenamed;
1238
- /** Site is hard deleted. */
1239
- hardDeleted?: SiteHardDeleted;
1240
- /** Site's namespace is changed. */
1241
- namespaceChanged?: NamespaceChanged;
1242
- /** Site's URLs are changed. */
1243
- urlChanged?: SiteUrlChanged;
1244
- /** Site is marked/created as Wix Studio site */
1245
- studioAssigned?: StudioAssigned;
1246
- /** Site is no longer WIx Studio site */
1247
- studioUnassigned?: StudioUnassigned;
1248
- /** A service mentioned in one of the payloads is a Virtual Tpa */
1249
- virtualTpaMentioned?: VirtualTpaMentioned;
1250
- /** Site is marked as PurgedExternally */
1251
- sitePurgedExternally?: SitePurgedExternally;
1252
- /** Site is marked/created as Odeditor site */
1253
- odeditorAssigned?: OdeditorAssigned;
1254
- /** Site is no longer Odeditor site */
1255
- odeditorUnassigned?: OdeditorUnassigned;
1256
- /** Site is marked/created as Picasso site */
1257
- picassoAssigned?: PicassoAssigned;
1258
- /** Site is no longer Picasso site */
1259
- picassoUnassigned?: PicassoUnassigned;
1260
- }
1261
- interface SiteCreated {
523
+ /** It is to be used in the Business First efforts. */
524
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
525
+ /** Bookings business flow with no site. */
526
+ ANYWHERE = "ANYWHERE",
527
+ /** Namespace for Headless Backoffice with no editor */
528
+ HEADLESS = "HEADLESS",
1262
529
  /**
1263
- * A template identifier (empty if not created from a template).
1264
- * @maxLength 36
530
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
531
+ * The site will be used for account level CSM feature for enterprise
1265
532
  */
1266
- originTemplateId?: string;
533
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
534
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
535
+ RISE = "RISE",
1267
536
  /**
1268
- * An account id of the owner.
1269
- * @format GUID
537
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
538
+ * There's a blank site behind the scene but it's blank).
539
+ * The Mobile company will be the owner of this namespace.
1270
540
  */
1271
- ownerId?: string;
1272
- /** A context in which meta site was created. */
1273
- context?: SiteCreatedContextWithLiterals;
541
+ BRANDED_FIRST = "BRANDED_FIRST",
542
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
543
+ NOWNIA = "NOWNIA",
1274
544
  /**
1275
- * A meta site id from which this site was created.
1276
- *
1277
- * In case of a creation from a template it's a template id.
1278
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
1279
- * @format GUID
545
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
546
+ * The Partners company owns this namespace.
1280
547
  */
1281
- originMetaSiteId?: string | null;
548
+ UGC_TEMPLATE = "UGC_TEMPLATE",
549
+ /** Codux Headless Sites */
550
+ CODUX = "CODUX",
551
+ /** Bobb - AI Design Creator. */
552
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
1282
553
  /**
1283
- * A meta site name (URL slug).
1284
- * @maxLength 20
554
+ * Shared Blog Site is a unique single site across Enterprise account,
555
+ * This site will hold all Blog posts related to the Marketing product.
1285
556
  */
1286
- siteName?: string;
1287
- /** A namespace. */
1288
- namespace?: NamespaceWithLiterals;
1289
- }
1290
- declare enum SiteCreatedContext {
1291
- /** A valid option, we don't expose all reasons why site might be created. */
1292
- OTHER = "OTHER",
1293
- /** A meta site was created from template. */
1294
- FROM_TEMPLATE = "FROM_TEMPLATE",
1295
- /** A meta site was created by copying of the transfferred meta site. */
1296
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
1297
- /** A copy of existing meta site. */
1298
- DUPLICATE = "DUPLICATE",
1299
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
1300
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
1301
- /** deprecated A meta site was created for Flash editor. */
1302
- FLASH = "FLASH"
557
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
558
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
559
+ STANDALONE_FORMS = "STANDALONE_FORMS",
560
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
561
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
562
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
563
+ MIMIR = "MIMIR",
564
+ /** Wix Twins platform. */
565
+ TWINS = "TWINS",
566
+ /** Wix Nano. */
567
+ NANO = "NANO"
1303
568
  }
1304
569
  /** @enumType */
1305
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
570
+ 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';
1306
571
  /** Site transferred to another user. */
1307
572
  interface SiteTransferred {
1308
573
  /**
@@ -1321,6 +586,31 @@ interface SiteDeleted {
1321
586
  /** A deletion context. */
1322
587
  deleteContext?: DeleteContext;
1323
588
  }
589
+ interface DeleteContext {
590
+ /** When the meta site was deleted. */
591
+ dateDeleted?: Date | null;
592
+ /** A status. */
593
+ deleteStatus?: DeleteStatusWithLiterals;
594
+ /**
595
+ * A reason (flow).
596
+ * @maxLength 255
597
+ */
598
+ deleteOrigin?: string;
599
+ /**
600
+ * A service that deleted it.
601
+ * @maxLength 255
602
+ */
603
+ initiatorId?: string | null;
604
+ }
605
+ declare enum DeleteStatus {
606
+ UNKNOWN = "UNKNOWN",
607
+ TRASH = "TRASH",
608
+ DELETED = "DELETED",
609
+ PENDING_PURGE = "PENDING_PURGE",
610
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
611
+ }
612
+ /** @enumType */
613
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
1324
614
  /** Restoration of the meta site. */
1325
615
  interface SiteUndeleted {
1326
616
  }
@@ -1426,6 +716,12 @@ interface NamespaceChanged {
1426
716
  /** A new namespace. */
1427
717
  newNamespace?: NamespaceWithLiterals;
1428
718
  }
719
+ /** Assigned Studio editor */
720
+ interface StudioAssigned {
721
+ }
722
+ /** Unassigned Studio editor */
723
+ interface StudioUnassigned {
724
+ }
1429
725
  /**
1430
726
  * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
1431
727
  *
@@ -1436,24 +732,6 @@ interface NamespaceChanged {
1436
732
  */
1437
733
  interface SiteUrlChanged {
1438
734
  }
1439
- /** Assigned Studio editor */
1440
- interface StudioAssigned {
1441
- }
1442
- /** Unassigned Studio editor */
1443
- interface StudioUnassigned {
1444
- }
1445
- /**
1446
- * Used in case a Virtual Tpa is one of the apps mentioned in one of the payloads.
1447
- * A Virtual Tpa represents an embedded service that is in the process of migrating to a ThirdPartyApp.
1448
- * It is not persisted on the MetaSite, or in app-container, but it is treated by consumers outside of MetaSite as if it is a provisioned app.
1449
- */
1450
- interface VirtualTpaMentioned {
1451
- /**
1452
- * Either UUID or EmbeddedServiceType.
1453
- * @maxLength 36
1454
- */
1455
- appDefId?: string;
1456
- }
1457
735
  /**
1458
736
  * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
1459
737
  * Consumed by other teams to remove relevant data.
@@ -1479,145 +757,6 @@ interface PicassoAssigned {
1479
757
  /** Unassigned Picasso */
1480
758
  interface PicassoUnassigned {
1481
759
  }
1482
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
1483
- /** Emitted on a meta site creation. */
1484
- siteCreated?: SiteCreated;
1485
- /** Emitted on a meta site transfer completion. */
1486
- siteTransferred?: SiteTransferred;
1487
- /** Emitted on a meta site deletion. */
1488
- siteDeleted?: SiteDeleted;
1489
- /** Emitted on a meta site restoration. */
1490
- siteUndeleted?: SiteUndeleted;
1491
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
1492
- sitePublished?: SitePublished;
1493
- /** Emitted on a meta site unpublish. */
1494
- siteUnpublished?: SiteUnpublished;
1495
- /** Emitted when meta site is marked as template. */
1496
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
1497
- /** Emitted when meta site is marked as a WixSite. */
1498
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
1499
- /** Emitted when an application is provisioned (installed). */
1500
- serviceProvisioned?: ServiceProvisioned;
1501
- /** Emitted when an application is removed (uninstalled). */
1502
- serviceRemoved?: ServiceRemoved;
1503
- /** Emitted when meta site name (URL slug) is changed. */
1504
- siteRenamedPayload?: SiteRenamed;
1505
- /** Emitted when meta site was permanently deleted. */
1506
- hardDeleted?: SiteHardDeleted;
1507
- /** Emitted on a namespace change. */
1508
- namespaceChanged?: NamespaceChanged;
1509
- /** Emitted when Studio is attached. */
1510
- studioAssigned?: StudioAssigned;
1511
- /** Emitted when Studio is detached. */
1512
- studioUnassigned?: StudioUnassigned;
1513
- /**
1514
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
1515
- * the actual URL.
1516
- *
1517
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
1518
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
1519
- */
1520
- urlChanged?: SiteUrlChanged;
1521
- /** Site is marked as PurgedExternally */
1522
- sitePurgedExternally?: SitePurgedExternally;
1523
- /** Emitted when Odeditor is attached. */
1524
- odeditorAssigned?: OdeditorAssigned;
1525
- /** Emitted when Odeditor is detached. */
1526
- odeditorUnassigned?: OdeditorUnassigned;
1527
- /** Emitted when Picasso is attached. */
1528
- picassoAssigned?: PicassoAssigned;
1529
- /** Emitted when Picasso is detached. */
1530
- picassoUnassigned?: PicassoUnassigned;
1531
- /**
1532
- * A meta site id.
1533
- * @format GUID
1534
- */
1535
- metaSiteId?: string;
1536
- /** A meta site version. Monotonically increasing. */
1537
- version?: string;
1538
- /** A timestamp of the event. */
1539
- timestamp?: string;
1540
- /**
1541
- * TODO(meta-site): Change validation once validations are disabled for consumers
1542
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
1543
- * @maxSize 4000
1544
- */
1545
- assets?: Asset[];
1546
- }
1547
- /** @oneof */
1548
- interface MetaSiteSpecialEventPayloadOneOf {
1549
- /** Emitted on a meta site creation. */
1550
- siteCreated?: SiteCreated;
1551
- /** Emitted on a meta site transfer completion. */
1552
- siteTransferred?: SiteTransferred;
1553
- /** Emitted on a meta site deletion. */
1554
- siteDeleted?: SiteDeleted;
1555
- /** Emitted on a meta site restoration. */
1556
- siteUndeleted?: SiteUndeleted;
1557
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
1558
- sitePublished?: SitePublished;
1559
- /** Emitted on a meta site unpublish. */
1560
- siteUnpublished?: SiteUnpublished;
1561
- /** Emitted when meta site is marked as template. */
1562
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
1563
- /** Emitted when meta site is marked as a WixSite. */
1564
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
1565
- /** Emitted when an application is provisioned (installed). */
1566
- serviceProvisioned?: ServiceProvisioned;
1567
- /** Emitted when an application is removed (uninstalled). */
1568
- serviceRemoved?: ServiceRemoved;
1569
- /** Emitted when meta site name (URL slug) is changed. */
1570
- siteRenamedPayload?: SiteRenamed;
1571
- /** Emitted when meta site was permanently deleted. */
1572
- hardDeleted?: SiteHardDeleted;
1573
- /** Emitted on a namespace change. */
1574
- namespaceChanged?: NamespaceChanged;
1575
- /** Emitted when Studio is attached. */
1576
- studioAssigned?: StudioAssigned;
1577
- /** Emitted when Studio is detached. */
1578
- studioUnassigned?: StudioUnassigned;
1579
- /**
1580
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
1581
- * the actual URL.
1582
- *
1583
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
1584
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
1585
- */
1586
- urlChanged?: SiteUrlChanged;
1587
- /** Site is marked as PurgedExternally */
1588
- sitePurgedExternally?: SitePurgedExternally;
1589
- /** Emitted when Odeditor is attached. */
1590
- odeditorAssigned?: OdeditorAssigned;
1591
- /** Emitted when Odeditor is detached. */
1592
- odeditorUnassigned?: OdeditorUnassigned;
1593
- /** Emitted when Picasso is attached. */
1594
- picassoAssigned?: PicassoAssigned;
1595
- /** Emitted when Picasso is detached. */
1596
- picassoUnassigned?: PicassoUnassigned;
1597
- }
1598
- interface Asset {
1599
- /**
1600
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
1601
- * @maxLength 36
1602
- */
1603
- appDefId?: string;
1604
- /**
1605
- * An instance id. For legacy reasons may be UUID or a string.
1606
- * @maxLength 200
1607
- */
1608
- instanceId?: string;
1609
- /** An application state. */
1610
- state?: StateWithLiterals;
1611
- }
1612
- declare enum State {
1613
- UNKNOWN = "UNKNOWN",
1614
- ENABLED = "ENABLED",
1615
- DISABLED = "DISABLED",
1616
- PENDING = "PENDING",
1617
- DEMO = "DEMO"
1618
- }
1619
- /** @enumType */
1620
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
1621
760
  interface DomainEvent extends DomainEventBodyOneOf {
1622
761
  createdEvent?: EntityCreatedEvent;
1623
762
  updatedEvent?: EntityUpdatedEvent;
@@ -1882,4 +1021,4 @@ interface BulkUpdatePaymentAcceptanceConfigurationTagsByFilterOptions {
1882
1021
  unassignTags?: Tags;
1883
1022
  }
1884
1023
 
1885
- export { type ActionEvent, ApiState, type ApiStateWithLiterals, type AppBuilderAttributes, type Application, type ApplicationError, ApplicationType, type ApplicationTypeWithLiterals, type Asset, type BulkActionMetadata, type BulkUpdatePaymentAcceptanceConfigurationTagsByFilterOptions, type BulkUpdatePaymentAcceptanceConfigurationTagsByFilterRequest, type BulkUpdatePaymentAcceptanceConfigurationTagsByFilterResponse, type BulkUpdatePaymentAcceptanceConfigurationTagsOptions, type BulkUpdatePaymentAcceptanceConfigurationTagsRequest, type BulkUpdatePaymentAcceptanceConfigurationTagsResponse, type BulkUpdatePaymentAcceptanceConfigurationTagsResult, type ClubsAttributes, CollectionExposure, type CollectionExposureWithLiterals, Compatibility, type CompatibilityWithLiterals, type ContactsAttributes, Context, type ContextWithLiterals, type CreatePaymentAcceptanceConfigurationRequest, type CreatePaymentAcceptanceConfigurationResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteContext, type DeletePaymentAcceptanceConfigurationRequest, type DeletePaymentAcceptanceConfigurationResponse, DeleteStatus, type DeleteStatusWithLiterals, DocumentType, type DocumentTypeWithLiterals, type Domain, type DomainEvent, type DomainEventBodyOneOf, type EmbeddedService, type EmbeddedServiceAttributesOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EntryPoint, type EntryPointDataOneOf, type EntryPointDomain, type ExtendedFields, type ExternalUriMapping, Flag, type FlagWithLiterals, FormFace, type FormFaceWithLiterals, type GetPaymentAcceptanceConfigurationRequest, type GetPaymentAcceptanceConfigurationResponse, HttpsPolicy, type HttpsPolicyWithLiterals, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, Kind, type KindWithLiterals, type ListsAppsAttributes, type MessageEnvelope, type MetaSite, type MetaSiteEvent, type MetaSiteEventPayloadOneOf, type MetaSiteFullEvent, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, type MetaTag, type MobileAppAttributes, type MobileAppBannerInfo, type MultilingualDomain, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type OnboardingAttributes, type PaymentAcceptanceConfiguration, type PaymentAcceptanceConfigurationsQueryBuilder, type PaymentAcceptanceConfigurationsQueryResult, type PaymentAcceptanceRule, type PendingApp, type PendingApps, PendingReason, type PendingReasonWithLiterals, type PicassoAssigned, type PicassoUnassigned, PremiumFeature, type PremiumFeatureWithLiterals, type PrimaryUrl, type ProvidedMailingServiceAttributes, type QueryPaymentAcceptanceConfigurationsRequest, type QueryPaymentAcceptanceConfigurationsResponse, ResolutionMethod, type ResolutionMethodWithLiterals, type RestoreInfo, type RoutesApiData, type SeoData, type ServiceProvisioned, type ServiceRemoved, type SinglePath, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteLanguage, type SiteLanguages, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SiteMembersAttributes, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, type StudioAssigned, type StudioUnassigned, type TagList, type Tags, type ThirdPartyAppsAttributes, type TrackingData, type UpdatePaymentAcceptanceConfiguration, type UpdatePaymentAcceptanceConfigurationRequest, type UpdatePaymentAcceptanceConfigurationResponse, type UrlMapping, type UserInHost, type UserInPath, type VirtualTpaMentioned, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixCodeAttributes, type WixSiteProperties };
1024
+ export { type ActionEvent, type ApplicationError, type Asset, type BulkActionMetadata, type BulkUpdatePaymentAcceptanceConfigurationTagsByFilterOptions, type BulkUpdatePaymentAcceptanceConfigurationTagsByFilterRequest, type BulkUpdatePaymentAcceptanceConfigurationTagsByFilterResponse, type BulkUpdatePaymentAcceptanceConfigurationTagsOptions, type BulkUpdatePaymentAcceptanceConfigurationTagsRequest, type BulkUpdatePaymentAcceptanceConfigurationTagsResponse, type BulkUpdatePaymentAcceptanceConfigurationTagsResult, type CreatePaymentAcceptanceConfigurationRequest, type CreatePaymentAcceptanceConfigurationResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteContext, type DeletePaymentAcceptanceConfigurationRequest, type DeletePaymentAcceptanceConfigurationResponse, DeleteStatus, type DeleteStatusWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type GetPaymentAcceptanceConfigurationRequest, type GetPaymentAcceptanceConfigurationResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type PaymentAcceptanceConfiguration, type PaymentAcceptanceConfigurationsQueryBuilder, type PaymentAcceptanceConfigurationsQueryResult, type PaymentAcceptanceRule, type PicassoAssigned, type PicassoUnassigned, type QueryPaymentAcceptanceConfigurationsRequest, type QueryPaymentAcceptanceConfigurationsResponse, type RestoreInfo, type ServiceProvisioned, type ServiceRemoved, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, type StudioAssigned, type StudioUnassigned, type TagList, type Tags, type UpdatePaymentAcceptanceConfiguration, type UpdatePaymentAcceptanceConfigurationRequest, type UpdatePaymentAcceptanceConfigurationResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals };