@wix/auto_sdk_pricing-plans_pricing-plans-settings 1.0.11 → 1.0.13

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.
Files changed (37) hide show
  1. package/build/cjs/index.d.ts +1 -1
  2. package/build/cjs/index.js +173 -0
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +1106 -1
  5. package/build/cjs/index.typings.js +173 -0
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +1106 -1
  8. package/build/cjs/meta.js +173 -0
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +1 -1
  11. package/build/es/index.mjs +158 -0
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +1106 -1
  14. package/build/es/index.typings.mjs +158 -0
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +1106 -1
  17. package/build/es/meta.mjs +158 -0
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/internal/cjs/index.d.ts +1 -1
  20. package/build/internal/cjs/index.js +173 -0
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +1106 -1
  23. package/build/internal/cjs/index.typings.js +173 -0
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +1106 -1
  26. package/build/internal/cjs/meta.js +173 -0
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/internal/es/index.d.mts +1 -1
  29. package/build/internal/es/index.mjs +158 -0
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +1106 -1
  32. package/build/internal/es/index.typings.mjs +158 -0
  33. package/build/internal/es/index.typings.mjs.map +1 -1
  34. package/build/internal/es/meta.d.mts +1106 -1
  35. package/build/internal/es/meta.mjs +158 -0
  36. package/build/internal/es/meta.mjs.map +1 -1
  37. package/package.json +3 -3
@@ -547,6 +547,1111 @@ interface CancelRequestedReason {
547
547
  }
548
548
  interface Empty {
549
549
  }
550
+ interface SubscriptionEvent extends SubscriptionEventEventOneOf {
551
+ /** Triggered when a subscription is created. */
552
+ created?: SubscriptionCreated;
553
+ /**
554
+ * Triggered when a subscription is assigned to a Wix site, including the initial
555
+ * assignment of a floating subscription or a re-assignement from a different site.
556
+ */
557
+ assigned?: SubscriptionAssigned;
558
+ /** Triggered when a subscription is canceled. */
559
+ cancelled?: SubscriptionCancelled;
560
+ /** Triggered when the subscription's auto renew is turned on. */
561
+ autoRenewTurnedOn?: SubscriptionAutoRenewTurnedOn;
562
+ /** Triggered when the subscription's auto renew is turned off. */
563
+ autoRenewTurnedOff?: SubscriptionAutoRenewTurnedOff;
564
+ /**
565
+ * Triggered when a subscription is unassigned from a Wix site and becomes
566
+ * floating.
567
+ */
568
+ unassigned?: SubscriptionUnassigned;
569
+ /**
570
+ * Triggered when a subscription is transferred from one Wix account to another.
571
+ * A transfer includes cancelling the original subscription and creating a new
572
+ * subscription for the target account. The event returns both the original
573
+ * and the new subscription.
574
+ */
575
+ transferred?: SubscriptionTransferred;
576
+ /** Triggered when a recurring charge succeeds for a subscription. */
577
+ recurringChargeSucceeded?: RecurringChargeSucceeded;
578
+ /**
579
+ * Triggered when a subscription was updated including when its product has been
580
+ * up- or downgraded or the billing cycle is changed.
581
+ */
582
+ contractSwitched?: ContractSwitched;
583
+ /**
584
+ * Triggered when a subscription gets close to the end of its billing cycle.
585
+ * The exact number of days is defined in the billing system.
586
+ */
587
+ nearEndOfPeriod?: SubscriptionNearEndOfPeriod;
588
+ /**
589
+ * Triggered when a subscription is updated and the change doesn't happen
590
+ * immediately but at the end of the current billing cycle.
591
+ */
592
+ pendingChange?: SubscriptionPendingChange;
593
+ /** Triggered when a recurring charge attempt fails for a subscription. */
594
+ recurringChargeAttemptFailed?: RecurringChargeAttemptFailed;
595
+ /**
596
+ * ID of the subscription's event.
597
+ * @format GUID
598
+ */
599
+ eventId?: string | null;
600
+ /**
601
+ * Date and time of the event in
602
+ * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
603
+ * `YYYY-MM-DDThh:mm:ss.sssZ` format.
604
+ */
605
+ eventDate?: Date | null;
606
+ }
607
+ /** @oneof */
608
+ interface SubscriptionEventEventOneOf {
609
+ /** Triggered when a subscription is created. */
610
+ created?: SubscriptionCreated;
611
+ /**
612
+ * Triggered when a subscription is assigned to a Wix site, including the initial
613
+ * assignment of a floating subscription or a re-assignement from a different site.
614
+ */
615
+ assigned?: SubscriptionAssigned;
616
+ /** Triggered when a subscription is canceled. */
617
+ cancelled?: SubscriptionCancelled;
618
+ /** Triggered when the subscription's auto renew is turned on. */
619
+ autoRenewTurnedOn?: SubscriptionAutoRenewTurnedOn;
620
+ /** Triggered when the subscription's auto renew is turned off. */
621
+ autoRenewTurnedOff?: SubscriptionAutoRenewTurnedOff;
622
+ /**
623
+ * Triggered when a subscription is unassigned from a Wix site and becomes
624
+ * floating.
625
+ */
626
+ unassigned?: SubscriptionUnassigned;
627
+ /**
628
+ * Triggered when a subscription is transferred from one Wix account to another.
629
+ * A transfer includes cancelling the original subscription and creating a new
630
+ * subscription for the target account. The event returns both the original
631
+ * and the new subscription.
632
+ */
633
+ transferred?: SubscriptionTransferred;
634
+ /** Triggered when a recurring charge succeeds for a subscription. */
635
+ recurringChargeSucceeded?: RecurringChargeSucceeded;
636
+ /**
637
+ * Triggered when a subscription was updated including when its product has been
638
+ * up- or downgraded or the billing cycle is changed.
639
+ */
640
+ contractSwitched?: ContractSwitched;
641
+ /**
642
+ * Triggered when a subscription gets close to the end of its billing cycle.
643
+ * The exact number of days is defined in the billing system.
644
+ */
645
+ nearEndOfPeriod?: SubscriptionNearEndOfPeriod;
646
+ /**
647
+ * Triggered when a subscription is updated and the change doesn't happen
648
+ * immediately but at the end of the current billing cycle.
649
+ */
650
+ pendingChange?: SubscriptionPendingChange;
651
+ /** Triggered when a recurring charge attempt fails for a subscription. */
652
+ recurringChargeAttemptFailed?: RecurringChargeAttemptFailed;
653
+ }
654
+ /** Triggered when a subscription is created. */
655
+ interface SubscriptionCreated {
656
+ /** Created subscription. */
657
+ subscription?: Subscription;
658
+ /** Metadata for the `created` event. */
659
+ metadata?: Record<string, string>;
660
+ /**
661
+ * Subscription reactivation data.
662
+ * A subscription can be reactivated for example if it was incorrectly canceled because of fraud and then reactivated
663
+ * by the billing system
664
+ */
665
+ reactivationData?: ReactivationData;
666
+ }
667
+ /**
668
+ * A subscription holds information about a Premium product that a Wix account
669
+ * owner has purchased including details about the billing.
670
+ */
671
+ interface Subscription {
672
+ /**
673
+ * ID of the subscription.
674
+ * @format GUID
675
+ */
676
+ _id?: string;
677
+ /**
678
+ * ID of the Wix account that purchased the subscription.
679
+ * @format GUID
680
+ */
681
+ userId?: string;
682
+ /**
683
+ * ID of the [product](https://bo.wix.com/wix-docs/rest/premium/premium-product-catalog-v2/products/product-object)
684
+ * for which the subscription was purchased.
685
+ * @format GUID
686
+ */
687
+ productId?: string;
688
+ /**
689
+ * Date and time the subscription was created in
690
+ * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
691
+ * `YYYY-MM-DDThh:mm:ss.sssZ` format.
692
+ */
693
+ createdAt?: Date | null;
694
+ /**
695
+ * Date and time the subscription was last updated in
696
+ * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
697
+ * `YYYY-MM-DDThh:mm:ss.sssZ` format.
698
+ */
699
+ updatedAt?: Date | null;
700
+ /**
701
+ * ID of the metasite that the subscription is assigned to.
702
+ * Available only when the subscription is assigned to a Wix site.
703
+ * Subscriptions for account level products can't be assigned to a Wix site.
704
+ * @format GUID
705
+ */
706
+ metaSiteId?: string | null;
707
+ /** Information about the system that manages the subscription's billing. */
708
+ billingReference?: BillingReference;
709
+ /** Information about the billing cycle of the subscription. */
710
+ cycle?: Cycle;
711
+ /**
712
+ * Subscription status.
713
+ *
714
+ * + `UNKNOWN`: Default status.
715
+ * + `AUTO_RENEW_ON`: Subscription is active and automatically renews at the end of the current billing cycle.
716
+ * + `AUTO_RENEW_OFF`: Subscription is active but expires at the end of the current billing cycle.
717
+ * + `MANUAL_RECURRING`: Subscription is active and renews at the end of the current billing cycle, in case the customer takes an action related to the payment.
718
+ * + `CANCELLED`: Subscription isn't active because it has been canceled.
719
+ * + `TRANSFERRED`: Subscription isn't active because it has been transferred to a different account. A different active subscription was created for the target account.
720
+ */
721
+ status?: SubscriptionStatusWithLiterals;
722
+ /**
723
+ * Date and time the subscription was last transferred from one Wix account to
724
+ * another in
725
+ * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
726
+ * `YYYY-MM-DDThh:mm:ss.sssZ` format.
727
+ */
728
+ transferredAt?: Date | null;
729
+ /**
730
+ * ID of the [product type](https://bo.wix.com/wix-docs/rest/premium/premium-product-catalog-v2/product-types/product-type-object)
731
+ * that the product, for which the subscription was purchased, belongs to.
732
+ * @format GUID
733
+ */
734
+ productTypeId?: string;
735
+ /** Version number, which increments by 1 each time the subscription is updated. */
736
+ version?: number;
737
+ /**
738
+ * Whether the subscription is active. Includes the statuses
739
+ * `"AUTO_RENEW_ON"`, `"AUTO_RENEW_OFF"`, and `"MANUAL_RECURRING"`.
740
+ */
741
+ active?: boolean;
742
+ /**
743
+ * Date and time the subscription was originally created in
744
+ * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
745
+ * `YYYY-MM-DDThh:mm:ss.sssZ` format.
746
+ * Differs from `createdAt` in case the subscription was originally created for a different Wix account and has been transferred.
747
+ */
748
+ originalCreationDate?: Date | null;
749
+ /** Custom metadata about the subscription. */
750
+ metadata?: Record<string, string>;
751
+ /**
752
+ * 2-letter country code in
753
+ * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
754
+ * format.
755
+ */
756
+ countryCode?: string | null;
757
+ /**
758
+ * Seats of the product that the subscription was purchased for.
759
+ * Will be Null for products that don't support seats.
760
+ * @min 1
761
+ * @max 500
762
+ */
763
+ seats?: number | null;
764
+ }
765
+ interface BillingReference {
766
+ /**
767
+ * Name of the billing system that manages the subscription.
768
+ *
769
+ * + `"UNKNOWN"`: Default value.
770
+ * + `"SBS"`: [Wix Billing](https://github.com/wix-p/premium-billing/tree/master/sbs).
771
+ * + `"LICENSER"`:
772
+ * + `"BASS"`: [Billing and Subscriptions System](https://dev.wix.com/docs/rest/internal-only/premium/subscriptions-by-billing-by-wix/introduction).
773
+ * + `"RESELLER"`: [External Reseller](https://dev.wix.com/api/rest/account-level-apis/resellers/introduction).
774
+ */
775
+ providerName?: ProviderNameWithLiterals;
776
+ /** Current provider reference ID. */
777
+ providerReferenceId?: string | null;
778
+ /** Previous provider reference IDs. Used for when a subscription is extended, specifically for domains. */
779
+ previousProviderReferenceIds?: string[];
780
+ }
781
+ declare enum ProviderName {
782
+ UNKNOWN = "UNKNOWN",
783
+ SBS = "SBS",
784
+ LICENSER = "LICENSER",
785
+ BASS = "BASS",
786
+ RESELLER = "RESELLER",
787
+ RECURRING_INVOICES = "RECURRING_INVOICES"
788
+ }
789
+ /** @enumType */
790
+ type ProviderNameWithLiterals = ProviderName | 'UNKNOWN' | 'SBS' | 'LICENSER' | 'BASS' | 'RESELLER' | 'RECURRING_INVOICES';
791
+ interface Cycle extends CycleCycleSelectorOneOf {
792
+ /** repetitive interval */
793
+ interval?: Interval;
794
+ /** one time */
795
+ oneTime?: OneTime;
796
+ }
797
+ /** @oneof */
798
+ interface CycleCycleSelectorOneOf {
799
+ /** repetitive interval */
800
+ interval?: Interval;
801
+ /** one time */
802
+ oneTime?: OneTime;
803
+ }
804
+ interface Interval {
805
+ /** interval unit of measure */
806
+ unit?: IntervalUnitWithLiterals;
807
+ /** number of interval */
808
+ count?: number;
809
+ }
810
+ declare enum IntervalUnit {
811
+ /** unknown interval unit */
812
+ UNKNOWN = "UNKNOWN",
813
+ /** day */
814
+ DAY = "DAY",
815
+ /** week */
816
+ WEEK = "WEEK",
817
+ /** month */
818
+ MONTH = "MONTH",
819
+ /** year */
820
+ YEAR = "YEAR"
821
+ }
822
+ /** @enumType */
823
+ type IntervalUnitWithLiterals = IntervalUnit | 'UNKNOWN' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
824
+ interface OneTime {
825
+ }
826
+ declare enum SubscriptionStatus {
827
+ UNKNOWN = "UNKNOWN",
828
+ AUTO_RENEW_ON = "AUTO_RENEW_ON",
829
+ AUTO_RENEW_OFF = "AUTO_RENEW_OFF",
830
+ MANUAL_RECURRING = "MANUAL_RECURRING",
831
+ CANCELLED = "CANCELLED",
832
+ TRANSFERRED = "TRANSFERRED"
833
+ }
834
+ /** @enumType */
835
+ type SubscriptionStatusWithLiterals = SubscriptionStatus | 'UNKNOWN' | 'AUTO_RENEW_ON' | 'AUTO_RENEW_OFF' | 'MANUAL_RECURRING' | 'CANCELLED' | 'TRANSFERRED';
836
+ /** Triggered when a subscription is reactivated. */
837
+ interface ReactivationData {
838
+ reactivationReason?: ReactivationReasonEnumWithLiterals;
839
+ /**
840
+ * In the event of reactivation after chargeback dispute, the subscription may be extended according to the
841
+ * number of days it was inactive during the time of resolving the dispute
842
+ */
843
+ newEndOfPeriod?: Date | null;
844
+ /** The original end date, before the inactive period. */
845
+ oldEndOfPeriod?: Date | null;
846
+ /** The difference in days between the new new_end_of_period and old_end_of_period */
847
+ differenceInDays?: number | null;
848
+ }
849
+ /** Reason for subscription reactivation */
850
+ declare enum ReactivationReasonEnum {
851
+ UNKNOWN = "UNKNOWN",
852
+ /**
853
+ * Subscription was reactivated due to billing status change from CANCELED to ACTIVE, for example if it was incorrectly
854
+ * canceled because of suspicion of fraud
855
+ */
856
+ BILLING_STATUS_CHANGE = "BILLING_STATUS_CHANGE",
857
+ /** Subscription was reactivated after a chargeback dispute */
858
+ REACTIVATED_AFTER_CHARGEBACK = "REACTIVATED_AFTER_CHARGEBACK"
859
+ }
860
+ /** @enumType */
861
+ type ReactivationReasonEnumWithLiterals = ReactivationReasonEnum | 'UNKNOWN' | 'BILLING_STATUS_CHANGE' | 'REACTIVATED_AFTER_CHARGEBACK';
862
+ /**
863
+ * Triggered when a subscription is assigned to a Wix site, including the initial
864
+ * assignment of a floating subscription or a re-assignement from a different site.
865
+ */
866
+ interface SubscriptionAssigned {
867
+ /** Assigned subscription. */
868
+ subscription?: Subscription;
869
+ /**
870
+ * ID of the metasite that the subscription has been assigned to before the update.
871
+ * @format GUID
872
+ */
873
+ previousMetaSiteId?: string | null;
874
+ }
875
+ /** Triggered when a subscription is canceled. */
876
+ interface SubscriptionCancelled {
877
+ /** Canceled subscription. */
878
+ subscription?: Subscription;
879
+ /** Details about the cancellation including who canceled the subscription and why. */
880
+ cancellationDetails?: CancellationDetails;
881
+ /**
882
+ * Whether the subscription is canceled immediately or expires at the end of the current billing cycle.
883
+ *
884
+ * Default: `false`
885
+ */
886
+ immediateCancel?: boolean;
887
+ /** Whether the subscription was canceled during the free trial period. */
888
+ canceledInFreeTrial?: boolean;
889
+ /** The type of refund applied to the cancellation. */
890
+ refundType?: RefundTypeWithLiterals;
891
+ }
892
+ /** Information about the cancellation flow including who canceled the subscription and why it was canceled. */
893
+ interface CancellationDetails {
894
+ /**
895
+ * Cancellation code.
896
+ *
897
+ * Values supported for cancellations on behalf of the billing system: `-1`, `-2`, `-3`, `-4`, `-5`, `-6`, `-7`, `-8`.
898
+ * For cancellations on behalf of the site owner or the service provider `cancellationCode`
899
+ * is taken from the request of
900
+ * [Cancel Immediately Offline](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately-offline).
901
+ *
902
+ * + `-1`: The subscription has been cancelled by the billing system but none of the listed cancellation reasons applies.
903
+ * + `-2`: There were payment problems.
904
+ * + `-3`: There was a chargeback.
905
+ * + `-4`: Customer support has canceled the subscription and issued a refund.
906
+ * + `-5`: The site owner has changed their existing subscription.
907
+ * + `-6`: The subscription has been transferred to a different Wix account.
908
+ * + `-7`: The subscription has been canceled because the site owner hasn't manually authenticated the recurring payment during the subscription's grace period. For example, site owners must manually confirm recurring payments within 40 days when paying with boleto.
909
+ * + `-8`: The Wix account that the subscription belonged to has been deleted.
910
+ */
911
+ cancellationCode?: number | null;
912
+ /**
913
+ * Cancellation reason. For cancellations on behalf of the site owner or the service provider `cancellationReason`
914
+ * is taken from the request of
915
+ * [Cancel Immediately Offline](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately-offline).
916
+ * For cancellations on behalf of the billing system `cancellationReason` is `null` or an empty string.
917
+ */
918
+ cancellationReason?: string | null;
919
+ /**
920
+ * Initiator of the cancellation. For `"USER_REQUESTED"` and `"APP_MANAGED"`,
921
+ * `cancellationCode` and `cancellationReason` are taken from the request of
922
+ * [Cancel Immediately](https://dev.wix.com/docs/rest/account-level/premium/premium-subscriptions-manager/subscription-v1/cancel-immediately)
923
+ * or [Cancel Immediately Offline](https://dev.wix.com/docs/rest/account-level/premium/premium-subscriptions-manager/subscription-v1/cancel-immediately-offline).
924
+ * For `"PASSIVE"`, cancellations `cancellationCode` is automatically calculated and `cancellationReason`
925
+ * is `null` or an empty string.
926
+ *
927
+ * + `"UNKNOWN`: Default value.
928
+ * + `"USER_REQUESTED"`: The Wix account owner has canceled the subscription.
929
+ * + `"APP_MANAGED"`: The service provider has canceled the subscription.
930
+ * + `"PASSIVE"`: The billing system has canceled the subscription. For example, in case of payment failure or fraud.
931
+ */
932
+ initiator?: InitiatorWithLiterals;
933
+ }
934
+ declare enum Initiator {
935
+ UNKNOWN = "UNKNOWN",
936
+ USER_REQUESTED = "USER_REQUESTED",
937
+ APP_MANAGED = "APP_MANAGED",
938
+ PASSIVE = "PASSIVE"
939
+ }
940
+ /** @enumType */
941
+ type InitiatorWithLiterals = Initiator | 'UNKNOWN' | 'USER_REQUESTED' | 'APP_MANAGED' | 'PASSIVE';
942
+ declare enum RefundType {
943
+ UNKNOWN = "UNKNOWN",
944
+ NO_REFUND = "NO_REFUND",
945
+ FULL_REFUND = "FULL_REFUND",
946
+ PRORATED_REFUND = "PRORATED_REFUND"
947
+ }
948
+ /** @enumType */
949
+ type RefundTypeWithLiterals = RefundType | 'UNKNOWN' | 'NO_REFUND' | 'FULL_REFUND' | 'PRORATED_REFUND';
950
+ /** Triggered when the subscription's auto renew is turned on. */
951
+ interface SubscriptionAutoRenewTurnedOn {
952
+ /** Subscription for which auto renew is turned on. */
953
+ subscription?: Subscription;
954
+ /**
955
+ * Supported values: `USER`, `APP`.
956
+ *
957
+ * Information about who turned auto renew on.
958
+ * + `"USER"`: The site owner who purchased the subscription has turned auto renew on.
959
+ * + `"APP"`: The service provider has turned auto renew on.
960
+ */
961
+ initiator?: string | null;
962
+ }
963
+ /** Triggered when the subscription's auto renew is turned off. */
964
+ interface SubscriptionAutoRenewTurnedOff {
965
+ /** Subscription for which auto renew is turned off. */
966
+ subscription?: Subscription;
967
+ /** Details about the cancellation including who canceled the subscription and why. */
968
+ cancellationDetails?: CancellationDetails;
969
+ /**
970
+ * Whether the subscription is immediately canceled or expires at the end of the current billing cycle.
971
+ *
972
+ * Default: `false`
973
+ */
974
+ immediateCancel?: boolean;
975
+ }
976
+ /**
977
+ * Triggered when a subscription is unassigned from a Wix site and becomes
978
+ * floating.
979
+ */
980
+ interface SubscriptionUnassigned {
981
+ /** Unassigned subscription. */
982
+ subscription?: Subscription;
983
+ /**
984
+ * ID of the metasite that the subscription has been assigned to before the event.
985
+ * @format GUID
986
+ */
987
+ previousMetaSiteId?: string;
988
+ /**
989
+ * Reason why the subscription is unassigned.
990
+ *
991
+ * + `"UNKNOWN"`: Default value.
992
+ * + `"USER_REQUESTED"`: The Wix account owner has unassigned the subscription.
993
+ * + `"REPLACED_BY_ANOTHER_SUBSCRIPTION"`: A different subscription that replaces this subscription is assigned to the site.
994
+ */
995
+ unassignReason?: UnassignReasonWithLiterals;
996
+ }
997
+ declare enum UnassignReason {
998
+ UNKNOWN = "UNKNOWN",
999
+ USER_REQUESTED = "USER_REQUESTED",
1000
+ REPLACED_BY_ANOTHER_SUBSCRIPTION = "REPLACED_BY_ANOTHER_SUBSCRIPTION"
1001
+ }
1002
+ /** @enumType */
1003
+ type UnassignReasonWithLiterals = UnassignReason | 'UNKNOWN' | 'USER_REQUESTED' | 'REPLACED_BY_ANOTHER_SUBSCRIPTION';
1004
+ /**
1005
+ * Triggered when a subscription is transferred from one Wix account to another.
1006
+ * A transfer includes cancelling the original subscription and creating a new
1007
+ * subscription for the target account. The event returns both the original
1008
+ * and the new subscription.
1009
+ */
1010
+ interface SubscriptionTransferred {
1011
+ /** Original subscription that was canceled for the transfer. */
1012
+ originSubscription?: Subscription;
1013
+ /** Newly created subscription for the target account. */
1014
+ targetSubscription?: Subscription;
1015
+ }
1016
+ /** Triggered when a recurring charge succeeds for a subscription. */
1017
+ interface RecurringChargeSucceeded {
1018
+ /** Subscription for which the recurring charge has succeeded. */
1019
+ subscription?: Subscription;
1020
+ /** Indication that there was a successful charge at the end of the free trial period */
1021
+ freeTrialPeriodEnd?: boolean;
1022
+ }
1023
+ /**
1024
+ * Triggered when a subscription was updated including when its product has been
1025
+ * up- or downgraded or the billing cycle is changed.
1026
+ */
1027
+ interface ContractSwitched {
1028
+ /** Updated subscription. */
1029
+ subscription?: Subscription;
1030
+ /** Billing cycle before the update. */
1031
+ previousCycle?: Cycle;
1032
+ /**
1033
+ * ID of the product belonging to the subscription before the update.
1034
+ * @format GUID
1035
+ */
1036
+ previousProductId?: string;
1037
+ /**
1038
+ * ID of the product type that the subscription's original product belonged to before the update.
1039
+ * @format GUID
1040
+ */
1041
+ previousProductTypeId?: string;
1042
+ /**
1043
+ * Update type. __Note__: Doesn't include information about a product adjustment.
1044
+ * For that purpose, see `productAdjustment`.
1045
+ *
1046
+ * + `"NOT_APPLICABLE"`: Default value.
1047
+ * + `"ADDITIONAL_QUANTITY"`: An increased usage quota is added to the subscription. For example, a second mailbox is added to a subscription that previously included a single mailbox.
1048
+ * + `"CREDIT_UNUSED_PERIOD"`: The subscription is upgraded and the new price is less than the regular price. The new price applies to every billing cycle, not just the first cycle.
1049
+ * + `"REFUND_PRICE_DIFF"`: Not implemented.
1050
+ * + `"ADJUST_PERIOD_END"`: Not implemented.
1051
+ * + `"DOWNGRADE_GRACE_PERIOD"`: For downgrades during the grace period. In this situation, the site owner hasn’t paid yet and must immediately pay for the downgraded subscription.
1052
+ * + `"FULL_AMOUNT_PERIOD"`: For upgrades in which the site owner retains unused benefits. For example, site owners upgrading a Facebook Ads subscription retain their unused FB Ads credit. The unused credit is added to the new credit.
1053
+ * + `"END_OF_PERIOD"`: The subscription's billing current cycle is extended because of a downgrade.
1054
+ * + `"PENDING_CHANGES"`: The subscription's billing is updated, but the change doesn't apply immediately. Instead, the update becomes effective at the end of current billing cycle.
1055
+ * + `"DOWNGRADE_RENEWAL"`: The subscription is downgraded because of a declined payment. This prevents subscriptions from churning.
1056
+ */
1057
+ contractSwitchType?: ContractSwitchTypeWithLiterals;
1058
+ /**
1059
+ * ID of the metasite the subscription has been assigned to previously.
1060
+ * Available only in case the subscription is assigned to a different site.
1061
+ * @format GUID
1062
+ */
1063
+ previousMetaSiteId?: string | null;
1064
+ /**
1065
+ * Update reason.
1066
+ *
1067
+ * + `"PRICE_INCREASE"`: The subscription's price has been increased.
1068
+ * + `"EXTERNAL_PROVIDER_TRIGGER"`: Any reason other than a price increase.
1069
+ */
1070
+ contractSwitchReason?: ContractSwitchReasonWithLiterals;
1071
+ /** Information about the price update. Available only for updates with a price increase. */
1072
+ productPriceIncreaseData?: ProductPriceIncreaseData;
1073
+ /**
1074
+ * Information about a product adjustment. For example, a downgrade.
1075
+ * __Note__: This isn't the same as `contractSwitchType`.
1076
+ *
1077
+ * + `NOT_APPLICABLE`: There is no information about whether the product has been up- or downgraded.
1078
+ * + `DOWNGRADE`: The product has been downgraded.
1079
+ */
1080
+ productAdjustment?: ProductAdjustmentWithLiterals;
1081
+ /**
1082
+ * Number of seats before the contract switch.
1083
+ * @min 1
1084
+ * @max 500
1085
+ */
1086
+ previousSeats?: number | null;
1087
+ }
1088
+ /** Copied from SBS */
1089
+ declare enum ContractSwitchType {
1090
+ NOT_APPLICABLE = "NOT_APPLICABLE",
1091
+ ADDITIONAL_QUANTITY = "ADDITIONAL_QUANTITY",
1092
+ CREDIT_UNUSED_PERIOD = "CREDIT_UNUSED_PERIOD",
1093
+ REFUND_PRICE_DIFF = "REFUND_PRICE_DIFF",
1094
+ ADJUST_PERIOD_END = "ADJUST_PERIOD_END",
1095
+ DOWNGRADE_GRACE_PERIOD = "DOWNGRADE_GRACE_PERIOD",
1096
+ FULL_AMOUNT_PERIOD = "FULL_AMOUNT_PERIOD",
1097
+ END_OF_PERIOD = "END_OF_PERIOD",
1098
+ PENDING_CHANGES = "PENDING_CHANGES",
1099
+ DOWNGRADE_RENEWAL = "DOWNGRADE_RENEWAL",
1100
+ FIXED_BILLING_DATE_PRORATION = "FIXED_BILLING_DATE_PRORATION"
1101
+ }
1102
+ /** @enumType */
1103
+ type ContractSwitchTypeWithLiterals = ContractSwitchType | 'NOT_APPLICABLE' | 'ADDITIONAL_QUANTITY' | 'CREDIT_UNUSED_PERIOD' | 'REFUND_PRICE_DIFF' | 'ADJUST_PERIOD_END' | 'DOWNGRADE_GRACE_PERIOD' | 'FULL_AMOUNT_PERIOD' | 'END_OF_PERIOD' | 'PENDING_CHANGES' | 'DOWNGRADE_RENEWAL' | 'FIXED_BILLING_DATE_PRORATION';
1104
+ declare enum ContractSwitchReason {
1105
+ EXTERNAL_PROVIDER_TRIGGER = "EXTERNAL_PROVIDER_TRIGGER",
1106
+ PRICE_INCREASE = "PRICE_INCREASE"
1107
+ }
1108
+ /** @enumType */
1109
+ type ContractSwitchReasonWithLiterals = ContractSwitchReason | 'EXTERNAL_PROVIDER_TRIGGER' | 'PRICE_INCREASE';
1110
+ /** Triggered when a subscription's price is increased. */
1111
+ interface ProductPriceIncreaseData {
1112
+ /**
1113
+ * Price of the subscription before the update.
1114
+ * @format DECIMAL_VALUE
1115
+ */
1116
+ previousPrice?: string | null;
1117
+ /** A value that is used in order to select the correct email template to send the user regarding the price increase. */
1118
+ emailTemplateSelector?: string | null;
1119
+ /** Used to differentiate between migration segments. Does not have to be unique per segment. */
1120
+ segmentName?: string | null;
1121
+ /** Used to determine how the price increase was triggered. */
1122
+ priceIncreaseTrigger?: PriceIncreaseTriggerWithLiterals;
1123
+ }
1124
+ /** Reason for Price Increase Trigger */
1125
+ declare enum PriceIncreaseTrigger {
1126
+ NEAR_RENEWAL = "NEAR_RENEWAL",
1127
+ RECURRING_SUCCESS = "RECURRING_SUCCESS",
1128
+ MANUAL = "MANUAL"
1129
+ }
1130
+ /** @enumType */
1131
+ type PriceIncreaseTriggerWithLiterals = PriceIncreaseTrigger | 'NEAR_RENEWAL' | 'RECURRING_SUCCESS' | 'MANUAL';
1132
+ /** Triggered when a subscription's product is adusted. */
1133
+ declare enum ProductAdjustment {
1134
+ /** flag to show that the ContractSwitchedEvent is not applicable / needed */
1135
+ NOT_APPLICABLE = "NOT_APPLICABLE",
1136
+ /** flag to show that the ContractSwitchedEvent is a Downgrade */
1137
+ DOWNGRADE = "DOWNGRADE"
1138
+ }
1139
+ /** @enumType */
1140
+ type ProductAdjustmentWithLiterals = ProductAdjustment | 'NOT_APPLICABLE' | 'DOWNGRADE';
1141
+ /**
1142
+ * Triggered when a subscription gets close to the end of its billing cycle.
1143
+ * The exact number of days is defined in the billing system.
1144
+ */
1145
+ interface SubscriptionNearEndOfPeriod {
1146
+ /** Subscription that got close to the end of its billing cycle. */
1147
+ subscription?: Subscription;
1148
+ /** Whether the subscription is within the free trial period. */
1149
+ inFreeTrial?: boolean;
1150
+ }
1151
+ /**
1152
+ * Triggered when a subscription is updated and the change doesn't happen
1153
+ * immediately but at the end of the current billing cycle.
1154
+ */
1155
+ interface SubscriptionPendingChange {
1156
+ /** Subscription for which a pending update is triggered. */
1157
+ subscription?: Subscription;
1158
+ }
1159
+ /** Triggered when a recurring charge attempt failed for a subscription. */
1160
+ interface RecurringChargeAttemptFailed {
1161
+ /** Subscription for which the recurring charge attempt has failed. */
1162
+ subscription?: Subscription;
1163
+ }
1164
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
1165
+ /** Emitted on a meta site creation. */
1166
+ siteCreated?: SiteCreated;
1167
+ /** Emitted on a meta site transfer completion. */
1168
+ siteTransferred?: SiteTransferred;
1169
+ /** Emitted on a meta site deletion. */
1170
+ siteDeleted?: SiteDeleted;
1171
+ /** Emitted on a meta site restoration. */
1172
+ siteUndeleted?: SiteUndeleted;
1173
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
1174
+ sitePublished?: SitePublished;
1175
+ /** Emitted on a meta site unpublish. */
1176
+ siteUnpublished?: SiteUnpublished;
1177
+ /** Emitted when meta site is marked as template. */
1178
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
1179
+ /** Emitted when meta site is marked as a WixSite. */
1180
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
1181
+ /** Emitted when an application is provisioned (installed). */
1182
+ serviceProvisioned?: ServiceProvisioned;
1183
+ /** Emitted when an application is removed (uninstalled). */
1184
+ serviceRemoved?: ServiceRemoved;
1185
+ /** Emitted when meta site name (URL slug) is changed. */
1186
+ siteRenamedPayload?: SiteRenamed;
1187
+ /** Emitted when meta site was permanently deleted. */
1188
+ hardDeleted?: SiteHardDeleted;
1189
+ /** Emitted on a namespace change. */
1190
+ namespaceChanged?: NamespaceChanged;
1191
+ /** Emitted when Studio is attached. */
1192
+ studioAssigned?: StudioAssigned;
1193
+ /** Emitted when Studio is detached. */
1194
+ studioUnassigned?: StudioUnassigned;
1195
+ /**
1196
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
1197
+ * the actual URL.
1198
+ *
1199
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
1200
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
1201
+ */
1202
+ urlChanged?: SiteUrlChanged;
1203
+ /** Site is marked as PurgedExternally */
1204
+ sitePurgedExternally?: SitePurgedExternally;
1205
+ /** Emitted when Odeditor is attached. */
1206
+ odeditorAssigned?: OdeditorAssigned;
1207
+ /** Emitted when Odeditor is detached. */
1208
+ odeditorUnassigned?: OdeditorUnassigned;
1209
+ /** Emitted when Picasso is attached. */
1210
+ picassoAssigned?: PicassoAssigned;
1211
+ /** Emitted when Picasso is detached. */
1212
+ picassoUnassigned?: PicassoUnassigned;
1213
+ /** Emitted when Wixel is attached. */
1214
+ wixelAssigned?: WixelAssigned;
1215
+ /** Emitted when Wixel is detached. */
1216
+ wixelUnassigned?: WixelUnassigned;
1217
+ /** Emitted when StudioTwo is attached. */
1218
+ studioTwoAssigned?: StudioTwoAssigned;
1219
+ /** Emitted when StudioTwo is detached. */
1220
+ studioTwoUnassigned?: StudioTwoUnassigned;
1221
+ /**
1222
+ * A meta site id.
1223
+ * @format GUID
1224
+ */
1225
+ metaSiteId?: string;
1226
+ /** A meta site version. Monotonically increasing. */
1227
+ version?: string;
1228
+ /** A timestamp of the event. */
1229
+ timestamp?: string;
1230
+ /**
1231
+ * TODO(meta-site): Change validation once validations are disabled for consumers
1232
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
1233
+ * @maxSize 4000
1234
+ */
1235
+ assets?: Asset[];
1236
+ }
1237
+ /** @oneof */
1238
+ interface MetaSiteSpecialEventPayloadOneOf {
1239
+ /** Emitted on a meta site creation. */
1240
+ siteCreated?: SiteCreated;
1241
+ /** Emitted on a meta site transfer completion. */
1242
+ siteTransferred?: SiteTransferred;
1243
+ /** Emitted on a meta site deletion. */
1244
+ siteDeleted?: SiteDeleted;
1245
+ /** Emitted on a meta site restoration. */
1246
+ siteUndeleted?: SiteUndeleted;
1247
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
1248
+ sitePublished?: SitePublished;
1249
+ /** Emitted on a meta site unpublish. */
1250
+ siteUnpublished?: SiteUnpublished;
1251
+ /** Emitted when meta site is marked as template. */
1252
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
1253
+ /** Emitted when meta site is marked as a WixSite. */
1254
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
1255
+ /** Emitted when an application is provisioned (installed). */
1256
+ serviceProvisioned?: ServiceProvisioned;
1257
+ /** Emitted when an application is removed (uninstalled). */
1258
+ serviceRemoved?: ServiceRemoved;
1259
+ /** Emitted when meta site name (URL slug) is changed. */
1260
+ siteRenamedPayload?: SiteRenamed;
1261
+ /** Emitted when meta site was permanently deleted. */
1262
+ hardDeleted?: SiteHardDeleted;
1263
+ /** Emitted on a namespace change. */
1264
+ namespaceChanged?: NamespaceChanged;
1265
+ /** Emitted when Studio is attached. */
1266
+ studioAssigned?: StudioAssigned;
1267
+ /** Emitted when Studio is detached. */
1268
+ studioUnassigned?: StudioUnassigned;
1269
+ /**
1270
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
1271
+ * the actual URL.
1272
+ *
1273
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
1274
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
1275
+ */
1276
+ urlChanged?: SiteUrlChanged;
1277
+ /** Site is marked as PurgedExternally */
1278
+ sitePurgedExternally?: SitePurgedExternally;
1279
+ /** Emitted when Odeditor is attached. */
1280
+ odeditorAssigned?: OdeditorAssigned;
1281
+ /** Emitted when Odeditor is detached. */
1282
+ odeditorUnassigned?: OdeditorUnassigned;
1283
+ /** Emitted when Picasso is attached. */
1284
+ picassoAssigned?: PicassoAssigned;
1285
+ /** Emitted when Picasso is detached. */
1286
+ picassoUnassigned?: PicassoUnassigned;
1287
+ /** Emitted when Wixel is attached. */
1288
+ wixelAssigned?: WixelAssigned;
1289
+ /** Emitted when Wixel is detached. */
1290
+ wixelUnassigned?: WixelUnassigned;
1291
+ /** Emitted when StudioTwo is attached. */
1292
+ studioTwoAssigned?: StudioTwoAssigned;
1293
+ /** Emitted when StudioTwo is detached. */
1294
+ studioTwoUnassigned?: StudioTwoUnassigned;
1295
+ }
1296
+ interface Asset {
1297
+ /**
1298
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
1299
+ * @maxLength 36
1300
+ */
1301
+ appDefId?: string;
1302
+ /**
1303
+ * An instance id. For legacy reasons may be UUID or a string.
1304
+ * @maxLength 200
1305
+ */
1306
+ instanceId?: string;
1307
+ /** An application state. */
1308
+ state?: StateWithLiterals;
1309
+ }
1310
+ declare enum State {
1311
+ UNKNOWN = "UNKNOWN",
1312
+ ENABLED = "ENABLED",
1313
+ DISABLED = "DISABLED",
1314
+ PENDING = "PENDING",
1315
+ DEMO = "DEMO"
1316
+ }
1317
+ /** @enumType */
1318
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
1319
+ interface SiteCreated {
1320
+ /**
1321
+ * A template identifier (empty if not created from a template).
1322
+ * @maxLength 36
1323
+ */
1324
+ originTemplateId?: string;
1325
+ /**
1326
+ * An account id of the owner.
1327
+ * @format GUID
1328
+ */
1329
+ ownerId?: string;
1330
+ /** A context in which meta site was created. */
1331
+ context?: SiteCreatedContextWithLiterals;
1332
+ /**
1333
+ * A meta site id from which this site was created.
1334
+ *
1335
+ * In case of a creation from a template it's a template id.
1336
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
1337
+ * @format GUID
1338
+ */
1339
+ originMetaSiteId?: string | null;
1340
+ /**
1341
+ * A meta site name (URL slug).
1342
+ * @maxLength 20
1343
+ */
1344
+ siteName?: string;
1345
+ /** A namespace. */
1346
+ namespace?: NamespaceWithLiterals;
1347
+ }
1348
+ declare enum SiteCreatedContext {
1349
+ /** A valid option, we don't expose all reasons why site might be created. */
1350
+ OTHER = "OTHER",
1351
+ /** A meta site was created from template. */
1352
+ FROM_TEMPLATE = "FROM_TEMPLATE",
1353
+ /** A meta site was created by copying of the transfferred meta site. */
1354
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
1355
+ /** A copy of existing meta site. */
1356
+ DUPLICATE = "DUPLICATE",
1357
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
1358
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
1359
+ /** deprecated A meta site was created for Flash editor. */
1360
+ FLASH = "FLASH"
1361
+ }
1362
+ /** @enumType */
1363
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
1364
+ declare enum Namespace {
1365
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
1366
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
1367
+ WIX = "WIX",
1368
+ /** 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. */
1369
+ SHOUT_OUT = "SHOUT_OUT",
1370
+ /** 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. */
1371
+ ALBUMS = "ALBUMS",
1372
+ /** 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. */
1373
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
1374
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1375
+ HOTELS = "HOTELS",
1376
+ /** 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. */
1377
+ CLUBS = "CLUBS",
1378
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1379
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
1380
+ /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1381
+ DEV_SITE = "DEV_SITE",
1382
+ /** 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. */
1383
+ LOGOS = "LOGOS",
1384
+ /** 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. */
1385
+ VIDEO_MAKER = "VIDEO_MAKER",
1386
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
1387
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
1388
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
1389
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
1390
+ /**
1391
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
1392
+ *
1393
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
1394
+ */
1395
+ HTML_DRAFT = "HTML_DRAFT",
1396
+ /**
1397
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
1398
+ * Will be accessible from Site List and will not have a website app.
1399
+ * Once the user attaches a site, the site will become a regular wixsite.
1400
+ */
1401
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
1402
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
1403
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
1404
+ /** It is to be used in the Business First efforts. */
1405
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
1406
+ /** Bookings business flow with no site. */
1407
+ ANYWHERE = "ANYWHERE",
1408
+ /** Namespace for Headless Backoffice with no editor */
1409
+ HEADLESS = "HEADLESS",
1410
+ /**
1411
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
1412
+ * The site will be used for account level CSM feature for enterprise
1413
+ */
1414
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
1415
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
1416
+ RISE = "RISE",
1417
+ /**
1418
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
1419
+ * There's a blank site behind the scene but it's blank).
1420
+ * The Mobile company will be the owner of this namespace.
1421
+ */
1422
+ BRANDED_FIRST = "BRANDED_FIRST",
1423
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
1424
+ NOWNIA = "NOWNIA",
1425
+ /**
1426
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
1427
+ * The Partners company owns this namespace.
1428
+ */
1429
+ UGC_TEMPLATE = "UGC_TEMPLATE",
1430
+ /** Codux Headless Sites */
1431
+ CODUX = "CODUX",
1432
+ /** Bobb - AI Design Creator. */
1433
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
1434
+ /**
1435
+ * Shared Blog Site is a unique single site across Enterprise account,
1436
+ * This site will hold all Blog posts related to the Marketing product.
1437
+ */
1438
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
1439
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1440
+ STANDALONE_FORMS = "STANDALONE_FORMS",
1441
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1442
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
1443
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
1444
+ MIMIR = "MIMIR",
1445
+ /** Wix Twins platform. */
1446
+ TWINS = "TWINS",
1447
+ /** Wix Nano. */
1448
+ NANO = "NANO",
1449
+ /** Base44 headless sites. */
1450
+ BASE44 = "BASE44"
1451
+ }
1452
+ /** @enumType */
1453
+ 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' | 'BASE44';
1454
+ /** Site transferred to another user. */
1455
+ interface SiteTransferred {
1456
+ /**
1457
+ * A previous owner id (user that transfers meta site).
1458
+ * @format GUID
1459
+ */
1460
+ oldOwnerId?: string;
1461
+ /**
1462
+ * A new owner id (user that accepts meta site).
1463
+ * @format GUID
1464
+ */
1465
+ newOwnerId?: string;
1466
+ }
1467
+ /** Soft deletion of the meta site. Could be restored. */
1468
+ interface SiteDeleted {
1469
+ /** A deletion context. */
1470
+ deleteContext?: DeleteContext;
1471
+ }
1472
+ interface DeleteContext {
1473
+ /** When the meta site was deleted. */
1474
+ dateDeleted?: Date | null;
1475
+ /** A status. */
1476
+ deleteStatus?: DeleteStatusWithLiterals;
1477
+ /**
1478
+ * A reason (flow).
1479
+ * @maxLength 255
1480
+ */
1481
+ deleteOrigin?: string;
1482
+ /**
1483
+ * A service that deleted it.
1484
+ * @maxLength 255
1485
+ */
1486
+ initiatorId?: string | null;
1487
+ }
1488
+ declare enum DeleteStatus {
1489
+ UNKNOWN = "UNKNOWN",
1490
+ TRASH = "TRASH",
1491
+ DELETED = "DELETED",
1492
+ PENDING_PURGE = "PENDING_PURGE",
1493
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
1494
+ }
1495
+ /** @enumType */
1496
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
1497
+ /** Restoration of the meta site. */
1498
+ interface SiteUndeleted {
1499
+ }
1500
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
1501
+ interface SitePublished {
1502
+ }
1503
+ interface SiteUnpublished {
1504
+ /**
1505
+ * A list of URLs previously associated with the meta site.
1506
+ * @maxLength 4000
1507
+ * @maxSize 10000
1508
+ */
1509
+ urls?: string[];
1510
+ }
1511
+ interface SiteMarkedAsTemplate {
1512
+ }
1513
+ interface SiteMarkedAsWixSite {
1514
+ }
1515
+ /**
1516
+ * Represents a service provisioned a site.
1517
+ *
1518
+ * Note on `origin_instance_id`:
1519
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
1520
+ * This is because of the following scenario:
1521
+ *
1522
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
1523
+ * such as a product catalog. When you create a site from this template, you inherit this
1524
+ * default product catalog. However, if the template's product catalog is modified,
1525
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
1526
+ * your site remains consistent with what you initially received and does not include any
1527
+ * changes made to the original template afterward.
1528
+ * To ensure this, the TPA on the template gets a new instance_id.
1529
+ */
1530
+ interface ServiceProvisioned {
1531
+ /**
1532
+ * Either UUID or EmbeddedServiceType.
1533
+ * @maxLength 36
1534
+ */
1535
+ appDefId?: string;
1536
+ /**
1537
+ * Not only UUID. Something here could be something weird.
1538
+ * @maxLength 36
1539
+ */
1540
+ instanceId?: string;
1541
+ /**
1542
+ * An instance id from which this instance is originated.
1543
+ * @maxLength 36
1544
+ */
1545
+ originInstanceId?: string;
1546
+ /**
1547
+ * A version.
1548
+ * @maxLength 500
1549
+ */
1550
+ version?: string | null;
1551
+ /**
1552
+ * The origin meta site id
1553
+ * @format GUID
1554
+ */
1555
+ originMetaSiteId?: string | null;
1556
+ }
1557
+ interface ServiceRemoved {
1558
+ /**
1559
+ * Either UUID or EmbeddedServiceType.
1560
+ * @maxLength 36
1561
+ */
1562
+ appDefId?: string;
1563
+ /**
1564
+ * Not only UUID. Something here could be something weird.
1565
+ * @maxLength 36
1566
+ */
1567
+ instanceId?: string;
1568
+ /**
1569
+ * A version.
1570
+ * @maxLength 500
1571
+ */
1572
+ version?: string | null;
1573
+ }
1574
+ /** Rename of the site. Meaning, free public url has been changed as well. */
1575
+ interface SiteRenamed {
1576
+ /**
1577
+ * A new meta site name (URL slug).
1578
+ * @maxLength 20
1579
+ */
1580
+ newSiteName?: string;
1581
+ /**
1582
+ * A previous meta site name (URL slug).
1583
+ * @maxLength 255
1584
+ */
1585
+ oldSiteName?: string;
1586
+ }
1587
+ /**
1588
+ * Hard deletion of the meta site.
1589
+ *
1590
+ * Could not be restored. Therefore it's desirable to cleanup data.
1591
+ */
1592
+ interface SiteHardDeleted {
1593
+ /** A deletion context. */
1594
+ deleteContext?: DeleteContext;
1595
+ }
1596
+ interface NamespaceChanged {
1597
+ /** A previous namespace. */
1598
+ oldNamespace?: NamespaceWithLiterals;
1599
+ /** A new namespace. */
1600
+ newNamespace?: NamespaceWithLiterals;
1601
+ }
1602
+ /** Assigned Studio editor */
1603
+ interface StudioAssigned {
1604
+ }
1605
+ /** Unassigned Studio editor */
1606
+ interface StudioUnassigned {
1607
+ }
1608
+ /**
1609
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
1610
+ *
1611
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
1612
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
1613
+ *
1614
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
1615
+ */
1616
+ interface SiteUrlChanged {
1617
+ }
1618
+ /**
1619
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
1620
+ * Consumed by other teams to remove relevant data.
1621
+ */
1622
+ interface SitePurgedExternally {
1623
+ /**
1624
+ * @maxLength 2048
1625
+ * @maxSize 100
1626
+ * @deprecated
1627
+ * @targetRemovalDate 2025-04-15
1628
+ */
1629
+ appDefId?: string[];
1630
+ }
1631
+ /** Assigned Odeditor */
1632
+ interface OdeditorAssigned {
1633
+ }
1634
+ /** Unassigned Odeditor */
1635
+ interface OdeditorUnassigned {
1636
+ }
1637
+ /** Assigned Picasso editor */
1638
+ interface PicassoAssigned {
1639
+ }
1640
+ /** Unassigned Picasso */
1641
+ interface PicassoUnassigned {
1642
+ }
1643
+ /** Assigned Wixel */
1644
+ interface WixelAssigned {
1645
+ }
1646
+ /** Unassigned Wixel */
1647
+ interface WixelUnassigned {
1648
+ }
1649
+ /** Assigned StudioTwo */
1650
+ interface StudioTwoAssigned {
1651
+ }
1652
+ /** Unassigned StudioTwo */
1653
+ interface StudioTwoUnassigned {
1654
+ }
550
1655
  interface DomainEvent extends DomainEventBodyOneOf {
551
1656
  createdEvent?: EntityCreatedEvent;
552
1657
  updatedEvent?: EntityUpdatedEvent;
@@ -709,4 +1814,4 @@ declare function getPricingPlansSettings(): Promise<NonNullablePaths<PricingPlan
709
1814
  */
710
1815
  declare function updatePricingPlansSettings(pricingPlansSettings: NonNullablePaths<PricingPlansSettings, `revision`, 2>): Promise<NonNullablePaths<PricingPlansSettings, `taxableAddress`, 2>>;
711
1816
 
712
- export { type ActionEvent, type AssignedFromFloatingReason, type BooleanFeature, type CancelRequestedReason, type ContractSwitchedReason, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type Feature, type FeatureCancelled, type FeatureCancelledReasonOneOf, type FeatureContext, type FeatureDisabled, type FeatureDisabledReasonOneOf, type FeatureEnabled, type FeatureEnabledReasonOneOf, type FeatureEvent, type FeatureEventEventOneOf, FeaturePeriod, type FeaturePeriodWithLiterals, type FeatureQuantityInfoOneOf, type FeatureUpdated, type FeatureUpdatedPreviousQuantityInfoOneOf, type FeatureUpdatedReasonOneOf, type GetPricingPlansSettingsRequest, type GetPricingPlansSettingsResponse, type IdentificationData, type IdentificationDataIdOneOf, type ManualFeatureCreationReason, type MessageEnvelope, type MigratedFromLegacyReason, type NewFeatureReason, type PricingPlansSettings, type QuotaFeature, type QuotaInfo, type QuotaInfoEntry, type ReassignedFromSiteReason, type ReassignedToAnotherSiteReason, type ReplacedByAnotherSubscriptionReason, type RestoreInfo, TaxableAddress, type TaxableAddressWithLiterals, type TransferredFromAnotherAccountReason, type TransferredToAnotherAccountReason, type UnAssingedToFloatingReason, type UpdatePricingPlansSettingsRequest, type UpdatePricingPlansSettingsResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, getPricingPlansSettings, updatePricingPlansSettings };
1817
+ export { type ActionEvent, type Asset, type AssignedFromFloatingReason, type BillingReference, type BooleanFeature, type CancelRequestedReason, type CancellationDetails, ContractSwitchReason, type ContractSwitchReasonWithLiterals, ContractSwitchType, type ContractSwitchTypeWithLiterals, type ContractSwitched, type ContractSwitchedReason, type Cycle, type CycleCycleSelectorOneOf, type DeleteContext, DeleteStatus, type DeleteStatusWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type Feature, type FeatureCancelled, type FeatureCancelledReasonOneOf, type FeatureContext, type FeatureDisabled, type FeatureDisabledReasonOneOf, type FeatureEnabled, type FeatureEnabledReasonOneOf, type FeatureEvent, type FeatureEventEventOneOf, FeaturePeriod, type FeaturePeriodWithLiterals, type FeatureQuantityInfoOneOf, type FeatureUpdated, type FeatureUpdatedPreviousQuantityInfoOneOf, type FeatureUpdatedReasonOneOf, type GetPricingPlansSettingsRequest, type GetPricingPlansSettingsResponse, type IdentificationData, type IdentificationDataIdOneOf, Initiator, type InitiatorWithLiterals, type Interval, IntervalUnit, type IntervalUnitWithLiterals, type ManualFeatureCreationReason, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, type MigratedFromLegacyReason, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type NewFeatureReason, type OdeditorAssigned, type OdeditorUnassigned, type OneTime, type PicassoAssigned, type PicassoUnassigned, PriceIncreaseTrigger, type PriceIncreaseTriggerWithLiterals, type PricingPlansSettings, ProductAdjustment, type ProductAdjustmentWithLiterals, type ProductPriceIncreaseData, ProviderName, type ProviderNameWithLiterals, type QuotaFeature, type QuotaInfo, type QuotaInfoEntry, type ReactivationData, ReactivationReasonEnum, type ReactivationReasonEnumWithLiterals, type ReassignedFromSiteReason, type ReassignedToAnotherSiteReason, type RecurringChargeAttemptFailed, type RecurringChargeSucceeded, RefundType, type RefundTypeWithLiterals, type ReplacedByAnotherSubscriptionReason, 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, State, type StateWithLiterals, type StudioAssigned, type StudioTwoAssigned, type StudioTwoUnassigned, type StudioUnassigned, type Subscription, type SubscriptionAssigned, type SubscriptionAutoRenewTurnedOff, type SubscriptionAutoRenewTurnedOn, type SubscriptionCancelled, type SubscriptionCreated, type SubscriptionEvent, type SubscriptionEventEventOneOf, type SubscriptionNearEndOfPeriod, type SubscriptionPendingChange, SubscriptionStatus, type SubscriptionStatusWithLiterals, type SubscriptionTransferred, type SubscriptionUnassigned, TaxableAddress, type TaxableAddressWithLiterals, type TransferredFromAnotherAccountReason, type TransferredToAnotherAccountReason, type UnAssingedToFloatingReason, UnassignReason, type UnassignReasonWithLiterals, type UpdatePricingPlansSettingsRequest, type UpdatePricingPlansSettingsResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixelAssigned, type WixelUnassigned, getPricingPlansSettings, updatePricingPlansSettings };