@wix/auto_sdk_app-management_app-instances 1.0.6 → 1.0.7

package/build/{cjs/src/devcenter-app-instance-v1-app-instance-app-instances.types.d.ts → devcenter-app-instance-v1-app-instance-app-instances.universal-B6ZXBoac.d.mts}

@@ -4,7 +4,7 @@
  * specific site. Use the `instanceId` to keep track of the individual data
  * associated with each app instance.
  */
-export interface AppInstance {
+interface AppInstance {
     /**
      * App instance ID. Useful to keep track of the
      * data that's associated with the specific instance of your app
@@ -52,7 +52,7 @@ export interface AppInstance {
     /** Whether this app instance includes a free trial that hasn't started yet. */
     freeTrialAvailable?: boolean;
 }
-export interface BillingInfo {
+interface BillingInfo {
     /** Name of the package that the site owner has paid for. */
     packageName?: string;
     /**
@@ -92,7 +92,7 @@ export interface BillingInfo {
     /** Information about the free trial applied, if relevant. */
     freeTrialInfo?: FreeTrialInfo;
 }
-export declare enum PaymentCycle {
+declare enum PaymentCycle {
     NO_CYCLE = "NO_CYCLE",
     MONTHLY = "MONTHLY",
     YEARLY = "YEARLY",
@@ -102,7 +102,7 @@ export declare enum PaymentCycle {
     FOUR_YEARS = "FOUR_YEARS",
     FIVE_YEARS = "FIVE_YEARS"
 }
-export interface FreeTrialInfo {
+interface FreeTrialInfo {
     /**
      * Current free trial status.
      * @readonly
@@ -114,7 +114,7 @@ export interface FreeTrialInfo {
      */
     endDate?: Date | null;
 }
-export declare enum FreeTrialStatus {
+declare enum FreeTrialStatus {
     /** Unknown trial status. */
     UNKNOWN_STATUS = "UNKNOWN_STATUS",
     /** The free trial is currently in progress. */
@@ -124,13 +124,13 @@ export declare enum FreeTrialStatus {
     /** No free trial was applied, as none was available. */
     NOT_AVAILABLE = "NOT_AVAILABLE"
 }
-export interface AvailablePlan {
+interface AvailablePlan {
     /** Package name of the available plan. */
     packageName?: string;
     /** Source of the available plan. Can be a bundle or 3rd-party app. */
     source?: string;
 }
-export interface AppInstalled {
+interface AppInstalled {
     /**
      * Unique identifier of the app within the website.
      * @format GUID
@@ -142,14 +142,14 @@ export interface AppInstalled {
      */
     originInstanceId?: string | null;
 }
-export interface AppRemoved {
+interface AppRemoved {
     /**
      * Unique identifier of the app within the website.
      * @format GUID
      */
     appId?: string;
 }
-export interface PaidPlanPurchased {
+interface PaidPlanPurchased {
     /** Date and time of purchase. */
     operationTimeStamp?: Date | null;
     /**
@@ -172,7 +172,7 @@ export interface PaidPlanPurchased {
      */
     invoiceId?: string | null;
 }
-export interface PaidPlanChanged {
+interface PaidPlanChanged {
     /** Date and time of change. */
     operationTimeStamp?: Date | null;
     /**
@@ -200,7 +200,7 @@ export interface PaidPlanChanged {
      */
     invoiceId?: string | null;
 }
-export interface PaidPlanAutoRenewalCancelled {
+interface PaidPlanAutoRenewalCancelled {
     /** Date and time of auto-renewal cancellation. */
     operationTimeStamp?: Date | null;
     /**
@@ -228,7 +228,7 @@ export interface PaidPlanAutoRenewalCancelled {
     /** Whether the cancellation occurred during a free trial. */
     cancelledDuringFreeTrial?: FreeTrialPeriod;
 }
-export declare enum FreeTrialPeriod {
+declare enum FreeTrialPeriod {
     /** Free trial status unknown. */
     FREE_TRIAL_PERIOD_UNKNOWN = "FREE_TRIAL_PERIOD_UNKNOWN",
     /** During a free trial period. */
@@ -236,7 +236,7 @@ export declare enum FreeTrialPeriod {
     /** Not during a free trial period. */
     NOT_DURING_FREE_TRIAL = "NOT_DURING_FREE_TRIAL"
 }
-export interface PlanTransferred {
+interface PlanTransferred {
     /** Date and time of transfer. */
     operationTimeStamp?: Date | null;
     /**
@@ -262,7 +262,7 @@ export interface PlanTransferred {
      */
     targetInstanceId?: string | null;
 }
-export interface PlanReactivated {
+interface PlanReactivated {
     /** Date and time of reactivation. */
     operationTimeStamp?: Date | null;
     /**
@@ -282,13 +282,13 @@ export interface PlanReactivated {
     /** Reason for reactivation. */
     reason?: ReactivationReason;
 }
-export declare enum ReactivationReason {
+declare enum ReactivationReason {
     /** Reactivation reason unknown. */
     REACTIVATION_REASON_UNKNOWN = "REACTIVATION_REASON_UNKNOWN",
     /** The subscription's auto-renew is turned on. */
     AUTO_RENEW_TURNED_ON = "AUTO_RENEW_TURNED_ON"
 }
-export interface PlanFreeTrialConvertedToPaid {
+interface PlanFreeTrialConvertedToPaid {
     /** Date and time of conversion to paid subscription (free-trial ended). */
     operationTimeStamp?: Date | null;
     /**
@@ -301,15 +301,15 @@ export interface PlanFreeTrialConvertedToPaid {
     /** Plan expiration date. */
     expiresOn?: Date | null;
 }
-export interface GetAppInstanceRequest {
+interface GetAppInstanceRequest {
 }
-export interface GetAppInstanceResponse {
+interface GetAppInstanceResponse {
     /** Retrieved app instance. */
     instance?: AppInstance;
     /** Information about the site. */
     site?: SiteInfo;
 }
-export interface SiteInfo {
+interface SiteInfo {
     /** Display name of the site. */
     siteDisplayName?: string | null;
     /**
@@ -344,13 +344,13 @@ export interface SiteInfo {
     /** Site ID. */
     siteId?: string;
 }
-export interface Multilingual {
+interface Multilingual {
     /** Whether the site supports more than a single language. */
     isMultiLingual?: boolean;
     /** List of supported languages. Returned only when `{"isMultiLingual": true}`. */
     supportedLanguages?: SupportedLanguage[];
 }
-export interface SupportedLanguage {
+interface SupportedLanguage {
     /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
     languageCode?: string;
     /** Locale. */
@@ -362,18 +362,18 @@ export interface SupportedLanguage {
     /** How the language will be resolved. For internal use. */
     resolutionMethod?: ResolutionMethod;
 }
-export interface Locale {
+interface Locale {
     /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
     languageCode?: string;
     /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
     country?: string;
 }
-export declare enum ResolutionMethod {
+declare enum ResolutionMethod {
     QUERY_PARAM = "QUERY_PARAM",
     SUBDOMAIN = "SUBDOMAIN",
     SUBDIRECTORY = "SUBDIRECTORY"
 }
-export interface OwnerInfo {
+interface OwnerInfo {
     /**
      * Wix user's email address. Identical to the their login email.
      * @format EMAIL
@@ -388,14 +388,14 @@ export interface OwnerInfo {
      */
     emailStatus?: string;
 }
-export interface GetAppInstanceByInstanceIdRequest {
+interface GetAppInstanceByInstanceIdRequest {
     /**
      * ID of the app instance to retrieve.
      * @format GUID
      */
     instanceId?: string;
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -411,7 +411,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -436,7 +436,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -458,10 +458,46 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface AppInstanceInstalledEnvelope {
+    data: AppInstalled;
+    metadata: BaseEventMetadata;
+}
+interface AppInstanceRemovedEnvelope {
+    data: AppRemoved;
+    metadata: BaseEventMetadata;
+}
+interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
+    data: PaidPlanAutoRenewalCancelled;
+    metadata: BaseEventMetadata;
+}
+interface AppInstancePaidPlanChangedEnvelope {
+    data: PaidPlanChanged;
+    metadata: BaseEventMetadata;
+}
+interface AppInstancePaidPlanPurchasedEnvelope {
+    data: PaidPlanPurchased;
+    metadata: BaseEventMetadata;
+}
+
+export { type AppInstance as A, type BillingInfo as B, FreeTrialStatus as F, type GetAppInstanceResponse as G, type IdentificationData as I, type Locale as L, type Multilingual as M, type OwnerInfo as O, PaymentCycle as P, ReactivationReason as R, type SiteInfo as S, WebhookIdentityType as W, FreeTrialPeriod as a, ResolutionMethod as b, type FreeTrialInfo as c, type AvailablePlan as d, type AppInstalled as e, type AppRemoved as f, type PaidPlanPurchased as g, type PaidPlanChanged as h, type PaidPlanAutoRenewalCancelled as i, type PlanTransferred as j, type PlanReactivated as k, type PlanFreeTrialConvertedToPaid as l, type GetAppInstanceRequest as m, type SupportedLanguage as n, type GetAppInstanceByInstanceIdRequest as o, type MessageEnvelope as p, type IdentificationDataIdOneOf as q, type BaseEventMetadata as r, type AppInstanceInstalledEnvelope as s, type AppInstanceRemovedEnvelope as t, type AppInstancePaidPlanAutoRenewalCancelledEnvelope as u, type AppInstancePaidPlanChangedEnvelope as v, type AppInstancePaidPlanPurchasedEnvelope as w };

package/build/{internal/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.types.d.ts → devcenter-app-instance-v1-app-instance-app-instances.universal-B6ZXBoac.d.ts}

@@ -4,7 +4,7 @@
  * specific site. Use the `instanceId` to keep track of the individual data
  * associated with each app instance.
  */
-export interface AppInstance {
+interface AppInstance {
     /**
      * App instance ID. Useful to keep track of the
      * data that's associated with the specific instance of your app
@@ -52,7 +52,7 @@ export interface AppInstance {
     /** Whether this app instance includes a free trial that hasn't started yet. */
     freeTrialAvailable?: boolean;
 }
-export interface BillingInfo {
+interface BillingInfo {
     /** Name of the package that the site owner has paid for. */
     packageName?: string;
     /**
@@ -92,7 +92,7 @@ export interface BillingInfo {
     /** Information about the free trial applied, if relevant. */
     freeTrialInfo?: FreeTrialInfo;
 }
-export declare enum PaymentCycle {
+declare enum PaymentCycle {
     NO_CYCLE = "NO_CYCLE",
     MONTHLY = "MONTHLY",
     YEARLY = "YEARLY",
@@ -102,7 +102,7 @@ export declare enum PaymentCycle {
     FOUR_YEARS = "FOUR_YEARS",
     FIVE_YEARS = "FIVE_YEARS"
 }
-export interface FreeTrialInfo {
+interface FreeTrialInfo {
     /**
      * Current free trial status.
      * @readonly
@@ -114,7 +114,7 @@ export interface FreeTrialInfo {
      */
     endDate?: Date | null;
 }
-export declare enum FreeTrialStatus {
+declare enum FreeTrialStatus {
     /** Unknown trial status. */
     UNKNOWN_STATUS = "UNKNOWN_STATUS",
     /** The free trial is currently in progress. */
@@ -124,13 +124,13 @@ export declare enum FreeTrialStatus {
     /** No free trial was applied, as none was available. */
     NOT_AVAILABLE = "NOT_AVAILABLE"
 }
-export interface AvailablePlan {
+interface AvailablePlan {
     /** Package name of the available plan. */
     packageName?: string;
     /** Source of the available plan. Can be a bundle or 3rd-party app. */
     source?: string;
 }
-export interface AppInstalled {
+interface AppInstalled {
     /**
      * Unique identifier of the app within the website.
      * @format GUID
@@ -142,14 +142,14 @@ export interface AppInstalled {
      */
     originInstanceId?: string | null;
 }
-export interface AppRemoved {
+interface AppRemoved {
     /**
      * Unique identifier of the app within the website.
      * @format GUID
      */
     appId?: string;
 }
-export interface PaidPlanPurchased {
+interface PaidPlanPurchased {
     /** Date and time of purchase. */
     operationTimeStamp?: Date | null;
     /**
@@ -172,7 +172,7 @@ export interface PaidPlanPurchased {
      */
     invoiceId?: string | null;
 }
-export interface PaidPlanChanged {
+interface PaidPlanChanged {
     /** Date and time of change. */
     operationTimeStamp?: Date | null;
     /**
@@ -200,7 +200,7 @@ export interface PaidPlanChanged {
      */
     invoiceId?: string | null;
 }
-export interface PaidPlanAutoRenewalCancelled {
+interface PaidPlanAutoRenewalCancelled {
     /** Date and time of auto-renewal cancellation. */
     operationTimeStamp?: Date | null;
     /**
@@ -228,7 +228,7 @@ export interface PaidPlanAutoRenewalCancelled {
     /** Whether the cancellation occurred during a free trial. */
     cancelledDuringFreeTrial?: FreeTrialPeriod;
 }
-export declare enum FreeTrialPeriod {
+declare enum FreeTrialPeriod {
     /** Free trial status unknown. */
     FREE_TRIAL_PERIOD_UNKNOWN = "FREE_TRIAL_PERIOD_UNKNOWN",
     /** During a free trial period. */
@@ -236,7 +236,7 @@ export declare enum FreeTrialPeriod {
     /** Not during a free trial period. */
     NOT_DURING_FREE_TRIAL = "NOT_DURING_FREE_TRIAL"
 }
-export interface PlanTransferred {
+interface PlanTransferred {
     /** Date and time of transfer. */
     operationTimeStamp?: Date | null;
     /**
@@ -262,7 +262,7 @@ export interface PlanTransferred {
      */
     targetInstanceId?: string | null;
 }
-export interface PlanReactivated {
+interface PlanReactivated {
     /** Date and time of reactivation. */
     operationTimeStamp?: Date | null;
     /**
@@ -282,13 +282,13 @@ export interface PlanReactivated {
     /** Reason for reactivation. */
     reason?: ReactivationReason;
 }
-export declare enum ReactivationReason {
+declare enum ReactivationReason {
     /** Reactivation reason unknown. */
     REACTIVATION_REASON_UNKNOWN = "REACTIVATION_REASON_UNKNOWN",
     /** The subscription's auto-renew is turned on. */
     AUTO_RENEW_TURNED_ON = "AUTO_RENEW_TURNED_ON"
 }
-export interface PlanFreeTrialConvertedToPaid {
+interface PlanFreeTrialConvertedToPaid {
     /** Date and time of conversion to paid subscription (free-trial ended). */
     operationTimeStamp?: Date | null;
     /**
@@ -301,15 +301,15 @@ export interface PlanFreeTrialConvertedToPaid {
     /** Plan expiration date. */
     expiresOn?: Date | null;
 }
-export interface GetAppInstanceRequest {
+interface GetAppInstanceRequest {
 }
-export interface GetAppInstanceResponse {
+interface GetAppInstanceResponse {
     /** Retrieved app instance. */
     instance?: AppInstance;
     /** Information about the site. */
     site?: SiteInfo;
 }
-export interface SiteInfo {
+interface SiteInfo {
     /** Display name of the site. */
     siteDisplayName?: string | null;
     /**
@@ -344,13 +344,13 @@ export interface SiteInfo {
     /** Site ID. */
     siteId?: string;
 }
-export interface Multilingual {
+interface Multilingual {
     /** Whether the site supports more than a single language. */
     isMultiLingual?: boolean;
     /** List of supported languages. Returned only when `{"isMultiLingual": true}`. */
     supportedLanguages?: SupportedLanguage[];
 }
-export interface SupportedLanguage {
+interface SupportedLanguage {
     /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
     languageCode?: string;
     /** Locale. */
@@ -362,18 +362,18 @@ export interface SupportedLanguage {
     /** How the language will be resolved. For internal use. */
     resolutionMethod?: ResolutionMethod;
 }
-export interface Locale {
+interface Locale {
     /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
     languageCode?: string;
     /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
     country?: string;
 }
-export declare enum ResolutionMethod {
+declare enum ResolutionMethod {
     QUERY_PARAM = "QUERY_PARAM",
     SUBDOMAIN = "SUBDOMAIN",
     SUBDIRECTORY = "SUBDIRECTORY"
 }
-export interface OwnerInfo {
+interface OwnerInfo {
     /**
      * Wix user's email address. Identical to the their login email.
      * @format EMAIL
@@ -388,14 +388,14 @@ export interface OwnerInfo {
      */
     emailStatus?: string;
 }
-export interface GetAppInstanceByInstanceIdRequest {
+interface GetAppInstanceByInstanceIdRequest {
     /**
      * ID of the app instance to retrieve.
      * @format GUID
      */
     instanceId?: string;
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -411,7 +411,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -436,7 +436,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -458,10 +458,46 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface AppInstanceInstalledEnvelope {
+    data: AppInstalled;
+    metadata: BaseEventMetadata;
+}
+interface AppInstanceRemovedEnvelope {
+    data: AppRemoved;
+    metadata: BaseEventMetadata;
+}
+interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
+    data: PaidPlanAutoRenewalCancelled;
+    metadata: BaseEventMetadata;
+}
+interface AppInstancePaidPlanChangedEnvelope {
+    data: PaidPlanChanged;
+    metadata: BaseEventMetadata;
+}
+interface AppInstancePaidPlanPurchasedEnvelope {
+    data: PaidPlanPurchased;
+    metadata: BaseEventMetadata;
+}
+
+export { type AppInstance as A, type BillingInfo as B, FreeTrialStatus as F, type GetAppInstanceResponse as G, type IdentificationData as I, type Locale as L, type Multilingual as M, type OwnerInfo as O, PaymentCycle as P, ReactivationReason as R, type SiteInfo as S, WebhookIdentityType as W, FreeTrialPeriod as a, ResolutionMethod as b, type FreeTrialInfo as c, type AvailablePlan as d, type AppInstalled as e, type AppRemoved as f, type PaidPlanPurchased as g, type PaidPlanChanged as h, type PaidPlanAutoRenewalCancelled as i, type PlanTransferred as j, type PlanReactivated as k, type PlanFreeTrialConvertedToPaid as l, type GetAppInstanceRequest as m, type SupportedLanguage as n, type GetAppInstanceByInstanceIdRequest as o, type MessageEnvelope as p, type IdentificationDataIdOneOf as q, type BaseEventMetadata as r, type AppInstanceInstalledEnvelope as s, type AppInstanceRemovedEnvelope as t, type AppInstancePaidPlanAutoRenewalCancelledEnvelope as u, type AppInstancePaidPlanChangedEnvelope as v, type AppInstancePaidPlanPurchasedEnvelope as w };

package/build/index.d.mts

@@ -0,0 +1,46 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { G as GetAppInstanceResponse } from './devcenter-app-instance-v1-app-instance-app-instances.universal-B6ZXBoac.mjs';
+export { e as AppInstalled, A as AppInstance, s as AppInstanceInstalledEnvelope, u as AppInstancePaidPlanAutoRenewalCancelledEnvelope, v as AppInstancePaidPlanChangedEnvelope, w as AppInstancePaidPlanPurchasedEnvelope, t as AppInstanceRemovedEnvelope, f as AppRemoved, d as AvailablePlan, r as BaseEventMetadata, B as BillingInfo, c as FreeTrialInfo, a as FreeTrialPeriod, F as FreeTrialStatus, o as GetAppInstanceByInstanceIdRequest, m as GetAppInstanceRequest, I as IdentificationData, q as IdentificationDataIdOneOf, L as Locale, p as MessageEnvelope, M as Multilingual, O as OwnerInfo, i as PaidPlanAutoRenewalCancelled, h as PaidPlanChanged, g as PaidPlanPurchased, P as PaymentCycle, l as PlanFreeTrialConvertedToPaid, k as PlanReactivated, j as PlanTransferred, R as ReactivationReason, b as ResolutionMethod, S as SiteInfo, n as SupportedLanguage, W as WebhookIdentityType } from './devcenter-app-instance-v1-app-instance-app-instances.universal-B6ZXBoac.mjs';
+import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
+
+declare function getAppInstance$1(httpClient: HttpClient): GetAppInstanceSignature;
+interface GetAppInstanceSignature {
+    /**
+     * Retrieves data about the instance of your app that's installed on a Wix
+     * site and data about the site itself. For example, to check whether the Wix user has installed a free or paid version of your app,
+     * or to check which apps made by Wix are installed on the site.
+     *
+     * You must authenticate this method as a Wix app ([REST](https://dev.wix.com/docs/rest/articles/getting-started/about-identities#wix-app) | [SDK](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-apps)).
+     *
+     * To retrieve `site.ownerInfo` in the response, you must
+     * have the __READ SITE OWNER EMAIL__ permission scope in addition to
+     * __MANAGE YOUR APP__.
+     */
+    (): Promise<GetAppInstanceResponse>;
+}
+
+declare const getAppInstance: MaybeContext<BuildRESTFunction<typeof getAppInstance$1> & typeof getAppInstance$1>;
+/**
+ * Triggered when an instance of your app is installed on a Wix site.
+ */
+declare const onAppInstanceInstalled: ReturnType<typeof createEventModule<typeof publicOnAppInstanceInstalled>>;
+/**
+ * Triggered when an instance of your app is uninstalled from a Wix site.
+ */
+declare const onAppInstanceRemoved: ReturnType<typeof createEventModule<typeof publicOnAppInstanceRemoved>>;
+/**
+ * Triggered when a Wix user cancels a paid plan for your app. The
+ * Wix user can continue to use your app until the end of the current billing
+ * cycle.
+ */
+declare const onAppInstancePaidPlanAutoRenewalCancelled: ReturnType<typeof createEventModule<typeof publicOnAppInstancePaidPlanAutoRenewalCancelled>>;
+/**
+ * Triggered when a Wix user upgrades or downgrades their plan for your app.
+ */
+declare const onAppInstancePaidPlanChanged: ReturnType<typeof createEventModule<typeof publicOnAppInstancePaidPlanChanged>>;
+/**
+ * Triggered when a Wix user purchases a paid plan for your app.
+ */
+declare const onAppInstancePaidPlanPurchased: ReturnType<typeof createEventModule<typeof publicOnAppInstancePaidPlanPurchased>>;
+
+export { GetAppInstanceResponse, getAppInstance, onAppInstanceInstalled, onAppInstancePaidPlanAutoRenewalCancelled, onAppInstancePaidPlanChanged, onAppInstancePaidPlanPurchased, onAppInstanceRemoved };

package/build/index.d.ts

@@ -0,0 +1,46 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { G as GetAppInstanceResponse } from './devcenter-app-instance-v1-app-instance-app-instances.universal-B6ZXBoac.js';
+export { e as AppInstalled, A as AppInstance, s as AppInstanceInstalledEnvelope, u as AppInstancePaidPlanAutoRenewalCancelledEnvelope, v as AppInstancePaidPlanChangedEnvelope, w as AppInstancePaidPlanPurchasedEnvelope, t as AppInstanceRemovedEnvelope, f as AppRemoved, d as AvailablePlan, r as BaseEventMetadata, B as BillingInfo, c as FreeTrialInfo, a as FreeTrialPeriod, F as FreeTrialStatus, o as GetAppInstanceByInstanceIdRequest, m as GetAppInstanceRequest, I as IdentificationData, q as IdentificationDataIdOneOf, L as Locale, p as MessageEnvelope, M as Multilingual, O as OwnerInfo, i as PaidPlanAutoRenewalCancelled, h as PaidPlanChanged, g as PaidPlanPurchased, P as PaymentCycle, l as PlanFreeTrialConvertedToPaid, k as PlanReactivated, j as PlanTransferred, R as ReactivationReason, b as ResolutionMethod, S as SiteInfo, n as SupportedLanguage, W as WebhookIdentityType } from './devcenter-app-instance-v1-app-instance-app-instances.universal-B6ZXBoac.js';
+import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
+
+declare function getAppInstance$1(httpClient: HttpClient): GetAppInstanceSignature;
+interface GetAppInstanceSignature {
+    /**
+     * Retrieves data about the instance of your app that's installed on a Wix
+     * site and data about the site itself. For example, to check whether the Wix user has installed a free or paid version of your app,
+     * or to check which apps made by Wix are installed on the site.
+     *
+     * You must authenticate this method as a Wix app ([REST](https://dev.wix.com/docs/rest/articles/getting-started/about-identities#wix-app) | [SDK](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-apps)).
+     *
+     * To retrieve `site.ownerInfo` in the response, you must
+     * have the __READ SITE OWNER EMAIL__ permission scope in addition to
+     * __MANAGE YOUR APP__.
+     */
+    (): Promise<GetAppInstanceResponse>;
+}
+
+declare const getAppInstance: MaybeContext<BuildRESTFunction<typeof getAppInstance$1> & typeof getAppInstance$1>;
+/**
+ * Triggered when an instance of your app is installed on a Wix site.
+ */
+declare const onAppInstanceInstalled: ReturnType<typeof createEventModule<typeof publicOnAppInstanceInstalled>>;
+/**
+ * Triggered when an instance of your app is uninstalled from a Wix site.
+ */
+declare const onAppInstanceRemoved: ReturnType<typeof createEventModule<typeof publicOnAppInstanceRemoved>>;
+/**
+ * Triggered when a Wix user cancels a paid plan for your app. The
+ * Wix user can continue to use your app until the end of the current billing
+ * cycle.
+ */
+declare const onAppInstancePaidPlanAutoRenewalCancelled: ReturnType<typeof createEventModule<typeof publicOnAppInstancePaidPlanAutoRenewalCancelled>>;
+/**
+ * Triggered when a Wix user upgrades or downgrades their plan for your app.
+ */
+declare const onAppInstancePaidPlanChanged: ReturnType<typeof createEventModule<typeof publicOnAppInstancePaidPlanChanged>>;
+/**
+ * Triggered when a Wix user purchases a paid plan for your app.
+ */
+declare const onAppInstancePaidPlanPurchased: ReturnType<typeof createEventModule<typeof publicOnAppInstancePaidPlanPurchased>>;
+
+export { GetAppInstanceResponse, getAppInstance, onAppInstanceInstalled, onAppInstancePaidPlanAutoRenewalCancelled, onAppInstancePaidPlanChanged, onAppInstancePaidPlanPurchased, onAppInstanceRemoved };