@wix/app-management 1.0.45 → 1.0.46

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/app-management",
-  "version": "1.0.45",
+  "version": "1.0.46",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -22,9 +22,9 @@
     "service-plugins"
   ],
   "dependencies": {
-    "@wix/app-management_app-instances": "1.0.25",
+    "@wix/app-management_app-instances": "1.0.26",
     "@wix/app-management_app-plans": "1.0.24",
-    "@wix/app-management_bi-events": "1.0.23",
+    "@wix/app-management_bi-events": "1.0.24",
     "@wix/app-management_billing": "1.0.24",
     "@wix/app-management_custom-charges": "1.0.21",
     "@wix/app-management_embedded-scripts": "1.0.21"
@@ -52,5 +52,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "89279a888fb1803d7e9c71dc250a8cd0643dddd50a357d920ff8f8ec"
+  "falconPackageHash": "6100eefd2bc54e1e714c61fe6dbcf46653a60b849aef0d3947db07f5"
 }

package/type-bundles/context.bundle.d.ts

@@ -933,12 +933,6 @@ declare enum PaymentCycle$1 {
 interface FreeTrialInfo {
     /**
      * Current free trial status.
-     *
-     * Supported values:
-     *
-     * - `IN_PROGRESS`: The free trial is currently in progress.
-     * - `ENDED`: The free trial has ended.
-     * - `NOT_AVAILABLE`: No free trial was applied, as none was available.
      * @readonly
      */
     status?: FreeTrialStatus;
@@ -949,9 +943,13 @@ interface FreeTrialInfo {
     endDate?: Date | null;
 }
 declare enum FreeTrialStatus {
+    /** Unknown trial status. */
     UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    /** The free trial is currently in progress. */
     IN_PROGRESS = "IN_PROGRESS",
+    /** The free trial has ended. */
     ENDED = "ENDED",
+    /** No free trial was applied, as none was available. */
     NOT_AVAILABLE = "NOT_AVAILABLE"
 }
 interface AvailablePlan {
@@ -1212,16 +1210,16 @@ interface AppInstanceRemovedEnvelope {
     data: AppRemoved;
     metadata: BaseEventMetadata;
 }
-interface AppInstancePaidPlanPurchasedEnvelope {
-    data: PaidPlanPurchased;
+interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
+    data: PaidPlanAutoRenewalCancelled;
     metadata: BaseEventMetadata;
 }
 interface AppInstancePaidPlanChangedEnvelope {
     data: PaidPlanChanged;
     metadata: BaseEventMetadata;
 }
-interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
-    data: PaidPlanAutoRenewalCancelled;
+interface AppInstancePaidPlanPurchasedEnvelope {
+    data: PaidPlanPurchased;
     metadata: BaseEventMetadata;
 }
 
@@ -1240,9 +1238,9 @@ interface GetAppInstanceSignature {
 }
 declare const onAppInstanceInstalled$1: EventDefinition<AppInstanceInstalledEnvelope, "AppInstalled">;
 declare const onAppInstanceRemoved$1: EventDefinition<AppInstanceRemovedEnvelope, "AppRemoved">;
-declare const onAppInstancePaidPlanPurchased$1: EventDefinition<AppInstancePaidPlanPurchasedEnvelope, "PaidPlanPurchased">;
-declare const onAppInstancePaidPlanChanged$1: EventDefinition<AppInstancePaidPlanChangedEnvelope, "PaidPlanChanged">;
 declare const onAppInstancePaidPlanAutoRenewalCancelled$1: EventDefinition<AppInstancePaidPlanAutoRenewalCancelledEnvelope, "PaidPlanAutoRenewalCancelled">;
+declare const onAppInstancePaidPlanChanged$1: EventDefinition<AppInstancePaidPlanChangedEnvelope, "PaidPlanChanged">;
+declare const onAppInstancePaidPlanPurchased$1: EventDefinition<AppInstancePaidPlanPurchasedEnvelope, "PaidPlanPurchased">;
 
 declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
 
@@ -1260,11 +1258,13 @@ type _publicOnAppInstanceRemovedType = typeof onAppInstanceRemoved$1;
  */
 declare const onAppInstanceRemoved: ReturnType<typeof createEventModule<_publicOnAppInstanceRemovedType>>;
 
-type _publicOnAppInstancePaidPlanPurchasedType = typeof onAppInstancePaidPlanPurchased$1;
+type _publicOnAppInstancePaidPlanAutoRenewalCancelledType = typeof onAppInstancePaidPlanAutoRenewalCancelled$1;
 /**
- * Triggered when a site owner purchases a paid plan for your app.
+ * Triggered when a site owner cancels a paid plan for your app. The
+ * site owner can continue to use your app until the end of the current billing
+ * cycle.
  */
-declare const onAppInstancePaidPlanPurchased: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanPurchasedType>>;
+declare const onAppInstancePaidPlanAutoRenewalCancelled: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanAutoRenewalCancelledType>>;
 
 type _publicOnAppInstancePaidPlanChangedType = typeof onAppInstancePaidPlanChanged$1;
 /**
@@ -1272,13 +1272,11 @@ type _publicOnAppInstancePaidPlanChangedType = typeof onAppInstancePaidPlanChang
  */
 declare const onAppInstancePaidPlanChanged: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanChangedType>>;
 
-type _publicOnAppInstancePaidPlanAutoRenewalCancelledType = typeof onAppInstancePaidPlanAutoRenewalCancelled$1;
+type _publicOnAppInstancePaidPlanPurchasedType = typeof onAppInstancePaidPlanPurchased$1;
 /**
- * Triggered when a site owner cancels a paid plan for your app. The
- * site owner can continue to use your app until the end of the current billing
- * cycle.
+ * Triggered when a site owner purchases a paid plan for your app.
  */
-declare const onAppInstancePaidPlanAutoRenewalCancelled: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanAutoRenewalCancelledType>>;
+declare const onAppInstancePaidPlanPurchased: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanPurchasedType>>;
 
 type context$3_AppInstalled = AppInstalled;
 type context$3_AppInstance = AppInstance;
@@ -1326,20 +1324,7 @@ declare namespace context$3 {
 interface SendBIEventResponse {
 }
 interface SendBIEventRequest {
-    /**
-     * Name of the event that's triggered in your app.
-     *
-     * + `"APP_DASHBOARD_LOADED"`: A site onwer or contributor loads your app's dashboard.
-     * + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in your app's dashboard.
-     * + `"APP_UPGRADED"`: The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side.
-     * + `"PRIMARY_ACTION_PERFORMED"`: A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app.
-     * + `"CHARGE"`: You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`.
-     * + `"FUNDS_RETURNED"`: Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`.
-     * + `"CUSTOM"`: Any event that's not listed here. Make sure to also send `customEventName`.
-     * + `"APP_DEPLOYED"`: Your app’s internal code implementation is changed and might affect user flows or cause a regression.
-     * + `"APP_FINISH_BUSINESS_SETUP"`: __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead.
-     * + `"APP_SETUP_FINISHED"`: The site owner completes your app's required business setup.
-     */
+    /** Name of the event that's triggered in your app. */
     eventName?: EventName;
     /**
      * Name of your app's custom event that was triggered. Required when `{"eventName": "CUSTOM"}`.
@@ -1362,33 +1347,31 @@ interface SendBIEventRequest {
     eventData?: Record<string, string>;
 }
 declare enum EventName {
+    /** Unknown event name. */
     UNKNOWN = "UNKNOWN",
+    /** A site owner or contributor loads your app's dashboard. */
     APP_DASHBOARD_LOADED = "APP_DASHBOARD_LOADED",
+    /** The site owner completes all required configurations for your app in your app's dashboard. */
     APP_FINISHED_CONFIGURATION = "APP_FINISHED_CONFIGURATION",
+    /** The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side. */
     APP_UPGRADED = "APP_UPGRADED",
+    /** A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app. */
     PRIMARY_ACTION_PERFORMED = "PRIMARY_ACTION_PERFORMED",
+    /** Any event that's not listed here. Make sure to also send `customEventName`. */
     CUSTOM = "CUSTOM",
+    /** You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`. */
     CHARGE = "CHARGE",
+    /** Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`. */
     FUNDS_RETURNED = "FUNDS_RETURNED",
+    /** __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead. */
     APP_FINISH_BUSINESS_SETUP = "APP_FINISH_BUSINESS_SETUP",
+    /** Your app’s internal code implementation is changed and might affect user flows or cause a regression. */
     APP_DEPLOYED = "APP_DEPLOYED",
+    /** The site owner completes your app's required business setup. */
     APP_SETUP_FINISHED = "APP_SETUP_FINISHED"
 }
 interface SendBiEventOptions {
-    /**
-     * Name of the event that's triggered in your app.
-     *
-     * + `"APP_DASHBOARD_LOADED"`: A site onwer or contributor loads your app's dashboard.
-     * + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in your app's dashboard.
-     * + `"APP_UPGRADED"`: The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side.
-     * + `"PRIMARY_ACTION_PERFORMED"`: A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app.
-     * + `"CHARGE"`: You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`.
-     * + `"FUNDS_RETURNED"`: Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`.
-     * + `"CUSTOM"`: Any event that's not listed here. Make sure to also send `customEventName`.
-     * + `"APP_DEPLOYED"`: Your app’s internal code implementation is changed and might affect user flows or cause a regression.
-     * + `"APP_FINISH_BUSINESS_SETUP"`: __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead.
-     * + `"APP_SETUP_FINISHED"`: The site owner completes your app's required business setup.
-     */
+    /** Name of the event that's triggered in your app. */
     eventName?: EventName;
     /**
      * Name of your app's custom event that was triggered. Required when `{"eventName": "CUSTOM"}`.

package/type-bundles/index.bundle.d.ts

@@ -933,12 +933,6 @@ declare enum PaymentCycle$1 {
 interface FreeTrialInfo {
     /**
      * Current free trial status.
-     *
-     * Supported values:
-     *
-     * - `IN_PROGRESS`: The free trial is currently in progress.
-     * - `ENDED`: The free trial has ended.
-     * - `NOT_AVAILABLE`: No free trial was applied, as none was available.
      * @readonly
      */
     status?: FreeTrialStatus;
@@ -949,9 +943,13 @@ interface FreeTrialInfo {
     endDate?: Date | null;
 }
 declare enum FreeTrialStatus {
+    /** Unknown trial status. */
     UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    /** The free trial is currently in progress. */
     IN_PROGRESS = "IN_PROGRESS",
+    /** The free trial has ended. */
     ENDED = "ENDED",
+    /** No free trial was applied, as none was available. */
     NOT_AVAILABLE = "NOT_AVAILABLE"
 }
 interface AvailablePlan {
@@ -1212,16 +1210,16 @@ interface AppInstanceRemovedEnvelope {
     data: AppRemoved;
     metadata: BaseEventMetadata;
 }
-interface AppInstancePaidPlanPurchasedEnvelope {
-    data: PaidPlanPurchased;
+interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
+    data: PaidPlanAutoRenewalCancelled;
     metadata: BaseEventMetadata;
 }
 interface AppInstancePaidPlanChangedEnvelope {
     data: PaidPlanChanged;
     metadata: BaseEventMetadata;
 }
-interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
-    data: PaidPlanAutoRenewalCancelled;
+interface AppInstancePaidPlanPurchasedEnvelope {
+    data: PaidPlanPurchased;
     metadata: BaseEventMetadata;
 }
 
@@ -1240,9 +1238,9 @@ interface GetAppInstanceSignature {
 }
 declare const onAppInstanceInstalled$1: EventDefinition<AppInstanceInstalledEnvelope, "AppInstalled">;
 declare const onAppInstanceRemoved$1: EventDefinition<AppInstanceRemovedEnvelope, "AppRemoved">;
-declare const onAppInstancePaidPlanPurchased$1: EventDefinition<AppInstancePaidPlanPurchasedEnvelope, "PaidPlanPurchased">;
-declare const onAppInstancePaidPlanChanged$1: EventDefinition<AppInstancePaidPlanChangedEnvelope, "PaidPlanChanged">;
 declare const onAppInstancePaidPlanAutoRenewalCancelled$1: EventDefinition<AppInstancePaidPlanAutoRenewalCancelledEnvelope, "PaidPlanAutoRenewalCancelled">;
+declare const onAppInstancePaidPlanChanged$1: EventDefinition<AppInstancePaidPlanChangedEnvelope, "PaidPlanChanged">;
+declare const onAppInstancePaidPlanPurchased$1: EventDefinition<AppInstancePaidPlanPurchasedEnvelope, "PaidPlanPurchased">;
 
 declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
 
@@ -1260,11 +1258,13 @@ type _publicOnAppInstanceRemovedType = typeof onAppInstanceRemoved$1;
  */
 declare const onAppInstanceRemoved: ReturnType<typeof createEventModule<_publicOnAppInstanceRemovedType>>;
 
-type _publicOnAppInstancePaidPlanPurchasedType = typeof onAppInstancePaidPlanPurchased$1;
+type _publicOnAppInstancePaidPlanAutoRenewalCancelledType = typeof onAppInstancePaidPlanAutoRenewalCancelled$1;
 /**
- * Triggered when a site owner purchases a paid plan for your app.
+ * Triggered when a site owner cancels a paid plan for your app. The
+ * site owner can continue to use your app until the end of the current billing
+ * cycle.
  */
-declare const onAppInstancePaidPlanPurchased: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanPurchasedType>>;
+declare const onAppInstancePaidPlanAutoRenewalCancelled: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanAutoRenewalCancelledType>>;
 
 type _publicOnAppInstancePaidPlanChangedType = typeof onAppInstancePaidPlanChanged$1;
 /**
@@ -1272,13 +1272,11 @@ type _publicOnAppInstancePaidPlanChangedType = typeof onAppInstancePaidPlanChang
  */
 declare const onAppInstancePaidPlanChanged: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanChangedType>>;
 
-type _publicOnAppInstancePaidPlanAutoRenewalCancelledType = typeof onAppInstancePaidPlanAutoRenewalCancelled$1;
+type _publicOnAppInstancePaidPlanPurchasedType = typeof onAppInstancePaidPlanPurchased$1;
 /**
- * Triggered when a site owner cancels a paid plan for your app. The
- * site owner can continue to use your app until the end of the current billing
- * cycle.
+ * Triggered when a site owner purchases a paid plan for your app.
  */
-declare const onAppInstancePaidPlanAutoRenewalCancelled: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanAutoRenewalCancelledType>>;
+declare const onAppInstancePaidPlanPurchased: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanPurchasedType>>;
 
 type index_d$3_AppInstalled = AppInstalled;
 type index_d$3_AppInstance = AppInstance;
@@ -1326,20 +1324,7 @@ declare namespace index_d$3 {
 interface SendBIEventResponse {
 }
 interface SendBIEventRequest {
-    /**
-     * Name of the event that's triggered in your app.
-     *
-     * + `"APP_DASHBOARD_LOADED"`: A site onwer or contributor loads your app's dashboard.
-     * + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in your app's dashboard.
-     * + `"APP_UPGRADED"`: The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side.
-     * + `"PRIMARY_ACTION_PERFORMED"`: A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app.
-     * + `"CHARGE"`: You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`.
-     * + `"FUNDS_RETURNED"`: Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`.
-     * + `"CUSTOM"`: Any event that's not listed here. Make sure to also send `customEventName`.
-     * + `"APP_DEPLOYED"`: Your app’s internal code implementation is changed and might affect user flows or cause a regression.
-     * + `"APP_FINISH_BUSINESS_SETUP"`: __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead.
-     * + `"APP_SETUP_FINISHED"`: The site owner completes your app's required business setup.
-     */
+    /** Name of the event that's triggered in your app. */
     eventName?: EventName;
     /**
      * Name of your app's custom event that was triggered. Required when `{"eventName": "CUSTOM"}`.
@@ -1362,33 +1347,31 @@ interface SendBIEventRequest {
     eventData?: Record<string, string>;
 }
 declare enum EventName {
+    /** Unknown event name. */
     UNKNOWN = "UNKNOWN",
+    /** A site owner or contributor loads your app's dashboard. */
     APP_DASHBOARD_LOADED = "APP_DASHBOARD_LOADED",
+    /** The site owner completes all required configurations for your app in your app's dashboard. */
     APP_FINISHED_CONFIGURATION = "APP_FINISHED_CONFIGURATION",
+    /** The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side. */
     APP_UPGRADED = "APP_UPGRADED",
+    /** A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app. */
     PRIMARY_ACTION_PERFORMED = "PRIMARY_ACTION_PERFORMED",
+    /** Any event that's not listed here. Make sure to also send `customEventName`. */
     CUSTOM = "CUSTOM",
+    /** You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`. */
     CHARGE = "CHARGE",
+    /** Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`. */
     FUNDS_RETURNED = "FUNDS_RETURNED",
+    /** __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead. */
     APP_FINISH_BUSINESS_SETUP = "APP_FINISH_BUSINESS_SETUP",
+    /** Your app’s internal code implementation is changed and might affect user flows or cause a regression. */
     APP_DEPLOYED = "APP_DEPLOYED",
+    /** The site owner completes your app's required business setup. */
     APP_SETUP_FINISHED = "APP_SETUP_FINISHED"
 }
 interface SendBiEventOptions {
-    /**
-     * Name of the event that's triggered in your app.
-     *
-     * + `"APP_DASHBOARD_LOADED"`: A site onwer or contributor loads your app's dashboard.
-     * + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in your app's dashboard.
-     * + `"APP_UPGRADED"`: The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side.
-     * + `"PRIMARY_ACTION_PERFORMED"`: A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app.
-     * + `"CHARGE"`: You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`.
-     * + `"FUNDS_RETURNED"`: Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`.
-     * + `"CUSTOM"`: Any event that's not listed here. Make sure to also send `customEventName`.
-     * + `"APP_DEPLOYED"`: Your app’s internal code implementation is changed and might affect user flows or cause a regression.
-     * + `"APP_FINISH_BUSINESS_SETUP"`: __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead.
-     * + `"APP_SETUP_FINISHED"`: The site owner completes your app's required business setup.
-     */
+    /** Name of the event that's triggered in your app. */
     eventName?: EventName;
     /**
      * Name of your app's custom event that was triggered. Required when `{"eventName": "CUSTOM"}`.

package/type-bundles/meta.bundle.d.ts

@@ -694,12 +694,6 @@ declare enum PaymentCycle$3 {
 interface FreeTrialInfo$1 {
     /**
      * Current free trial status.
-     *
-     * Supported values:
-     *
-     * - `IN_PROGRESS`: The free trial is currently in progress.
-     * - `ENDED`: The free trial has ended.
-     * - `NOT_AVAILABLE`: No free trial was applied, as none was available.
      * @readonly
      */
     status?: FreeTrialStatus$1;
@@ -710,9 +704,13 @@ interface FreeTrialInfo$1 {
     endDate?: Date | null;
 }
 declare enum FreeTrialStatus$1 {
+    /** Unknown trial status. */
     UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    /** The free trial is currently in progress. */
     IN_PROGRESS = "IN_PROGRESS",
+    /** The free trial has ended. */
     ENDED = "ENDED",
+    /** No free trial was applied, as none was available. */
     NOT_AVAILABLE = "NOT_AVAILABLE"
 }
 interface AvailablePlan$1 {
@@ -969,12 +967,6 @@ declare enum PaymentCycle$2 {
 interface FreeTrialInfo {
     /**
      * Current free trial status.
-     *
-     * Supported values:
-     *
-     * - `IN_PROGRESS`: The free trial is currently in progress.
-     * - `ENDED`: The free trial has ended.
-     * - `NOT_AVAILABLE`: No free trial was applied, as none was available.
      * @readonly
      */
     status?: FreeTrialStatus;
@@ -985,9 +977,13 @@ interface FreeTrialInfo {
     endDate?: Date | null;
 }
 declare enum FreeTrialStatus {
+    /** Unknown trial status. */
     UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    /** The free trial is currently in progress. */
     IN_PROGRESS = "IN_PROGRESS",
+    /** The free trial has ended. */
     ENDED = "ENDED",
+    /** No free trial was applied, as none was available. */
     NOT_AVAILABLE = "NOT_AVAILABLE"
 }
 interface AvailablePlan {
@@ -1155,20 +1151,7 @@ declare namespace meta$3 {
 interface SendBIEventResponse$1 {
 }
 interface SendBIEventRequest$1 {
-    /**
-     * Name of the event that's triggered in your app.
-     *
-     * + `"APP_DASHBOARD_LOADED"`: A site onwer or contributor loads your app's dashboard.
-     * + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in your app's dashboard.
-     * + `"APP_UPGRADED"`: The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side.
-     * + `"PRIMARY_ACTION_PERFORMED"`: A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app.
-     * + `"CHARGE"`: You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`.
-     * + `"FUNDS_RETURNED"`: Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`.
-     * + `"CUSTOM"`: Any event that's not listed here. Make sure to also send `customEventName`.
-     * + `"APP_DEPLOYED"`: Your app’s internal code implementation is changed and might affect user flows or cause a regression.
-     * + `"APP_FINISH_BUSINESS_SETUP"`: __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead.
-     * + `"APP_SETUP_FINISHED"`: The site owner completes your app's required business setup.
-     */
+    /** Name of the event that's triggered in your app. */
     eventName?: EventName$1;
     /**
      * Name of your app's custom event that was triggered. Required when `{"eventName": "CUSTOM"}`.
@@ -1191,36 +1174,34 @@ interface SendBIEventRequest$1 {
     eventData?: Record<string, string>;
 }
 declare enum EventName$1 {
+    /** Unknown event name. */
     UNKNOWN = "UNKNOWN",
+    /** A site owner or contributor loads your app's dashboard. */
     APP_DASHBOARD_LOADED = "APP_DASHBOARD_LOADED",
+    /** The site owner completes all required configurations for your app in your app's dashboard. */
     APP_FINISHED_CONFIGURATION = "APP_FINISHED_CONFIGURATION",
+    /** The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side. */
     APP_UPGRADED = "APP_UPGRADED",
+    /** A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app. */
     PRIMARY_ACTION_PERFORMED = "PRIMARY_ACTION_PERFORMED",
+    /** Any event that's not listed here. Make sure to also send `customEventName`. */
     CUSTOM = "CUSTOM",
+    /** You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`. */
     CHARGE = "CHARGE",
+    /** Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`. */
     FUNDS_RETURNED = "FUNDS_RETURNED",
+    /** __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead. */
     APP_FINISH_BUSINESS_SETUP = "APP_FINISH_BUSINESS_SETUP",
+    /** Your app’s internal code implementation is changed and might affect user flows or cause a regression. */
     APP_DEPLOYED = "APP_DEPLOYED",
+    /** The site owner completes your app's required business setup. */
     APP_SETUP_FINISHED = "APP_SETUP_FINISHED"
 }
 
 interface SendBIEventResponse {
 }
 interface SendBIEventRequest {
-    /**
-     * Name of the event that's triggered in your app.
-     *
-     * + `"APP_DASHBOARD_LOADED"`: A site onwer or contributor loads your app's dashboard.
-     * + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in your app's dashboard.
-     * + `"APP_UPGRADED"`: The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side.
-     * + `"PRIMARY_ACTION_PERFORMED"`: A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app.
-     * + `"CHARGE"`: You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`.
-     * + `"FUNDS_RETURNED"`: Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`.
-     * + `"CUSTOM"`: Any event that's not listed here. Make sure to also send `customEventName`.
-     * + `"APP_DEPLOYED"`: Your app’s internal code implementation is changed and might affect user flows or cause a regression.
-     * + `"APP_FINISH_BUSINESS_SETUP"`: __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead.
-     * + `"APP_SETUP_FINISHED"`: The site owner completes your app's required business setup.
-     */
+    /** Name of the event that's triggered in your app. */
     eventName?: EventName;
     /**
      * Name of your app's custom event that was triggered. Required when `{"eventName": "CUSTOM"}`.
@@ -1243,16 +1224,27 @@ interface SendBIEventRequest {
     eventData?: Record<string, string>;
 }
 declare enum EventName {
+    /** Unknown event name. */
     UNKNOWN = "UNKNOWN",
+    /** A site owner or contributor loads your app's dashboard. */
     APP_DASHBOARD_LOADED = "APP_DASHBOARD_LOADED",
+    /** The site owner completes all required configurations for your app in your app's dashboard. */
     APP_FINISHED_CONFIGURATION = "APP_FINISHED_CONFIGURATION",
+    /** The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side. */
     APP_UPGRADED = "APP_UPGRADED",
+    /** A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app. */
     PRIMARY_ACTION_PERFORMED = "PRIMARY_ACTION_PERFORMED",
+    /** Any event that's not listed here. Make sure to also send `customEventName`. */
     CUSTOM = "CUSTOM",
+    /** You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`. */
     CHARGE = "CHARGE",
+    /** Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`. */
     FUNDS_RETURNED = "FUNDS_RETURNED",
+    /** __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead. */
     APP_FINISH_BUSINESS_SETUP = "APP_FINISH_BUSINESS_SETUP",
+    /** Your app’s internal code implementation is changed and might affect user flows or cause a regression. */
     APP_DEPLOYED = "APP_DEPLOYED",
+    /** The site owner completes your app's required business setup. */
     APP_SETUP_FINISHED = "APP_SETUP_FINISHED"
 }