@wix/app-management 1.0.34 → 1.0.35

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/app-management",
-  "version": "1.0.34",
+  "version": "1.0.35",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -19,10 +19,10 @@
     "service-plugins"
   ],
   "dependencies": {
-    "@wix/app-management_app-instances": "1.0.19",
+    "@wix/app-management_app-instances": "1.0.20",
     "@wix/app-management_app-plans": "1.0.19",
-    "@wix/app-management_bi-events": "1.0.17",
-    "@wix/app-management_billing": "1.0.18",
+    "@wix/app-management_bi-events": "1.0.18",
+    "@wix/app-management_billing": "1.0.19",
     "@wix/app-management_custom-charges": "1.0.15",
     "@wix/app-management_embedded-scripts": "1.0.15"
   },
@@ -49,5 +49,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "a969692c2fcc3714b71c0b92b0896127e30538971302b3a6c3387569"
+  "falconPackageHash": "9904f6c73ad75d44c4d2763f0c9cc0c4b0ef4aabddeddd97f9a0c89a"
 }

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

@@ -380,14 +380,11 @@ interface AppInstance {
      */
     instanceId?: string;
     /**
-     * App name, as set by you in the Wix Developers Center during the app creation
+     * App name, as set by you in the Customs Apps page during the app creation
      * process.
      */
     appName?: string;
-    /**
-     * Version of your app that's installed on the Wix site, as set by you in the
-     * Wix Developers Center during the app creation process.
-     */
+    /** Version of your app that's installed on the Wix site, as set by you during the app creation process. */
     appVersion?: string | null;
     /**
      * Whether the site owners have installed a free or paid version of your app
@@ -402,7 +399,7 @@ interface AppInstance {
     /**
      * List of [permissions](https://dev.wix.com/docs/build-apps/developer-tools/developers-center/example-app-walkthrough/build-an-app#4-add-permissions)
      * that the site owners have granted your app. You set the list of permissions that
-     * your app requires from the site owners in the Wix Developers Center during the
+     * your app requires from the site owners in your app's Permissions page during the
      * app creation process.
      */
     permissions?: string[];
@@ -875,7 +872,7 @@ 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 the Wix Developers Center.
+     * + `"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`.
@@ -902,7 +899,7 @@ interface SendBIEventRequest {
      * + `"currency"`: 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
      * + `"sum"`: Amount of money. Required for `{"eventName": "CHARGE"}` and `{"eventName": "FUNDS_RETURNED"}`.
      * + `"reason"`: Information about why the event was triggered in your app.
-     * + `"app_plan_id"`: ID of the your app's plan as displayed in the Developers Center. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
+     * + `"app_plan_id"`: ID of the your app's plan as displayed in your app's dashboard. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
      */
     eventData?: Record<string, string>;
 }
@@ -924,7 +921,7 @@ 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 the Wix Developers Center.
+     * + `"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`.
@@ -951,7 +948,7 @@ interface SendBiEventOptions {
      * + `"currency"`: 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
      * + `"sum"`: Amount of money. Required for `{"eventName": "CHARGE"}` and `{"eventName": "FUNDS_RETURNED"}`.
      * + `"reason"`: Information about why the event was triggered in your app.
-     * + `"app_plan_id"`: ID of the your app's plan as displayed in the Developers Center. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
+     * + `"app_plan_id"`: ID of the your app's plan as displayed in your app's dashboard. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
      */
     eventData?: Record<string, string>;
 }
@@ -1024,8 +1021,8 @@ declare enum InvoiceStatus {
 }
 interface GetUrlRequest {
     /**
-     * ID of your app's paid plan to retrieve the Wix checkout URL for. Check the
-     * Wix Developers Center for a list of your app's supported product IDs.
+     * ID of your app's paid plan to retrieve the Wix checkout URL for. Check your app's dashboard
+     * for a list of your app's supported product IDs.
      */
     productId: string;
     /**
@@ -1062,8 +1059,7 @@ interface GetUrlRequest {
 interface ChargeOverride {
     /**
      * Override price. In case you omit the override price, Wix charges site
-     * owners the app's default price that's configured in the Wix Developers
-     * Center.
+     * owners the app's default price that's configured in the Pricing page of your app's dashboard.
      */
     price?: number;
     /**
@@ -1236,14 +1232,14 @@ interface GetUrlSignature {
      *
      *
      * This call succeeds only in case you have previously
-     * [set up an external pricing page in the Wix Developers Center](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-an-external-pricing-page).
+     * [set up an external pricing page in your app's dashboard](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-an-external-pricing-page).
      *
      * The returned checkout URL is valid for 48 hours.
      *
      * This API allows your app to manage your pricing page outside of Wix while
      * still using the standard Wix checkout flow.
-     * @param - ID of your app's paid plan to retrieve the Wix checkout URL for. Check the
-     * Wix Developers Center for a list of your app's supported product IDs.
+     * @param - ID of your app's paid plan to retrieve the Wix checkout URL for. Check your app's dashboard
+     * for a list of your app's supported product IDs.
      */
     (productId: string, options?: GetUrlOptions | undefined): Promise<GetUrlResponse & GetUrlResponseNonNullableFields>;
 }

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

@@ -380,14 +380,11 @@ interface AppInstance {
      */
     instanceId?: string;
     /**
-     * App name, as set by you in the Wix Developers Center during the app creation
+     * App name, as set by you in the Customs Apps page during the app creation
      * process.
      */
     appName?: string;
-    /**
-     * Version of your app that's installed on the Wix site, as set by you in the
-     * Wix Developers Center during the app creation process.
-     */
+    /** Version of your app that's installed on the Wix site, as set by you during the app creation process. */
     appVersion?: string | null;
     /**
      * Whether the site owners have installed a free or paid version of your app
@@ -402,7 +399,7 @@ interface AppInstance {
     /**
      * List of [permissions](https://dev.wix.com/docs/build-apps/developer-tools/developers-center/example-app-walkthrough/build-an-app#4-add-permissions)
      * that the site owners have granted your app. You set the list of permissions that
-     * your app requires from the site owners in the Wix Developers Center during the
+     * your app requires from the site owners in your app's Permissions page during the
      * app creation process.
      */
     permissions?: string[];
@@ -875,7 +872,7 @@ 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 the Wix Developers Center.
+     * + `"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`.
@@ -902,7 +899,7 @@ interface SendBIEventRequest {
      * + `"currency"`: 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
      * + `"sum"`: Amount of money. Required for `{"eventName": "CHARGE"}` and `{"eventName": "FUNDS_RETURNED"}`.
      * + `"reason"`: Information about why the event was triggered in your app.
-     * + `"app_plan_id"`: ID of the your app's plan as displayed in the Developers Center. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
+     * + `"app_plan_id"`: ID of the your app's plan as displayed in your app's dashboard. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
      */
     eventData?: Record<string, string>;
 }
@@ -924,7 +921,7 @@ 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 the Wix Developers Center.
+     * + `"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`.
@@ -951,7 +948,7 @@ interface SendBiEventOptions {
      * + `"currency"`: 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
      * + `"sum"`: Amount of money. Required for `{"eventName": "CHARGE"}` and `{"eventName": "FUNDS_RETURNED"}`.
      * + `"reason"`: Information about why the event was triggered in your app.
-     * + `"app_plan_id"`: ID of the your app's plan as displayed in the Developers Center. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
+     * + `"app_plan_id"`: ID of the your app's plan as displayed in your app's dashboard. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
      */
     eventData?: Record<string, string>;
 }
@@ -1024,8 +1021,8 @@ declare enum InvoiceStatus {
 }
 interface GetUrlRequest {
     /**
-     * ID of your app's paid plan to retrieve the Wix checkout URL for. Check the
-     * Wix Developers Center for a list of your app's supported product IDs.
+     * ID of your app's paid plan to retrieve the Wix checkout URL for. Check your app's dashboard
+     * for a list of your app's supported product IDs.
      */
     productId: string;
     /**
@@ -1062,8 +1059,7 @@ interface GetUrlRequest {
 interface ChargeOverride {
     /**
      * Override price. In case you omit the override price, Wix charges site
-     * owners the app's default price that's configured in the Wix Developers
-     * Center.
+     * owners the app's default price that's configured in the Pricing page of your app's dashboard.
      */
     price?: number;
     /**
@@ -1236,14 +1232,14 @@ interface GetUrlSignature {
      *
      *
      * This call succeeds only in case you have previously
-     * [set up an external pricing page in the Wix Developers Center](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-an-external-pricing-page).
+     * [set up an external pricing page in your app's dashboard](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-an-external-pricing-page).
      *
      * The returned checkout URL is valid for 48 hours.
      *
      * This API allows your app to manage your pricing page outside of Wix while
      * still using the standard Wix checkout flow.
-     * @param - ID of your app's paid plan to retrieve the Wix checkout URL for. Check the
-     * Wix Developers Center for a list of your app's supported product IDs.
+     * @param - ID of your app's paid plan to retrieve the Wix checkout URL for. Check your app's dashboard
+     * for a list of your app's supported product IDs.
      */
     (productId: string, options?: GetUrlOptions | undefined): Promise<GetUrlResponse & GetUrlResponseNonNullableFields>;
 }

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

@@ -559,14 +559,11 @@ interface AppInstance$1 {
      */
     instanceId?: string;
     /**
-     * App name, as set by you in the Wix Developers Center during the app creation
+     * App name, as set by you in the Customs Apps page during the app creation
      * process.
      */
     appName?: string;
-    /**
-     * Version of your app that's installed on the Wix site, as set by you in the
-     * Wix Developers Center during the app creation process.
-     */
+    /** Version of your app that's installed on the Wix site, as set by you during the app creation process. */
     appVersion?: string | null;
     /**
      * Whether the site owners have installed a free or paid version of your app
@@ -581,7 +578,7 @@ interface AppInstance$1 {
     /**
      * List of [permissions](https://dev.wix.com/docs/build-apps/developer-tools/developers-center/example-app-walkthrough/build-an-app#4-add-permissions)
      * that the site owners have granted your app. You set the list of permissions that
-     * your app requires from the site owners in the Wix Developers Center during the
+     * your app requires from the site owners in your app's Permissions page during the
      * app creation process.
      */
     permissions?: string[];
@@ -837,14 +834,11 @@ interface AppInstance {
      */
     instanceId?: string;
     /**
-     * App name, as set by you in the Wix Developers Center during the app creation
+     * App name, as set by you in the Customs Apps page during the app creation
      * process.
      */
     appName?: string;
-    /**
-     * Version of your app that's installed on the Wix site, as set by you in the
-     * Wix Developers Center during the app creation process.
-     */
+    /** Version of your app that's installed on the Wix site, as set by you during the app creation process. */
     appVersion?: string | null;
     /**
      * Whether the site owners have installed a free or paid version of your app
@@ -859,7 +853,7 @@ interface AppInstance {
     /**
      * List of [permissions](https://dev.wix.com/docs/build-apps/developer-tools/developers-center/example-app-walkthrough/build-an-app#4-add-permissions)
      * that the site owners have granted your app. You set the list of permissions that
-     * your app requires from the site owners in the Wix Developers Center during the
+     * your app requires from the site owners in your app's Permissions page during the
      * app creation process.
      */
     permissions?: string[];
@@ -1125,7 +1119,7 @@ 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 the Wix Developers Center.
+     * + `"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`.
@@ -1152,7 +1146,7 @@ interface SendBIEventRequest$1 {
      * + `"currency"`: 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
      * + `"sum"`: Amount of money. Required for `{"eventName": "CHARGE"}` and `{"eventName": "FUNDS_RETURNED"}`.
      * + `"reason"`: Information about why the event was triggered in your app.
-     * + `"app_plan_id"`: ID of the your app's plan as displayed in the Developers Center. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
+     * + `"app_plan_id"`: ID of the your app's plan as displayed in your app's dashboard. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
      */
     eventData?: Record<string, string>;
 }
@@ -1177,7 +1171,7 @@ 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 the Wix Developers Center.
+     * + `"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`.
@@ -1204,7 +1198,7 @@ interface SendBIEventRequest {
      * + `"currency"`: 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
      * + `"sum"`: Amount of money. Required for `{"eventName": "CHARGE"}` and `{"eventName": "FUNDS_RETURNED"}`.
      * + `"reason"`: Information about why the event was triggered in your app.
-     * + `"app_plan_id"`: ID of the your app's plan as displayed in the Developers Center. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
+     * + `"app_plan_id"`: ID of the your app's plan as displayed in your app's dashboard. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
      */
     eventData?: Record<string, string>;
 }
@@ -1269,8 +1263,8 @@ declare enum PaymentCycle$1 {
 }
 interface GetUrlRequest$1 {
     /**
-     * ID of your app's paid plan to retrieve the Wix checkout URL for. Check the
-     * Wix Developers Center for a list of your app's supported product IDs.
+     * ID of your app's paid plan to retrieve the Wix checkout URL for. Check your app's dashboard
+     * for a list of your app's supported product IDs.
      */
     productId: string;
     /**
@@ -1363,8 +1357,8 @@ declare enum PaymentCycle {
 }
 interface GetUrlRequest {
     /**
-     * ID of your app's paid plan to retrieve the Wix checkout URL for. Check the
-     * Wix Developers Center for a list of your app's supported product IDs.
+     * ID of your app's paid plan to retrieve the Wix checkout URL for. Check your app's dashboard
+     * for a list of your app's supported product IDs.
      */
     productId: string;
     /**