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