@wix/auto_sdk_calendar_schedules 1.0.70 → 1.0.71
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/meta.d.ts +960 -1
- package/build/cjs/meta.js +166 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/es/meta.d.mts +960 -1
- package/build/es/meta.mjs +151 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/meta.d.ts +960 -1
- package/build/internal/cjs/meta.js +166 -0
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/meta.d.mts +960 -1
- package/build/internal/es/meta.mjs +151 -0
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +3 -3
package/build/cjs/meta.d.ts
CHANGED
|
@@ -269,6 +269,12 @@ interface CommonIdentificationDataIdOneOf {
|
|
|
269
269
|
*/
|
|
270
270
|
wixUserId?: string;
|
|
271
271
|
}
|
|
272
|
+
declare enum IdentityType {
|
|
273
|
+
UNKNOWN = "UNKNOWN",
|
|
274
|
+
WIX_USER = "WIX_USER"
|
|
275
|
+
}
|
|
276
|
+
/** @enumType */
|
|
277
|
+
type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'WIX_USER';
|
|
272
278
|
declare enum Role {
|
|
273
279
|
UNKNOWN_ROLE = "UNKNOWN_ROLE",
|
|
274
280
|
/** Full read and write access. */
|
|
@@ -451,6 +457,56 @@ interface UpdateScheduleResponse {
|
|
|
451
457
|
/** Updated schedule. */
|
|
452
458
|
schedule?: Schedule;
|
|
453
459
|
}
|
|
460
|
+
/** `PRIVATE` until we'll have standard events metadata from Infra. */
|
|
461
|
+
interface ScheduleUpdatedWithMetadata {
|
|
462
|
+
/** The updated schedule. */
|
|
463
|
+
schedule?: Schedule;
|
|
464
|
+
/** Whether to notify participants regarding the changes. */
|
|
465
|
+
participantNotification?: ParticipantNotification;
|
|
466
|
+
}
|
|
467
|
+
interface CloneScheduleRequest {
|
|
468
|
+
/**
|
|
469
|
+
* ID of the schedule to clone.
|
|
470
|
+
* @format GUID
|
|
471
|
+
*/
|
|
472
|
+
scheduleId?: string | null;
|
|
473
|
+
/** Fields to override in the cloned schedule. */
|
|
474
|
+
schedule?: Schedule;
|
|
475
|
+
}
|
|
476
|
+
interface CloneScheduleResponse {
|
|
477
|
+
/** Cloned schedule. */
|
|
478
|
+
schedule?: Schedule;
|
|
479
|
+
}
|
|
480
|
+
interface ScheduleCloned {
|
|
481
|
+
/** New cloned schedule. */
|
|
482
|
+
schedule?: Schedule;
|
|
483
|
+
/** The clone trigger. */
|
|
484
|
+
trigger?: TriggerWithLiterals;
|
|
485
|
+
/**
|
|
486
|
+
* The original Meta Site ID if different.
|
|
487
|
+
* @format GUID
|
|
488
|
+
*/
|
|
489
|
+
originalMetaSiteId?: string | null;
|
|
490
|
+
/**
|
|
491
|
+
* The original schedule ID if different.
|
|
492
|
+
* @format GUID
|
|
493
|
+
*/
|
|
494
|
+
originalScheduleId?: string | null;
|
|
495
|
+
}
|
|
496
|
+
declare enum Trigger {
|
|
497
|
+
/** Schedule cloned using the `CloneSchedule` API. */
|
|
498
|
+
SCHEDULE_CLONED = "SCHEDULE_CLONED",
|
|
499
|
+
/** Site duplicated from the same account. */
|
|
500
|
+
SITE_DUPLICATED_FROM_SAME_ACCOUNT = "SITE_DUPLICATED_FROM_SAME_ACCOUNT",
|
|
501
|
+
/** Site duplicated from a different account. */
|
|
502
|
+
SITE_DUPLICATED_FROM_DIFFERENT_ACCOUNT = "SITE_DUPLICATED_FROM_DIFFERENT_ACCOUNT",
|
|
503
|
+
/** Site created from template. */
|
|
504
|
+
SITE_CREATED_FROM_TEMPLATE = "SITE_CREATED_FROM_TEMPLATE",
|
|
505
|
+
/** Other. */
|
|
506
|
+
OTHER = "OTHER"
|
|
507
|
+
}
|
|
508
|
+
/** @enumType */
|
|
509
|
+
type TriggerWithLiterals = Trigger | 'SCHEDULE_CLONED' | 'SITE_DUPLICATED_FROM_SAME_ACCOUNT' | 'SITE_DUPLICATED_FROM_DIFFERENT_ACCOUNT' | 'SITE_CREATED_FROM_TEMPLATE' | 'OTHER';
|
|
454
510
|
interface CancelScheduleRequest {
|
|
455
511
|
/**
|
|
456
512
|
* ID of the schedule to cancel.
|
|
@@ -472,6 +528,909 @@ interface CancelScheduleResponse {
|
|
|
472
528
|
/** Canceled schedule. */
|
|
473
529
|
schedule?: Schedule;
|
|
474
530
|
}
|
|
531
|
+
interface ScheduleCancelled {
|
|
532
|
+
/** Canceled schedule. */
|
|
533
|
+
schedule?: Schedule;
|
|
534
|
+
/** Whether future events with participants were preserved. */
|
|
535
|
+
preserveFutureEventsWithParticipants?: boolean | null;
|
|
536
|
+
}
|
|
537
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
538
|
+
/** Emitted on a meta site creation. */
|
|
539
|
+
siteCreated?: SiteCreated;
|
|
540
|
+
/** Emitted on a meta site transfer completion. */
|
|
541
|
+
siteTransferred?: SiteTransferred;
|
|
542
|
+
/** Emitted on a meta site deletion. */
|
|
543
|
+
siteDeleted?: SiteDeleted;
|
|
544
|
+
/** Emitted on a meta site restoration. */
|
|
545
|
+
siteUndeleted?: SiteUndeleted;
|
|
546
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
547
|
+
sitePublished?: SitePublished;
|
|
548
|
+
/** Emitted on a meta site unpublish. */
|
|
549
|
+
siteUnpublished?: SiteUnpublished;
|
|
550
|
+
/** Emitted when meta site is marked as template. */
|
|
551
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
552
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
553
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
554
|
+
/** Emitted when an application is provisioned (installed). */
|
|
555
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
556
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
557
|
+
serviceRemoved?: ServiceRemoved;
|
|
558
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
559
|
+
siteRenamedPayload?: SiteRenamed;
|
|
560
|
+
/** Emitted when meta site was permanently deleted. */
|
|
561
|
+
hardDeleted?: SiteHardDeleted;
|
|
562
|
+
/** Emitted on a namespace change. */
|
|
563
|
+
namespaceChanged?: NamespaceChanged;
|
|
564
|
+
/** Emitted when Studio is attached. */
|
|
565
|
+
studioAssigned?: StudioAssigned;
|
|
566
|
+
/** Emitted when Studio is detached. */
|
|
567
|
+
studioUnassigned?: StudioUnassigned;
|
|
568
|
+
/**
|
|
569
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
570
|
+
* the actual URL.
|
|
571
|
+
*
|
|
572
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
573
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
574
|
+
*/
|
|
575
|
+
urlChanged?: SiteUrlChanged;
|
|
576
|
+
/** Site is marked as PurgedExternally */
|
|
577
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
578
|
+
/** Emitted when Odeditor is attached. */
|
|
579
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
580
|
+
/** Emitted when Odeditor is detached. */
|
|
581
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
582
|
+
/** Emitted when Picasso is attached. */
|
|
583
|
+
picassoAssigned?: PicassoAssigned;
|
|
584
|
+
/** Emitted when Picasso is detached. */
|
|
585
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
586
|
+
/**
|
|
587
|
+
* A meta site id.
|
|
588
|
+
* @format GUID
|
|
589
|
+
*/
|
|
590
|
+
metaSiteId?: string;
|
|
591
|
+
/** A meta site version. Monotonically increasing. */
|
|
592
|
+
version?: string;
|
|
593
|
+
/** A timestamp of the event. */
|
|
594
|
+
timestamp?: string;
|
|
595
|
+
/**
|
|
596
|
+
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
597
|
+
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
598
|
+
* @maxSize 4000
|
|
599
|
+
*/
|
|
600
|
+
assets?: Asset[];
|
|
601
|
+
}
|
|
602
|
+
/** @oneof */
|
|
603
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
604
|
+
/** Emitted on a meta site creation. */
|
|
605
|
+
siteCreated?: SiteCreated;
|
|
606
|
+
/** Emitted on a meta site transfer completion. */
|
|
607
|
+
siteTransferred?: SiteTransferred;
|
|
608
|
+
/** Emitted on a meta site deletion. */
|
|
609
|
+
siteDeleted?: SiteDeleted;
|
|
610
|
+
/** Emitted on a meta site restoration. */
|
|
611
|
+
siteUndeleted?: SiteUndeleted;
|
|
612
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
613
|
+
sitePublished?: SitePublished;
|
|
614
|
+
/** Emitted on a meta site unpublish. */
|
|
615
|
+
siteUnpublished?: SiteUnpublished;
|
|
616
|
+
/** Emitted when meta site is marked as template. */
|
|
617
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
618
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
619
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
620
|
+
/** Emitted when an application is provisioned (installed). */
|
|
621
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
622
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
623
|
+
serviceRemoved?: ServiceRemoved;
|
|
624
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
625
|
+
siteRenamedPayload?: SiteRenamed;
|
|
626
|
+
/** Emitted when meta site was permanently deleted. */
|
|
627
|
+
hardDeleted?: SiteHardDeleted;
|
|
628
|
+
/** Emitted on a namespace change. */
|
|
629
|
+
namespaceChanged?: NamespaceChanged;
|
|
630
|
+
/** Emitted when Studio is attached. */
|
|
631
|
+
studioAssigned?: StudioAssigned;
|
|
632
|
+
/** Emitted when Studio is detached. */
|
|
633
|
+
studioUnassigned?: StudioUnassigned;
|
|
634
|
+
/**
|
|
635
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
636
|
+
* the actual URL.
|
|
637
|
+
*
|
|
638
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
639
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
640
|
+
*/
|
|
641
|
+
urlChanged?: SiteUrlChanged;
|
|
642
|
+
/** Site is marked as PurgedExternally */
|
|
643
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
644
|
+
/** Emitted when Odeditor is attached. */
|
|
645
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
646
|
+
/** Emitted when Odeditor is detached. */
|
|
647
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
648
|
+
/** Emitted when Picasso is attached. */
|
|
649
|
+
picassoAssigned?: PicassoAssigned;
|
|
650
|
+
/** Emitted when Picasso is detached. */
|
|
651
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
652
|
+
}
|
|
653
|
+
interface Asset {
|
|
654
|
+
/**
|
|
655
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
656
|
+
* @maxLength 36
|
|
657
|
+
*/
|
|
658
|
+
appDefId?: string;
|
|
659
|
+
/**
|
|
660
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
661
|
+
* @maxLength 200
|
|
662
|
+
*/
|
|
663
|
+
instanceId?: string;
|
|
664
|
+
/** An application state. */
|
|
665
|
+
state?: StateWithLiterals;
|
|
666
|
+
}
|
|
667
|
+
declare enum State {
|
|
668
|
+
UNKNOWN = "UNKNOWN",
|
|
669
|
+
ENABLED = "ENABLED",
|
|
670
|
+
DISABLED = "DISABLED",
|
|
671
|
+
PENDING = "PENDING",
|
|
672
|
+
DEMO = "DEMO"
|
|
673
|
+
}
|
|
674
|
+
/** @enumType */
|
|
675
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
676
|
+
interface SiteCreated {
|
|
677
|
+
/**
|
|
678
|
+
* A template identifier (empty if not created from a template).
|
|
679
|
+
* @maxLength 36
|
|
680
|
+
*/
|
|
681
|
+
originTemplateId?: string;
|
|
682
|
+
/**
|
|
683
|
+
* An account id of the owner.
|
|
684
|
+
* @format GUID
|
|
685
|
+
*/
|
|
686
|
+
ownerId?: string;
|
|
687
|
+
/** A context in which meta site was created. */
|
|
688
|
+
context?: SiteCreatedContextWithLiterals;
|
|
689
|
+
/**
|
|
690
|
+
* A meta site id from which this site was created.
|
|
691
|
+
*
|
|
692
|
+
* In case of a creation from a template it's a template id.
|
|
693
|
+
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
694
|
+
* @format GUID
|
|
695
|
+
*/
|
|
696
|
+
originMetaSiteId?: string | null;
|
|
697
|
+
/**
|
|
698
|
+
* A meta site name (URL slug).
|
|
699
|
+
* @maxLength 20
|
|
700
|
+
*/
|
|
701
|
+
siteName?: string;
|
|
702
|
+
/** A namespace. */
|
|
703
|
+
namespace?: NamespaceWithLiterals;
|
|
704
|
+
}
|
|
705
|
+
declare enum SiteCreatedContext {
|
|
706
|
+
/** A valid option, we don't expose all reasons why site might be created. */
|
|
707
|
+
OTHER = "OTHER",
|
|
708
|
+
/** A meta site was created from template. */
|
|
709
|
+
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
710
|
+
/** A meta site was created by copying of the transfferred meta site. */
|
|
711
|
+
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
712
|
+
/** A copy of existing meta site. */
|
|
713
|
+
DUPLICATE = "DUPLICATE",
|
|
714
|
+
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
715
|
+
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
716
|
+
/** deprecated A meta site was created for Flash editor. */
|
|
717
|
+
FLASH = "FLASH"
|
|
718
|
+
}
|
|
719
|
+
/** @enumType */
|
|
720
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
721
|
+
declare enum Namespace {
|
|
722
|
+
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
723
|
+
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
724
|
+
WIX = "WIX",
|
|
725
|
+
/** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
726
|
+
SHOUT_OUT = "SHOUT_OUT",
|
|
727
|
+
/** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
728
|
+
ALBUMS = "ALBUMS",
|
|
729
|
+
/** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
730
|
+
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
731
|
+
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
732
|
+
HOTELS = "HOTELS",
|
|
733
|
+
/** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
734
|
+
CLUBS = "CLUBS",
|
|
735
|
+
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
736
|
+
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
737
|
+
/** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
738
|
+
DEV_SITE = "DEV_SITE",
|
|
739
|
+
/** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
740
|
+
LOGOS = "LOGOS",
|
|
741
|
+
/** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
742
|
+
VIDEO_MAKER = "VIDEO_MAKER",
|
|
743
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
744
|
+
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
745
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
746
|
+
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
747
|
+
/**
|
|
748
|
+
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
749
|
+
*
|
|
750
|
+
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
751
|
+
*/
|
|
752
|
+
HTML_DRAFT = "HTML_DRAFT",
|
|
753
|
+
/**
|
|
754
|
+
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
755
|
+
* Will be accessible from Site List and will not have a website app.
|
|
756
|
+
* Once the user attaches a site, the site will become a regular wixsite.
|
|
757
|
+
*/
|
|
758
|
+
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
759
|
+
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
760
|
+
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
761
|
+
/** It is to be used in the Business First efforts. */
|
|
762
|
+
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
763
|
+
/** Bookings business flow with no site. */
|
|
764
|
+
ANYWHERE = "ANYWHERE",
|
|
765
|
+
/** Namespace for Headless Backoffice with no editor */
|
|
766
|
+
HEADLESS = "HEADLESS",
|
|
767
|
+
/**
|
|
768
|
+
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
769
|
+
* The site will be used for account level CSM feature for enterprise
|
|
770
|
+
*/
|
|
771
|
+
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
772
|
+
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
773
|
+
RISE = "RISE",
|
|
774
|
+
/**
|
|
775
|
+
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
776
|
+
* There's a blank site behind the scene but it's blank).
|
|
777
|
+
* The Mobile company will be the owner of this namespace.
|
|
778
|
+
*/
|
|
779
|
+
BRANDED_FIRST = "BRANDED_FIRST",
|
|
780
|
+
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
781
|
+
NOWNIA = "NOWNIA",
|
|
782
|
+
/**
|
|
783
|
+
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
784
|
+
* The Partners company owns this namespace.
|
|
785
|
+
*/
|
|
786
|
+
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
787
|
+
/** Codux Headless Sites */
|
|
788
|
+
CODUX = "CODUX",
|
|
789
|
+
/** Bobb - AI Design Creator. */
|
|
790
|
+
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
791
|
+
/**
|
|
792
|
+
* Shared Blog Site is a unique single site across Enterprise account,
|
|
793
|
+
* This site will hold all Blog posts related to the Marketing product.
|
|
794
|
+
*/
|
|
795
|
+
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
796
|
+
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
797
|
+
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
798
|
+
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
799
|
+
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
800
|
+
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
801
|
+
MIMIR = "MIMIR",
|
|
802
|
+
/** Wix Twins platform. */
|
|
803
|
+
TWINS = "TWINS",
|
|
804
|
+
/** Wix Nano. */
|
|
805
|
+
NANO = "NANO"
|
|
806
|
+
}
|
|
807
|
+
/** @enumType */
|
|
808
|
+
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';
|
|
809
|
+
/** Site transferred to another user. */
|
|
810
|
+
interface SiteTransferred {
|
|
811
|
+
/**
|
|
812
|
+
* A previous owner id (user that transfers meta site).
|
|
813
|
+
* @format GUID
|
|
814
|
+
*/
|
|
815
|
+
oldOwnerId?: string;
|
|
816
|
+
/**
|
|
817
|
+
* A new owner id (user that accepts meta site).
|
|
818
|
+
* @format GUID
|
|
819
|
+
*/
|
|
820
|
+
newOwnerId?: string;
|
|
821
|
+
}
|
|
822
|
+
/** Soft deletion of the meta site. Could be restored. */
|
|
823
|
+
interface SiteDeleted {
|
|
824
|
+
/** A deletion context. */
|
|
825
|
+
deleteContext?: DeleteContext;
|
|
826
|
+
}
|
|
827
|
+
interface DeleteContext {
|
|
828
|
+
/** When the meta site was deleted. */
|
|
829
|
+
dateDeleted?: Date | null;
|
|
830
|
+
/** A status. */
|
|
831
|
+
deleteStatus?: DeleteStatusWithLiterals;
|
|
832
|
+
/**
|
|
833
|
+
* A reason (flow).
|
|
834
|
+
* @maxLength 255
|
|
835
|
+
*/
|
|
836
|
+
deleteOrigin?: string;
|
|
837
|
+
/**
|
|
838
|
+
* A service that deleted it.
|
|
839
|
+
* @maxLength 255
|
|
840
|
+
*/
|
|
841
|
+
initiatorId?: string | null;
|
|
842
|
+
}
|
|
843
|
+
declare enum DeleteStatus {
|
|
844
|
+
UNKNOWN = "UNKNOWN",
|
|
845
|
+
TRASH = "TRASH",
|
|
846
|
+
DELETED = "DELETED",
|
|
847
|
+
PENDING_PURGE = "PENDING_PURGE",
|
|
848
|
+
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
849
|
+
}
|
|
850
|
+
/** @enumType */
|
|
851
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
852
|
+
/** Restoration of the meta site. */
|
|
853
|
+
interface SiteUndeleted {
|
|
854
|
+
}
|
|
855
|
+
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
856
|
+
interface SitePublished {
|
|
857
|
+
}
|
|
858
|
+
interface SiteUnpublished {
|
|
859
|
+
/**
|
|
860
|
+
* A list of URLs previously associated with the meta site.
|
|
861
|
+
* @maxLength 4000
|
|
862
|
+
* @maxSize 10000
|
|
863
|
+
*/
|
|
864
|
+
urls?: string[];
|
|
865
|
+
}
|
|
866
|
+
interface SiteMarkedAsTemplate {
|
|
867
|
+
}
|
|
868
|
+
interface SiteMarkedAsWixSite {
|
|
869
|
+
}
|
|
870
|
+
/**
|
|
871
|
+
* Represents a service provisioned a site.
|
|
872
|
+
*
|
|
873
|
+
* Note on `origin_instance_id`:
|
|
874
|
+
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
875
|
+
* This is because of the following scenario:
|
|
876
|
+
*
|
|
877
|
+
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
878
|
+
* such as a product catalog. When you create a site from this template, you inherit this
|
|
879
|
+
* default product catalog. However, if the template's product catalog is modified,
|
|
880
|
+
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
881
|
+
* your site remains consistent with what you initially received and does not include any
|
|
882
|
+
* changes made to the original template afterward.
|
|
883
|
+
* To ensure this, the TPA on the template gets a new instance_id.
|
|
884
|
+
*/
|
|
885
|
+
interface ServiceProvisioned {
|
|
886
|
+
/**
|
|
887
|
+
* Either UUID or EmbeddedServiceType.
|
|
888
|
+
* @maxLength 36
|
|
889
|
+
*/
|
|
890
|
+
appDefId?: string;
|
|
891
|
+
/**
|
|
892
|
+
* Not only UUID. Something here could be something weird.
|
|
893
|
+
* @maxLength 36
|
|
894
|
+
*/
|
|
895
|
+
instanceId?: string;
|
|
896
|
+
/**
|
|
897
|
+
* An instance id from which this instance is originated.
|
|
898
|
+
* @maxLength 36
|
|
899
|
+
*/
|
|
900
|
+
originInstanceId?: string;
|
|
901
|
+
/**
|
|
902
|
+
* A version.
|
|
903
|
+
* @maxLength 500
|
|
904
|
+
*/
|
|
905
|
+
version?: string | null;
|
|
906
|
+
/**
|
|
907
|
+
* The origin meta site id
|
|
908
|
+
* @format GUID
|
|
909
|
+
*/
|
|
910
|
+
originMetaSiteId?: string | null;
|
|
911
|
+
}
|
|
912
|
+
interface ServiceRemoved {
|
|
913
|
+
/**
|
|
914
|
+
* Either UUID or EmbeddedServiceType.
|
|
915
|
+
* @maxLength 36
|
|
916
|
+
*/
|
|
917
|
+
appDefId?: string;
|
|
918
|
+
/**
|
|
919
|
+
* Not only UUID. Something here could be something weird.
|
|
920
|
+
* @maxLength 36
|
|
921
|
+
*/
|
|
922
|
+
instanceId?: string;
|
|
923
|
+
/**
|
|
924
|
+
* A version.
|
|
925
|
+
* @maxLength 500
|
|
926
|
+
*/
|
|
927
|
+
version?: string | null;
|
|
928
|
+
}
|
|
929
|
+
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
930
|
+
interface SiteRenamed {
|
|
931
|
+
/**
|
|
932
|
+
* A new meta site name (URL slug).
|
|
933
|
+
* @maxLength 20
|
|
934
|
+
*/
|
|
935
|
+
newSiteName?: string;
|
|
936
|
+
/**
|
|
937
|
+
* A previous meta site name (URL slug).
|
|
938
|
+
* @maxLength 255
|
|
939
|
+
*/
|
|
940
|
+
oldSiteName?: string;
|
|
941
|
+
}
|
|
942
|
+
/**
|
|
943
|
+
* Hard deletion of the meta site.
|
|
944
|
+
*
|
|
945
|
+
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
946
|
+
*/
|
|
947
|
+
interface SiteHardDeleted {
|
|
948
|
+
/** A deletion context. */
|
|
949
|
+
deleteContext?: DeleteContext;
|
|
950
|
+
}
|
|
951
|
+
interface NamespaceChanged {
|
|
952
|
+
/** A previous namespace. */
|
|
953
|
+
oldNamespace?: NamespaceWithLiterals;
|
|
954
|
+
/** A new namespace. */
|
|
955
|
+
newNamespace?: NamespaceWithLiterals;
|
|
956
|
+
}
|
|
957
|
+
/** Assigned Studio editor */
|
|
958
|
+
interface StudioAssigned {
|
|
959
|
+
}
|
|
960
|
+
/** Unassigned Studio editor */
|
|
961
|
+
interface StudioUnassigned {
|
|
962
|
+
}
|
|
963
|
+
/**
|
|
964
|
+
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
965
|
+
*
|
|
966
|
+
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
967
|
+
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
968
|
+
*
|
|
969
|
+
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
970
|
+
*/
|
|
971
|
+
interface SiteUrlChanged {
|
|
972
|
+
}
|
|
973
|
+
/**
|
|
974
|
+
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
975
|
+
* Consumed by other teams to remove relevant data.
|
|
976
|
+
*/
|
|
977
|
+
interface SitePurgedExternally {
|
|
978
|
+
/**
|
|
979
|
+
* @maxLength 2048
|
|
980
|
+
* @maxSize 100
|
|
981
|
+
* @deprecated
|
|
982
|
+
* @targetRemovalDate 2025-04-15
|
|
983
|
+
*/
|
|
984
|
+
appDefId?: string[];
|
|
985
|
+
}
|
|
986
|
+
/** Assigned Odeditor */
|
|
987
|
+
interface OdeditorAssigned {
|
|
988
|
+
}
|
|
989
|
+
/** Unassigned Odeditor */
|
|
990
|
+
interface OdeditorUnassigned {
|
|
991
|
+
}
|
|
992
|
+
/** Assigned Picasso editor */
|
|
993
|
+
interface PicassoAssigned {
|
|
994
|
+
}
|
|
995
|
+
/** Unassigned Picasso */
|
|
996
|
+
interface PicassoUnassigned {
|
|
997
|
+
}
|
|
998
|
+
interface Empty {
|
|
999
|
+
}
|
|
1000
|
+
/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
|
|
1001
|
+
interface SitePropertiesNotification {
|
|
1002
|
+
/** The site ID for which this update notification applies. */
|
|
1003
|
+
metasiteId?: string;
|
|
1004
|
+
/** The actual update event. */
|
|
1005
|
+
event?: SitePropertiesEvent;
|
|
1006
|
+
/**
|
|
1007
|
+
* A convenience set of mappings from the MetaSite ID to its constituent services.
|
|
1008
|
+
* @maxSize 500
|
|
1009
|
+
*/
|
|
1010
|
+
translations?: Translation[];
|
|
1011
|
+
/** Context of the notification */
|
|
1012
|
+
changeContext?: ChangeContext;
|
|
1013
|
+
}
|
|
1014
|
+
/** The actual update event for a particular notification. */
|
|
1015
|
+
interface SitePropertiesEvent {
|
|
1016
|
+
/** Version of the site's properties represented by this update. */
|
|
1017
|
+
version?: number;
|
|
1018
|
+
/** Set of properties that were updated - corresponds to the fields in "properties". */
|
|
1019
|
+
fields?: string[];
|
|
1020
|
+
/** Updated properties. */
|
|
1021
|
+
properties?: Properties;
|
|
1022
|
+
}
|
|
1023
|
+
interface Properties {
|
|
1024
|
+
/** Site categories. */
|
|
1025
|
+
categories?: Categories;
|
|
1026
|
+
/** Site locale. */
|
|
1027
|
+
locale?: Locale;
|
|
1028
|
+
/**
|
|
1029
|
+
* Site language.
|
|
1030
|
+
*
|
|
1031
|
+
* Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
|
|
1032
|
+
*/
|
|
1033
|
+
language?: string | null;
|
|
1034
|
+
/**
|
|
1035
|
+
* Site currency format used to bill customers.
|
|
1036
|
+
*
|
|
1037
|
+
* Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
1038
|
+
*/
|
|
1039
|
+
paymentCurrency?: string | null;
|
|
1040
|
+
/** Timezone in `America/New_York` format. */
|
|
1041
|
+
timeZone?: string | null;
|
|
1042
|
+
/** Email address. */
|
|
1043
|
+
email?: string | null;
|
|
1044
|
+
/** Phone number. */
|
|
1045
|
+
phone?: string | null;
|
|
1046
|
+
/** Fax number. */
|
|
1047
|
+
fax?: string | null;
|
|
1048
|
+
/** Address. */
|
|
1049
|
+
address?: Address;
|
|
1050
|
+
/** Site display name. */
|
|
1051
|
+
siteDisplayName?: string | null;
|
|
1052
|
+
/** Business name. */
|
|
1053
|
+
businessName?: string | null;
|
|
1054
|
+
/** Path to the site's logo in Wix Media (without Wix Media base URL). */
|
|
1055
|
+
logo?: string | null;
|
|
1056
|
+
/** Site description. */
|
|
1057
|
+
description?: string | null;
|
|
1058
|
+
/**
|
|
1059
|
+
* Business schedule. Regular and exceptional time periods when the business is open or the service is available.
|
|
1060
|
+
*
|
|
1061
|
+
* __Note:__ Not supported by Wix Bookings.
|
|
1062
|
+
*/
|
|
1063
|
+
businessSchedule?: BusinessSchedule;
|
|
1064
|
+
/** Supported languages of a site and the primary language. */
|
|
1065
|
+
multilingual?: Multilingual;
|
|
1066
|
+
/** Cookie policy the Wix user defined for their site (before the site visitor interacts with/limits it). */
|
|
1067
|
+
consentPolicy?: ConsentPolicy;
|
|
1068
|
+
/**
|
|
1069
|
+
* Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
|
|
1070
|
+
*
|
|
1071
|
+
* Site business type.
|
|
1072
|
+
*/
|
|
1073
|
+
businessConfig?: string | null;
|
|
1074
|
+
/** External site URL that uses Wix as its headless business solution. */
|
|
1075
|
+
externalSiteUrl?: string | null;
|
|
1076
|
+
/** Track clicks analytics. */
|
|
1077
|
+
trackClicksAnalytics?: boolean;
|
|
1078
|
+
}
|
|
1079
|
+
interface Categories {
|
|
1080
|
+
/** Primary site category. */
|
|
1081
|
+
primary?: string;
|
|
1082
|
+
/**
|
|
1083
|
+
* Secondary site category.
|
|
1084
|
+
* @maxSize 50
|
|
1085
|
+
*/
|
|
1086
|
+
secondary?: string[];
|
|
1087
|
+
/** Business Term Id */
|
|
1088
|
+
businessTermId?: string | null;
|
|
1089
|
+
}
|
|
1090
|
+
interface Locale {
|
|
1091
|
+
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1092
|
+
languageCode?: string;
|
|
1093
|
+
/** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
1094
|
+
country?: string;
|
|
1095
|
+
}
|
|
1096
|
+
interface Address {
|
|
1097
|
+
/** Street name. */
|
|
1098
|
+
street?: string;
|
|
1099
|
+
/** City name. */
|
|
1100
|
+
city?: string;
|
|
1101
|
+
/** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
|
|
1102
|
+
country?: string;
|
|
1103
|
+
/** State. */
|
|
1104
|
+
state?: string;
|
|
1105
|
+
/**
|
|
1106
|
+
* Zip or postal code.
|
|
1107
|
+
* @maxLength 20
|
|
1108
|
+
*/
|
|
1109
|
+
zip?: string;
|
|
1110
|
+
/** Extra information to be displayed in the address. */
|
|
1111
|
+
hint?: AddressHint;
|
|
1112
|
+
/** Whether this address represents a physical location. */
|
|
1113
|
+
isPhysical?: boolean;
|
|
1114
|
+
/** Google-formatted version of this address. */
|
|
1115
|
+
googleFormattedAddress?: string;
|
|
1116
|
+
/** Street number. */
|
|
1117
|
+
streetNumber?: string;
|
|
1118
|
+
/** Apartment number. */
|
|
1119
|
+
apartmentNumber?: string;
|
|
1120
|
+
/** Geographic coordinates of location. */
|
|
1121
|
+
coordinates?: GeoCoordinates;
|
|
1122
|
+
}
|
|
1123
|
+
/**
|
|
1124
|
+
* Extra information on displayed addresses.
|
|
1125
|
+
* This is used for display purposes. Used to add additional data about the address, such as "In the passage".
|
|
1126
|
+
* Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
|
|
1127
|
+
*/
|
|
1128
|
+
interface AddressHint {
|
|
1129
|
+
/** Extra text displayed next to, or instead of, the actual address. */
|
|
1130
|
+
text?: string;
|
|
1131
|
+
/** Where the extra text should be displayed. */
|
|
1132
|
+
placement?: PlacementTypeWithLiterals;
|
|
1133
|
+
}
|
|
1134
|
+
/** Where the extra text should be displayed: before, after or instead of the actual address. */
|
|
1135
|
+
declare enum PlacementType {
|
|
1136
|
+
BEFORE = "BEFORE",
|
|
1137
|
+
AFTER = "AFTER",
|
|
1138
|
+
REPLACE = "REPLACE"
|
|
1139
|
+
}
|
|
1140
|
+
/** @enumType */
|
|
1141
|
+
type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
|
|
1142
|
+
/** Geocoordinates for a particular address. */
|
|
1143
|
+
interface GeoCoordinates {
|
|
1144
|
+
/** Latitude of the location. Must be between -90 and 90. */
|
|
1145
|
+
latitude?: number;
|
|
1146
|
+
/** Longitude of the location. Must be between -180 and 180. */
|
|
1147
|
+
longitude?: number;
|
|
1148
|
+
}
|
|
1149
|
+
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
1150
|
+
interface BusinessSchedule {
|
|
1151
|
+
/**
|
|
1152
|
+
* Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
|
|
1153
|
+
* @maxSize 100
|
|
1154
|
+
*/
|
|
1155
|
+
periods?: TimePeriod[];
|
|
1156
|
+
/**
|
|
1157
|
+
* Exceptions to the business's regular hours. The business can be open or closed during the exception.
|
|
1158
|
+
* @maxSize 100
|
|
1159
|
+
*/
|
|
1160
|
+
specialHourPeriod?: SpecialHourPeriod[];
|
|
1161
|
+
}
|
|
1162
|
+
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
1163
|
+
interface TimePeriod {
|
|
1164
|
+
/** Day of the week the period starts on. */
|
|
1165
|
+
openDay?: DayOfWeekWithLiterals;
|
|
1166
|
+
/**
|
|
1167
|
+
* Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
|
|
1168
|
+
* midnight at the end of the specified day.
|
|
1169
|
+
*/
|
|
1170
|
+
openTime?: string;
|
|
1171
|
+
/** Day of the week the period ends on. */
|
|
1172
|
+
closeDay?: DayOfWeekWithLiterals;
|
|
1173
|
+
/**
|
|
1174
|
+
* Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
|
|
1175
|
+
* midnight at the end of the specified day.
|
|
1176
|
+
*
|
|
1177
|
+
* __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
|
|
1178
|
+
*/
|
|
1179
|
+
closeTime?: string;
|
|
1180
|
+
}
|
|
1181
|
+
/** Enumerates the days of the week. */
|
|
1182
|
+
declare enum DayOfWeek {
|
|
1183
|
+
MONDAY = "MONDAY",
|
|
1184
|
+
TUESDAY = "TUESDAY",
|
|
1185
|
+
WEDNESDAY = "WEDNESDAY",
|
|
1186
|
+
THURSDAY = "THURSDAY",
|
|
1187
|
+
FRIDAY = "FRIDAY",
|
|
1188
|
+
SATURDAY = "SATURDAY",
|
|
1189
|
+
SUNDAY = "SUNDAY"
|
|
1190
|
+
}
|
|
1191
|
+
/** @enumType */
|
|
1192
|
+
type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
|
|
1193
|
+
/** Exception to the business's regular hours. The business can be open or closed during the exception. */
|
|
1194
|
+
interface SpecialHourPeriod {
|
|
1195
|
+
/** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
|
|
1196
|
+
startDate?: string;
|
|
1197
|
+
/** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
|
|
1198
|
+
endDate?: string;
|
|
1199
|
+
/**
|
|
1200
|
+
* Whether the business is closed (or the service is not available) during the exception.
|
|
1201
|
+
*
|
|
1202
|
+
* Default: `true`.
|
|
1203
|
+
*/
|
|
1204
|
+
isClosed?: boolean;
|
|
1205
|
+
/** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
|
|
1206
|
+
comment?: string;
|
|
1207
|
+
}
|
|
1208
|
+
interface Multilingual {
|
|
1209
|
+
/**
|
|
1210
|
+
* Supported languages list.
|
|
1211
|
+
* @maxSize 200
|
|
1212
|
+
*/
|
|
1213
|
+
supportedLanguages?: SupportedLanguage[];
|
|
1214
|
+
/** Whether to redirect to user language. */
|
|
1215
|
+
autoRedirect?: boolean;
|
|
1216
|
+
}
|
|
1217
|
+
interface SupportedLanguage {
|
|
1218
|
+
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1219
|
+
languageCode?: string;
|
|
1220
|
+
/** Locale. */
|
|
1221
|
+
locale?: Locale;
|
|
1222
|
+
/** Whether the supported language is the primary language for the site. */
|
|
1223
|
+
isPrimary?: boolean;
|
|
1224
|
+
/** Language icon. */
|
|
1225
|
+
countryCode?: string;
|
|
1226
|
+
/** How the language will be resolved. For internal use. */
|
|
1227
|
+
resolutionMethod?: ResolutionMethodWithLiterals;
|
|
1228
|
+
/** Whether the supported language is the primary language for site visitors. */
|
|
1229
|
+
isVisitorPrimary?: boolean | null;
|
|
1230
|
+
}
|
|
1231
|
+
declare enum ResolutionMethod {
|
|
1232
|
+
QUERY_PARAM = "QUERY_PARAM",
|
|
1233
|
+
SUBDOMAIN = "SUBDOMAIN",
|
|
1234
|
+
SUBDIRECTORY = "SUBDIRECTORY"
|
|
1235
|
+
}
|
|
1236
|
+
/** @enumType */
|
|
1237
|
+
type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
|
|
1238
|
+
interface ConsentPolicy {
|
|
1239
|
+
/** Whether the site uses cookies that are essential to site operation. Always `true`. */
|
|
1240
|
+
essential?: boolean | null;
|
|
1241
|
+
/** Whether the site uses cookies that affect site performance and other functional measurements. */
|
|
1242
|
+
functional?: boolean | null;
|
|
1243
|
+
/** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
|
|
1244
|
+
analytics?: boolean | null;
|
|
1245
|
+
/** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
|
|
1246
|
+
advertising?: boolean | null;
|
|
1247
|
+
/** CCPA compliance flag. */
|
|
1248
|
+
dataToThirdParty?: boolean | null;
|
|
1249
|
+
}
|
|
1250
|
+
/** A single mapping from the MetaSite ID to a particular service. */
|
|
1251
|
+
interface Translation {
|
|
1252
|
+
/** The service type. */
|
|
1253
|
+
serviceType?: string;
|
|
1254
|
+
/** The application definition ID; this only applies to services of type ThirdPartyApps. */
|
|
1255
|
+
appDefId?: string;
|
|
1256
|
+
/** The instance ID of the service. */
|
|
1257
|
+
instanceId?: string;
|
|
1258
|
+
}
|
|
1259
|
+
interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
1260
|
+
/** Properties were updated. */
|
|
1261
|
+
propertiesChange?: PropertiesChange;
|
|
1262
|
+
/** Default properties were created on site creation. */
|
|
1263
|
+
siteCreated?: V4SiteCreated;
|
|
1264
|
+
/** Properties were cloned on site cloning. */
|
|
1265
|
+
siteCloned?: SiteCloned;
|
|
1266
|
+
}
|
|
1267
|
+
/** @oneof */
|
|
1268
|
+
interface ChangeContextPayloadOneOf {
|
|
1269
|
+
/** Properties were updated. */
|
|
1270
|
+
propertiesChange?: PropertiesChange;
|
|
1271
|
+
/** Default properties were created on site creation. */
|
|
1272
|
+
siteCreated?: V4SiteCreated;
|
|
1273
|
+
/** Properties were cloned on site cloning. */
|
|
1274
|
+
siteCloned?: SiteCloned;
|
|
1275
|
+
}
|
|
1276
|
+
interface PropertiesChange {
|
|
1277
|
+
}
|
|
1278
|
+
interface V4SiteCreated {
|
|
1279
|
+
/** Origin template site id. */
|
|
1280
|
+
originTemplateId?: string | null;
|
|
1281
|
+
}
|
|
1282
|
+
interface SiteCloned {
|
|
1283
|
+
/** Origin site id. */
|
|
1284
|
+
originMetaSiteId?: string;
|
|
1285
|
+
}
|
|
1286
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1287
|
+
createdEvent?: EntityCreatedEvent;
|
|
1288
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1289
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1290
|
+
actionEvent?: ActionEvent;
|
|
1291
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1292
|
+
id?: string;
|
|
1293
|
+
/**
|
|
1294
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1295
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1296
|
+
*/
|
|
1297
|
+
entityFqdn?: string;
|
|
1298
|
+
/**
|
|
1299
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1300
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1301
|
+
*/
|
|
1302
|
+
slug?: string;
|
|
1303
|
+
/** ID of the entity associated with the event. */
|
|
1304
|
+
entityId?: string;
|
|
1305
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1306
|
+
eventTime?: Date | null;
|
|
1307
|
+
/**
|
|
1308
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1309
|
+
* (for example, GDPR).
|
|
1310
|
+
*/
|
|
1311
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1312
|
+
/** If present, indicates the action that triggered the event. */
|
|
1313
|
+
originatedFrom?: string | null;
|
|
1314
|
+
/**
|
|
1315
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
1316
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
1317
|
+
*/
|
|
1318
|
+
entityEventSequence?: string | null;
|
|
1319
|
+
}
|
|
1320
|
+
/** @oneof */
|
|
1321
|
+
interface DomainEventBodyOneOf {
|
|
1322
|
+
createdEvent?: EntityCreatedEvent;
|
|
1323
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1324
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1325
|
+
actionEvent?: ActionEvent;
|
|
1326
|
+
}
|
|
1327
|
+
interface EntityCreatedEvent {
|
|
1328
|
+
entityAsJson?: string;
|
|
1329
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
1330
|
+
restoreInfo?: RestoreInfo;
|
|
1331
|
+
}
|
|
1332
|
+
interface RestoreInfo {
|
|
1333
|
+
deletedDate?: Date | null;
|
|
1334
|
+
}
|
|
1335
|
+
interface EntityUpdatedEvent {
|
|
1336
|
+
/**
|
|
1337
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1338
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1339
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1340
|
+
*/
|
|
1341
|
+
currentEntityAsJson?: string;
|
|
1342
|
+
}
|
|
1343
|
+
interface EntityDeletedEvent {
|
|
1344
|
+
/** Entity that was deleted. */
|
|
1345
|
+
deletedEntityAsJson?: string | null;
|
|
1346
|
+
}
|
|
1347
|
+
interface ActionEvent {
|
|
1348
|
+
bodyAsJson?: string;
|
|
1349
|
+
}
|
|
1350
|
+
interface MessageEnvelope {
|
|
1351
|
+
/**
|
|
1352
|
+
* App instance ID.
|
|
1353
|
+
* @format GUID
|
|
1354
|
+
*/
|
|
1355
|
+
instanceId?: string | null;
|
|
1356
|
+
/**
|
|
1357
|
+
* Event type.
|
|
1358
|
+
* @maxLength 150
|
|
1359
|
+
*/
|
|
1360
|
+
eventType?: string;
|
|
1361
|
+
/** The identification type and identity data. */
|
|
1362
|
+
identity?: IdentificationData;
|
|
1363
|
+
/** Stringify payload. */
|
|
1364
|
+
data?: string;
|
|
1365
|
+
}
|
|
1366
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1367
|
+
/**
|
|
1368
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1369
|
+
* @format GUID
|
|
1370
|
+
*/
|
|
1371
|
+
anonymousVisitorId?: string;
|
|
1372
|
+
/**
|
|
1373
|
+
* ID of a site visitor that has logged in to the site.
|
|
1374
|
+
* @format GUID
|
|
1375
|
+
*/
|
|
1376
|
+
memberId?: string;
|
|
1377
|
+
/**
|
|
1378
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1379
|
+
* @format GUID
|
|
1380
|
+
*/
|
|
1381
|
+
wixUserId?: string;
|
|
1382
|
+
/**
|
|
1383
|
+
* ID of an app.
|
|
1384
|
+
* @format GUID
|
|
1385
|
+
*/
|
|
1386
|
+
appId?: string;
|
|
1387
|
+
/** @readonly */
|
|
1388
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1389
|
+
}
|
|
1390
|
+
/** @oneof */
|
|
1391
|
+
interface IdentificationDataIdOneOf {
|
|
1392
|
+
/**
|
|
1393
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1394
|
+
* @format GUID
|
|
1395
|
+
*/
|
|
1396
|
+
anonymousVisitorId?: string;
|
|
1397
|
+
/**
|
|
1398
|
+
* ID of a site visitor that has logged in to the site.
|
|
1399
|
+
* @format GUID
|
|
1400
|
+
*/
|
|
1401
|
+
memberId?: string;
|
|
1402
|
+
/**
|
|
1403
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1404
|
+
* @format GUID
|
|
1405
|
+
*/
|
|
1406
|
+
wixUserId?: string;
|
|
1407
|
+
/**
|
|
1408
|
+
* ID of an app.
|
|
1409
|
+
* @format GUID
|
|
1410
|
+
*/
|
|
1411
|
+
appId?: string;
|
|
1412
|
+
}
|
|
1413
|
+
declare enum WebhookIdentityType {
|
|
1414
|
+
UNKNOWN = "UNKNOWN",
|
|
1415
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1416
|
+
MEMBER = "MEMBER",
|
|
1417
|
+
WIX_USER = "WIX_USER",
|
|
1418
|
+
APP = "APP"
|
|
1419
|
+
}
|
|
1420
|
+
/** @enumType */
|
|
1421
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1422
|
+
/** @docsIgnore */
|
|
1423
|
+
type UpdateScheduleApplicationErrors = {
|
|
1424
|
+
code?: 'UPDATE_CANCELLED_SCHEDULE_NOT_ALLOWED';
|
|
1425
|
+
description?: string;
|
|
1426
|
+
data?: Record<string, any>;
|
|
1427
|
+
};
|
|
1428
|
+
/** @docsIgnore */
|
|
1429
|
+
type CancelScheduleApplicationErrors = {
|
|
1430
|
+
code?: 'SCHEDULE_ALREADY_CANCELLED';
|
|
1431
|
+
description?: string;
|
|
1432
|
+
data?: Record<string, any>;
|
|
1433
|
+
};
|
|
475
1434
|
|
|
476
1435
|
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
477
1436
|
getUrl: (context: any) => string;
|
|
@@ -495,4 +1454,4 @@ declare function cancelSchedule(): __PublicMethodMetaInfo<'POST', {
|
|
|
495
1454
|
scheduleId: string;
|
|
496
1455
|
}, CancelScheduleRequest$1, CancelScheduleRequest, CancelScheduleResponse$1, CancelScheduleResponse>;
|
|
497
1456
|
|
|
498
|
-
export { type __PublicMethodMetaInfo, cancelSchedule, createSchedule, getSchedule, querySchedules, updateSchedule };
|
|
1457
|
+
export { type ActionEvent as ActionEventOriginal, type AddressHint as AddressHintOriginal, type Address as AddressOriginal, type Asset as AssetOriginal, type BusinessSchedule as BusinessScheduleOriginal, type CancelScheduleApplicationErrors as CancelScheduleApplicationErrorsOriginal, type CancelScheduleRequest as CancelScheduleRequestOriginal, type CancelScheduleResponse as CancelScheduleResponseOriginal, type Categories as CategoriesOriginal, type ChangeContext as ChangeContextOriginal, type ChangeContextPayloadOneOf as ChangeContextPayloadOneOfOriginal, type CloneScheduleRequest as CloneScheduleRequestOriginal, type CloneScheduleResponse as CloneScheduleResponseOriginal, type CommonIdentificationDataIdOneOf as CommonIdentificationDataIdOneOfOriginal, type CommonIdentificationData as CommonIdentificationDataOriginal, type ConferencingDetails as ConferencingDetailsOriginal, type ConsentPolicy as ConsentPolicyOriginal, type CreateScheduleRequest as CreateScheduleRequestOriginal, type CreateScheduleResponse as CreateScheduleResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, DayOfWeek as DayOfWeekOriginal, type DayOfWeekWithLiterals as DayOfWeekWithLiteralsOriginal, type DeleteContext as DeleteContextOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type GeoCoordinates as GeoCoordinatesOriginal, type GetScheduleRequest as GetScheduleRequestOriginal, type GetScheduleResponse as GetScheduleResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, IdentityType as IdentityTypeOriginal, type IdentityTypeWithLiterals as IdentityTypeWithLiteralsOriginal, type Locale as LocaleOriginal, type Location as LocationOriginal, LocationType as LocationTypeOriginal, type LocationTypeWithLiterals as LocationTypeWithLiteralsOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type Multilingual as MultilingualOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, type ParticipantNotification as ParticipantNotificationOriginal, type Permission as PermissionOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, PlacementType as PlacementTypeOriginal, type PlacementTypeWithLiterals as PlacementTypeWithLiteralsOriginal, type PropertiesChange as PropertiesChangeOriginal, type Properties as PropertiesOriginal, type QuerySchedulesRequest as QuerySchedulesRequestOriginal, type QuerySchedulesResponse as QuerySchedulesResponseOriginal, RequestedFields as RequestedFieldsOriginal, type RequestedFieldsWithLiterals as RequestedFieldsWithLiteralsOriginal, ResolutionMethod as ResolutionMethodOriginal, type ResolutionMethodWithLiterals as ResolutionMethodWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, Role as RoleOriginal, type RoleWithLiterals as RoleWithLiteralsOriginal, type ScheduleCancelled as ScheduleCancelledOriginal, type ScheduleCloned as ScheduleClonedOriginal, type Schedule as ScheduleOriginal, type ScheduleUpdatedWithMetadata as ScheduleUpdatedWithMetadataOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type SiteCloned as SiteClonedOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePropertiesEvent as SitePropertiesEventOriginal, type SitePropertiesNotification as SitePropertiesNotificationOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, type SpecialHourPeriod as SpecialHourPeriodOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type SupportedLanguage as SupportedLanguageOriginal, type TimePeriod as TimePeriodOriginal, type Translation as TranslationOriginal, Trigger as TriggerOriginal, type TriggerWithLiterals as TriggerWithLiteralsOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, type UpdateScheduleApplicationErrors as UpdateScheduleApplicationErrorsOriginal, type UpdateScheduleRequest as UpdateScheduleRequestOriginal, type UpdateScheduleResponse as UpdateScheduleResponseOriginal, type V4SiteCreated as V4SiteCreatedOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, cancelSchedule, createSchedule, getSchedule, querySchedules, updateSchedule };
|