@wix/app-management 1.0.32 → 1.0.33

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/app-management",
3
- "version": "1.0.32",
3
+ "version": "1.0.33",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -19,7 +19,7 @@
19
19
  "service-plugins"
20
20
  ],
21
21
  "dependencies": {
22
- "@wix/app-management_app-instances": "1.0.18",
22
+ "@wix/app-management_app-instances": "1.0.19",
23
23
  "@wix/app-management_app-plans": "1.0.18",
24
24
  "@wix/app-management_bi-events": "1.0.17",
25
25
  "@wix/app-management_billing": "1.0.18",
@@ -49,5 +49,5 @@
49
49
  "fqdn": ""
50
50
  }
51
51
  },
52
- "falconPackageHash": "257ad2e4bdf9f0df54e2729996c8128fc27f70e5a59af94d94e459fc"
52
+ "falconPackageHash": "f96614c45ac9cd09a730405b04c2f7f7ece43fc58f231959557bd114"
53
53
  }
@@ -735,16 +735,13 @@ interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
735
735
  declare function getAppInstance$1(httpClient: HttpClient): GetAppInstanceSignature;
736
736
  interface GetAppInstanceSignature {
737
737
  /**
738
- * Retrieves data about the instance of your app that's installed on the Wix
739
- * site and the site itself.
738
+ * Retrieves data about the instance of your app that's installed on a Wix site and data about the site itself.
740
739
  *
740
+ * Call this function when you need information about a specific instance of your app and the site it’s installed on. For example, you may need to know whether the user has installed a free or paid version of your app, or to check what other Wix apps are installed on the site.
741
741
  *
742
- * You don't have to explicitly pass an identifier for the Wix site as part of
743
- * the request, since this information is taken automatically from the context.
742
+ * You must authenticate as a [Wix App](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-apps). If you are calling this function from a [dashboard extension](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/dashboard-extensions/about-dashboard-extensions) in the [CLI](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/wix-cli/about-the-wix-cli-for-apps), Wix App authentication is passed automatically. Otherwise, you need to call the function with [elevated permissions](https://dev.wix.com/docs/sdk/articles/working-with-the-sdk/about-elevated-permissions).
744
743
  *
745
- * In case you want `site.ownerInfo` to be included in the response, you must
746
- * have the __Read Site Owner Email__ permission scope in addition to
747
- * __WIX_DEVELOPERS.MANAGE_APP_INSTANCE__.
744
+ * If you want `site.ownerInfo` to be included in the response, you must have the __Read Site Owner Email__ permission scope in addition to __WIX_DEVELOPERS.MANAGE_APP_INSTANCE__.
748
745
  */
749
746
  (): Promise<GetAppInstanceResponse & GetAppInstanceResponseNonNullableFields>;
750
747
  }
@@ -735,16 +735,13 @@ interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
735
735
  declare function getAppInstance$1(httpClient: HttpClient): GetAppInstanceSignature;
736
736
  interface GetAppInstanceSignature {
737
737
  /**
738
- * Retrieves data about the instance of your app that's installed on the Wix
739
- * site and the site itself.
738
+ * Retrieves data about the instance of your app that's installed on a Wix site and data about the site itself.
740
739
  *
740
+ * Call this function when you need information about a specific instance of your app and the site it’s installed on. For example, you may need to know whether the user has installed a free or paid version of your app, or to check what other Wix apps are installed on the site.
741
741
  *
742
- * You don't have to explicitly pass an identifier for the Wix site as part of
743
- * the request, since this information is taken automatically from the context.
742
+ * You must authenticate as a [Wix App](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-apps). If you are calling this function from a [dashboard extension](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/dashboard-extensions/about-dashboard-extensions) in the [CLI](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/wix-cli/about-the-wix-cli-for-apps), Wix App authentication is passed automatically. Otherwise, you need to call the function with [elevated permissions](https://dev.wix.com/docs/sdk/articles/working-with-the-sdk/about-elevated-permissions).
744
743
  *
745
- * In case you want `site.ownerInfo` to be included in the response, you must
746
- * have the __Read Site Owner Email__ permission scope in addition to
747
- * __WIX_DEVELOPERS.MANAGE_APP_INSTANCE__.
744
+ * If you want `site.ownerInfo` to be included in the response, you must have the __Read Site Owner Email__ permission scope in addition to __WIX_DEVELOPERS.MANAGE_APP_INSTANCE__.
748
745
  */
749
746
  (): Promise<GetAppInstanceResponse & GetAppInstanceResponseNonNullableFields>;
750
747
  }