@wix/auto_sdk_payments_payment-acceptance-configurations 1.0.29 → 1.0.30

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