@wix/auto_sdk_app-management_app-instances 1.0.23 → 1.0.24

package/build/cjs/index.d.ts

@@ -1,7 +1,8 @@
-import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-import { G as GetAppInstanceResponse, A as AppInstanceInstalledEnvelope, a as AppInstanceRemovedEnvelope, b as AppInstancePaidPlanAutoRenewalCancelledEnvelope, c as AppInstancePaidPlanChangedEnvelope, d as AppInstancePaidPlanPurchasedEnvelope, e as AppInstancePlanConvertedToPaidEnvelope, f as AppInstancePlanReactivatedEnvelope, g as AppInstancePlanTransferredEnvelope } from './devcenter-app-instance-v1-app-instance-app-instances.universal-BPA1V_1w.js';
-export { m as AppInstalled, j as AppInstance, y as AppInstanceDifference, n as AppRemoved, l as AvailablePlan, E as BaseEventMetadata, B as BillingInfo, k as FreeTrialInfo, h as FreeTrialPeriod, F as FreeTrialStatus, z as GetAppInstanceByInstanceIdRequest, u as GetAppInstanceRequest, w as GetComparatorFromFetchersRequest, x as GetComparatorFromFetchersResponse, I as IdentificationData, D as IdentificationDataIdOneOf, L as Locale, C as MessageEnvelope, M as Multilingual, O as OwnerInfo, q as PaidPlanAutoRenewalCancelled, p as PaidPlanChanged, o as PaidPlanPurchased, P as PaymentCycle, t as PlanConvertedToPaid, s as PlanReactivated, r as PlanTransferred, R as ReactivationReason, i as ResolutionMethod, S as SiteInfo, v as SupportedLanguage, W as WebhookIdentityType } from './devcenter-app-instance-v1-app-instance-app-instances.universal-BPA1V_1w.js';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { GetAppInstanceResponse, AppInstanceInstalledEnvelope, AppInstanceRemovedEnvelope, AppInstancePaidPlanAutoRenewalCancelledEnvelope, AppInstancePaidPlanChangedEnvelope, AppInstancePaidPlanPurchasedEnvelope, AppInstancePlanConvertedToPaidEnvelope, AppInstancePlanReactivatedEnvelope, AppInstancePlanTransferredEnvelope } from './index.typings.js';
+export { AppInstalled, AppInstance, AppInstanceDifference, AppRemoved, AvailablePlan, BaseEventMetadata, BillingInfo, FreeTrialInfo, FreeTrialPeriod, FreeTrialStatus, GetAppInstanceByInstanceIdRequest, GetAppInstanceRequest, GetComparatorFromFetchersRequest, GetComparatorFromFetchersResponse, IdentificationData, IdentificationDataIdOneOf, Locale, MessageEnvelope, Multilingual, OwnerInfo, PaidPlanAutoRenewalCancelled, PaidPlanChanged, PaidPlanPurchased, PaymentCycle, PlanConvertedToPaid, PlanReactivated, PlanTransferred, ReactivationReason, ResolutionMethod, SiteInfo, SupportedLanguage, WebhookIdentityType } from './index.typings.js';
 
+type AppInstanceNonNullablePaths = `instanceId` | `appName` | `isFree` | `billing.packageName` | `billing.billingCycle` | `billing.timeStamp` | `billing.freeTrialInfo.status` | `permissions` | `availablePlans` | `availablePlans.${number}.packageName` | `availablePlans.${number}.source` | `isOriginSiteTemplate` | `copiedFromTemplate` | `freeTrialAvailable`;
 declare function getAppInstance$1(httpClient: HttpClient): GetAppInstanceSignature;
 interface GetAppInstanceSignature {
     /**
@@ -15,7 +16,9 @@ interface GetAppInstanceSignature {
      * have the __READ SITE OWNER EMAIL__ permission scope in addition to
      * __MANAGE YOUR APP__.
      */
-    (): Promise<GetAppInstanceResponse>;
+    (): Promise<NonNullablePaths<GetAppInstanceResponse, {
+        [P in AppInstanceNonNullablePaths]: `instance.${P}`;
+    }[AppInstanceNonNullablePaths] | `site.locale` | `site.paymentCurrency` | `site.multilingual.isMultiLingual` | `site.multilingual.supportedLanguages` | `site.multilingual.supportedLanguages.${number}.languageCode` | `site.multilingual.supportedLanguages.${number}.locale.languageCode` | `site.multilingual.supportedLanguages.${number}.locale.country` | `site.multilingual.supportedLanguages.${number}.isPrimary` | `site.multilingual.supportedLanguages.${number}.countryCode` | `site.multilingual.supportedLanguages.${number}.resolutionMethod` | `site.installedWixApps` | `site.ownerInfo.email` | `site.ownerInfo.emailStatus` | `site.siteId`>>;
 }
 declare const onAppInstanceInstalled$1: EventDefinition<AppInstanceInstalledEnvelope, "AppInstalled">;
 declare const onAppInstanceRemoved$1: EventDefinition<AppInstanceRemovedEnvelope, "AppRemoved">;

package/build/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../index.ts","../../src/devcenter-app-instance-v1-app-instance-app-instances.public.ts","../../src/devcenter-app-instance-v1-app-instance-app-instances.universal.ts","../../src/devcenter-app-instance-v1-app-instance-app-instances.http.ts","../../src/devcenter-app-instance-v1-app-instance-app-instances.context.ts"],"sourcesContent":["export * from './src/devcenter-app-instance-v1-app-instance-app-instances.context.js';\n","import { renameKeysFromRESTResponseToSDKResponse } from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { EventDefinition, HttpClient } from '@wix/sdk-types';\nimport {\n  AppInstanceInstalledEnvelope,\n  AppInstancePaidPlanAutoRenewalCancelledEnvelope,\n  AppInstancePaidPlanChangedEnvelope,\n  AppInstancePaidPlanPurchasedEnvelope,\n  AppInstancePlanConvertedToPaidEnvelope,\n  AppInstancePlanReactivatedEnvelope,\n  AppInstancePlanTransferredEnvelope,\n  AppInstanceRemovedEnvelope,\n  GetAppInstanceResponse,\n  getAppInstance as universalGetAppInstance,\n} from './devcenter-app-instance-v1-app-instance-app-instances.universal.js';\n\nexport const __metadata = { PACKAGE_NAME: '@wix/app-management' };\n\nexport function getAppInstance(\n  httpClient: HttpClient\n): GetAppInstanceSignature {\n  return () =>\n    universalGetAppInstance(\n      // @ts-ignore\n      { httpClient }\n    );\n}\n\ninterface GetAppInstanceSignature {\n  /**\n   * Retrieves data about the instance of your app that's installed on a Wix\n   * 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,\n   * or to check which apps made by Wix are installed on the site.\n   *\n   * You must authenticate this method [as a Wix app](https://dev.wix.com/docs/build-apps/develop-your-app/access/authentication/authenticate-using-oauth#step-2--make-an-authenticated-api-request).\n   *\n   * To retrieve `site.ownerInfo` in the response, you must\n   * have the __READ SITE OWNER EMAIL__ permission scope in addition to\n   * __MANAGE YOUR APP__.\n   */\n  (): Promise<GetAppInstanceResponse>;\n}\n\nexport const onAppInstanceInstalled = EventDefinition(\n  'AppInstalled',\n  false,\n  (event: AppInstanceInstalledEnvelope) =>\n    renameKeysFromRESTResponseToSDKResponse(event)\n)<AppInstanceInstalledEnvelope>();\nexport const onAppInstanceRemoved = EventDefinition(\n  'AppRemoved',\n  false,\n  (event: AppInstanceRemovedEnvelope) =>\n    renameKeysFromRESTResponseToSDKResponse(event)\n)<AppInstanceRemovedEnvelope>();\nexport const onAppInstancePaidPlanAutoRenewalCancelled = EventDefinition(\n  'PaidPlanAutoRenewalCancelled',\n  false,\n  (event: AppInstancePaidPlanAutoRenewalCancelledEnvelope) =>\n    renameKeysFromRESTResponseToSDKResponse(\n      transformPaths(event, [\n        {\n          transformFn: transformRESTTimestampToSDKTimestamp,\n          paths: [{ path: 'data.operationTimeStamp' }],\n        },\n      ])\n    )\n)<AppInstancePaidPlanAutoRenewalCancelledEnvelope>();\nexport const onAppInstancePaidPlanChanged = EventDefinition(\n  'PaidPlanChanged',\n  false,\n  (event: AppInstancePaidPlanChangedEnvelope) =>\n    renameKeysFromRESTResponseToSDKResponse(\n      transformPaths(event, [\n        {\n          transformFn: transformRESTTimestampToSDKTimestamp,\n          paths: [{ path: 'data.operationTimeStamp' }],\n        },\n      ])\n    )\n)<AppInstancePaidPlanChangedEnvelope>();\nexport const onAppInstancePaidPlanPurchased = EventDefinition(\n  'PaidPlanPurchased',\n  false,\n  (event: AppInstancePaidPlanPurchasedEnvelope) =>\n    renameKeysFromRESTResponseToSDKResponse(\n      transformPaths(event, [\n        {\n          transformFn: transformRESTTimestampToSDKTimestamp,\n          paths: [\n            { path: 'data.operationTimeStamp' },\n            { path: 'data.expiresOn' },\n          ],\n        },\n      ])\n    )\n)<AppInstancePaidPlanPurchasedEnvelope>();\nexport const onAppInstancePlanConvertedToPaid = EventDefinition(\n  'PlanConvertedToPaid',\n  false,\n  (event: AppInstancePlanConvertedToPaidEnvelope) =>\n    renameKeysFromRESTResponseToSDKResponse(\n      transformPaths(event, [\n        {\n          transformFn: transformRESTTimestampToSDKTimestamp,\n          paths: [\n            { path: 'data.operationTimeStamp' },\n            { path: 'data.expiresOn' },\n          ],\n        },\n      ])\n    )\n)<AppInstancePlanConvertedToPaidEnvelope>();\nexport const onAppInstancePlanReactivated = EventDefinition(\n  'PlanReactivated',\n  false,\n  (event: AppInstancePlanReactivatedEnvelope) =>\n    renameKeysFromRESTResponseToSDKResponse(\n      transformPaths(event, [\n        {\n          transformFn: transformRESTTimestampToSDKTimestamp,\n          paths: [\n            { path: 'data.operationTimeStamp' },\n            { path: 'data.expiresOn' },\n          ],\n        },\n      ])\n    )\n)<AppInstancePlanReactivatedEnvelope>();\nexport const onAppInstancePlanTransferred = EventDefinition(\n  'PlanTransferred',\n  false,\n  (event: AppInstancePlanTransferredEnvelope) =>\n    renameKeysFromRESTResponseToSDKResponse(\n      transformPaths(event, [\n        {\n          transformFn: transformRESTTimestampToSDKTimestamp,\n          paths: [{ path: 'data.operationTimeStamp' }],\n        },\n      ])\n    )\n)<AppInstancePlanTransferredEnvelope>();\n\nexport {\n  AppInstalled,\n  AppInstance,\n  AppInstanceDifference,\n  AppInstanceInstalledEnvelope,\n  AppInstancePaidPlanAutoRenewalCancelledEnvelope,\n  AppInstancePaidPlanChangedEnvelope,\n  AppInstancePaidPlanPurchasedEnvelope,\n  AppInstancePlanConvertedToPaidEnvelope,\n  AppInstancePlanReactivatedEnvelope,\n  AppInstancePlanTransferredEnvelope,\n  AppInstanceRemovedEnvelope,\n  AppRemoved,\n  AvailablePlan,\n  BaseEventMetadata,\n  BillingInfo,\n  FreeTrialInfo,\n  FreeTrialPeriod,\n  FreeTrialStatus,\n  GetAppInstanceByInstanceIdRequest,\n  GetAppInstanceRequest,\n  GetAppInstanceResponse,\n  GetComparatorFromFetchersRequest,\n  GetComparatorFromFetchersResponse,\n  IdentificationData,\n  IdentificationDataIdOneOf,\n  Locale,\n  MessageEnvelope,\n  Multilingual,\n  OwnerInfo,\n  PaidPlanAutoRenewalCancelled,\n  PaidPlanChanged,\n  PaidPlanPurchased,\n  PaymentCycle,\n  PlanConvertedToPaid,\n  PlanReactivated,\n  PlanTransferred,\n  ReactivationReason,\n  ResolutionMethod,\n  SiteInfo,\n  SupportedLanguage,\n  WebhookIdentityType,\n} from './devcenter-app-instance-v1-app-instance-app-instances.universal.js';\n","import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n  renameKeysFromSDKRequestToRESTRequest,\n  renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixDevcenterAppInstanceV1AppInstance from './devcenter-app-instance-v1-app-instance-app-instances.http.js';\n\n/**\n * An app instance is a specific occurrence of an app on a Wix site.\n * When a Wix user installs an app, a unique instance is generated for that\n * specific site. Use the `instanceId` to keep track of the individual data\n * associated with each app instance.\n */\nexport interface AppInstance {\n  /**\n   * App instance ID. Useful to keep track of the\n   * data that's associated with the specific instance of your app\n   * installed on a Wix site.\n   */\n  instanceId?: string;\n  /** App name, as you entered it in the App Dashboard. */\n  appName?: string;\n  /** Version of your app that's installed on the Wix site. */\n  appVersion?: string | null;\n  /**\n   * Whether the Wix user has installed a free or paid version of your app\n   * on their site.\n   */\n  isFree?: boolean;\n  /**\n   * Billing information for the app instance. Available only in case\n   * `{\"isFree\": false}`.\n   */\n  billing?: BillingInfo;\n  /**\n   * List of [permissions](https://dev.wix.com/docs/build-apps/developer-tools/developers-center/example-app-walkthrough/build-an-app#4-add-permissions)\n   * that the Wix user has granted your app. You set the list of permissions that\n   * your app requires from the Wix user in your app's Permissions page.\n   */\n  permissions?: string[];\n  /** Plans available to this app instance. */\n  availablePlans?: AvailablePlan[];\n  /**\n   * ID of the Wix site from which the instance of your app has been cloned.\n   * Available only when `{\"copiedFromTemplate\": true}`.\n   * All visual settings of the Wix site and app data are duplicated during the\n   * cloning process. Wix also notifies you in case there is any additional\n   * external functionality for the original site.\n   */\n  originInstanceId?: string | null;\n  /**\n   * __Deprecated__. This parameter will be removed on March 30, 2023. Use\n   * `copiedFromTemplate` instead.\n   * @deprecated\n   */\n  isOriginSiteTemplate?: boolean;\n  /** Whether this app instance was created when another Wix site was cloned. */\n  copiedFromTemplate?: boolean;\n  /** Whether this app instance includes a free trial that hasn't started yet. */\n  freeTrialAvailable?: boolean;\n}\n\nexport interface BillingInfo {\n  /** Name of the package that the site owner has paid for. */\n  packageName?: string;\n  /**\n   * Interval of the billing cycle. `ONE_TIME` indicates that the Wix user has\n   * made a single upfront payment without any automatic subscription renewal.\n   * This is primarily for usage credits (for example, 5 SMS) but may occasionally apply\n   * to a one-time setup for the app.\n   */\n  billingCycle?: PaymentCycleWithLiterals;\n  /**\n   * Date and time the Wix user purchased the app's paid plan or began their free trial. In\n   * `YYYY-MM-DDThh:mm:ss.sssZ` format.\n   */\n  timeStamp?: string;\n  /**\n   * Date and time the app's current billing cycle ends in\n   * `YYYY-MM-DDThh:mm:ss.sssZ` format. Available only for yearly and\n   * multi-yearly plans.\n   */\n  expirationDate?: string | null;\n  /**\n   * Whether the app's subscription automatically renews at the end of the\n   * current billing cycle.\n   */\n  autoRenewing?: boolean | null;\n  /** ID of the invoice for the current billing cycle. */\n  invoiceId?: string | null;\n  /**\n   * Information about any discounts applied to the app instance's current billing cycle.\n   * If the site owners applied a developer coupon or Wix Voucher\n   * when installing the paid version of your app, this field holds the coupon's\n   * name or `“Wix discount coupon”`. Site owners may receive a Wix Voucher when\n   * upgrading their Wix subscription. If there is no discount for the\n   * current billing cycle, the field is an empty string.\n   */\n  source?: string | null;\n  /** Information about the free trial applied, if relevant. */\n  freeTrialInfo?: FreeTrialInfo;\n}\n\nexport enum PaymentCycle {\n  NO_CYCLE = 'NO_CYCLE',\n  MONTHLY = 'MONTHLY',\n  YEARLY = 'YEARLY',\n  ONE_TIME = 'ONE_TIME',\n  TWO_YEARS = 'TWO_YEARS',\n  THREE_YEARS = 'THREE_YEARS',\n  FOUR_YEARS = 'FOUR_YEARS',\n  FIVE_YEARS = 'FIVE_YEARS',\n}\n\n/** @enumType */\nexport type PaymentCycleWithLiterals =\n  | PaymentCycle\n  | 'NO_CYCLE'\n  | 'MONTHLY'\n  | 'YEARLY'\n  | 'ONE_TIME'\n  | 'TWO_YEARS'\n  | 'THREE_YEARS'\n  | 'FOUR_YEARS'\n  | 'FIVE_YEARS';\n\nexport interface FreeTrialInfo {\n  /**\n   * Current free trial status.\n   * @readonly\n   */\n  status?: FreeTrialStatusWithLiterals;\n  /**\n   * When the free trial has ended. Populated only once the free trial is over.\n   * @readonly\n   */\n  endDate?: Date | null;\n}\n\nexport enum FreeTrialStatus {\n  /** Unknown trial status. */\n  UNKNOWN_STATUS = 'UNKNOWN_STATUS',\n  /** The free trial is currently in progress. */\n  IN_PROGRESS = 'IN_PROGRESS',\n  /** The free trial has ended. */\n  ENDED = 'ENDED',\n  /** No free trial was applied, as none was available. */\n  NOT_AVAILABLE = 'NOT_AVAILABLE',\n}\n\n/** @enumType */\nexport type FreeTrialStatusWithLiterals =\n  | FreeTrialStatus\n  | 'UNKNOWN_STATUS'\n  | 'IN_PROGRESS'\n  | 'ENDED'\n  | 'NOT_AVAILABLE';\n\nexport interface AvailablePlan {\n  /** Package name of the available plan. */\n  packageName?: string;\n  /** Source of the available plan. Can be a bundle or 3rd-party app. */\n  source?: string;\n}\n\nexport interface AppInstalled {\n  /**\n   * Unique identifier of the app within the website.\n   * @format GUID\n   */\n  appId?: string;\n  /**\n   * Instance ID of the app in the original website (relevant only when this site was [duplicated from another site](https://support.wix.com/en/article/duplicating-your-site-1472847)).\n   * @format GUID\n   */\n  originInstanceId?: string | null;\n}\n\nexport interface AppRemoved {\n  /**\n   * Unique identifier of the app within the website.\n   * @format GUID\n   */\n  appId?: string;\n}\n\nexport interface PaidPlanPurchased {\n  /** Date and time of purchase. */\n  operationTimeStamp?: Date | null;\n  /**\n   * Purchased app plan.\n   * @maxLength 100\n   */\n  vendorProductId?: string;\n  /** Selected payment cycle. */\n  cycle?: PaymentCycleWithLiterals;\n  /** Plan expiration date. */\n  expiresOn?: Date | null;\n  /**\n   * Coupon applied to purchase (if relevant).\n   * @maxLength 150\n   */\n  couponName?: string | null;\n  /**\n   * Invoice ID.\n   * @maxLength 50\n   */\n  invoiceId?: string | null;\n}\n\nexport interface PaidPlanChanged {\n  /** Date and time of change. */\n  operationTimeStamp?: Date | null;\n  /**\n   * Newly purchased app plan.\n   * @maxLength 100\n   */\n  vendorProductId?: string;\n  /** Newly selected payment cycle. */\n  cycle?: PaymentCycleWithLiterals;\n  /**\n   * Previous app plan.\n   * @maxLength 100\n   */\n  previousVendorProductId?: string | null;\n  /** Previous payment cycle. */\n  previousCycle?: PaymentCycleWithLiterals;\n  /**\n   * Coupon applied to purchase (if relevant).\n   * @maxLength 150\n   */\n  couponName?: string | null;\n  /**\n   * Invoice ID.\n   * @maxLength 50\n   */\n  invoiceId?: string | null;\n}\n\nexport interface PaidPlanAutoRenewalCancelled {\n  /** Date and time of auto-renewal cancellation. */\n  operationTimeStamp?: Date | null;\n  /**\n   * Current app plan.\n   * @maxLength 100\n   */\n  vendorProductId?: string;\n  /** Current payment cycle. */\n  cycle?: PaymentCycleWithLiterals;\n  /**\n   * Supported values: `UNKNOWN_CANCELLATION_TYPE_ERROR_STATE`, `USER_CANCEL`, `FAILED_PAYMENT`, `TRANSFER_CANCELLATION_REASON`. Reason provided by app for cancellation (if relevant).\n   * @maxLength 100\n   */\n  cancelReason?: string | null;\n  /**\n   * Reason provided by site owner for cancellation (if relevant).\n   * @maxLength 150\n   */\n  userReason?: string | null;\n  /**\n   * Cancellation type.\n   * @maxLength 100\n   */\n  subscriptionCancellationType?: string | null;\n  /** Whether the cancellation occurred during a free trial. */\n  cancelledDuringFreeTrial?: FreeTrialPeriodWithLiterals;\n}\n\nexport enum FreeTrialPeriod {\n  /** Free trial status unknown. */\n  FREE_TRIAL_PERIOD_UNKNOWN = 'FREE_TRIAL_PERIOD_UNKNOWN',\n  /** During a free trial period. */\n  DURING_FREE_TRIAL = 'DURING_FREE_TRIAL',\n  /** Not during a free trial period. */\n  NOT_DURING_FREE_TRIAL = 'NOT_DURING_FREE_TRIAL',\n}\n\n/** @enumType */\nexport type FreeTrialPeriodWithLiterals =\n  | FreeTrialPeriod\n  | 'FREE_TRIAL_PERIOD_UNKNOWN'\n  | 'DURING_FREE_TRIAL'\n  | 'NOT_DURING_FREE_TRIAL';\n\nexport interface PlanTransferred {\n  /** Date and time of transfer. */\n  operationTimeStamp?: Date | null;\n  /**\n   * Current app plan.\n   * @maxLength 100\n   */\n  vendorProductId?: string;\n  /** Selected payment cycle. */\n  cycle?: PaymentCycleWithLiterals;\n  /**\n   * Invoice ID.\n   * @maxLength 50\n   */\n  invoiceId?: string | null;\n}\n\nexport interface PlanReactivated {\n  /** Date and time of reactivation. */\n  operationTimeStamp?: Date | null;\n  /**\n   * Current app plan.\n   * @maxLength 100\n   */\n  vendorProductId?: string;\n  /** Selected payment cycle. */\n  cycle?: PaymentCycleWithLiterals;\n  /** Plan expiration date. */\n  expiresOn?: Date | null;\n  /**\n   * Invoice ID.\n   * @maxLength 50\n   */\n  invoiceId?: string | null;\n  /** Reason for reactivation. */\n  reason?: ReactivationReasonWithLiterals;\n}\n\nexport enum ReactivationReason {\n  /** Reactivation reason unknown. */\n  REACTIVATION_REASON_UNKNOWN = 'REACTIVATION_REASON_UNKNOWN',\n  /** The subscription's auto-renewal is turned on. */\n  AUTO_RENEW_TURNED_ON = 'AUTO_RENEW_TURNED_ON',\n}\n\n/** @enumType */\nexport type ReactivationReasonWithLiterals =\n  | ReactivationReason\n  | 'REACTIVATION_REASON_UNKNOWN'\n  | 'AUTO_RENEW_TURNED_ON';\n\nexport interface PlanConvertedToPaid {\n  /** Date and time of conversion to paid subscription (free-trial ended). */\n  operationTimeStamp?: Date | null;\n  /**\n   * Current app plan.\n   * @maxLength 100\n   */\n  vendorProductId?: string;\n  /** Selected payment cycle. */\n  cycle?: PaymentCycleWithLiterals;\n  /** Plan expiration date. */\n  expiresOn?: Date | null;\n}\n\nexport interface GetAppInstanceRequest {}\n\nexport interface GetAppInstanceResponse {\n  /** Retrieved app instance. */\n  instance?: AppInstance;\n  /** Information about the site. */\n  site?: SiteInfo;\n}\n\nexport interface SiteInfo {\n  /** Display name of the site. */\n  siteDisplayName?: string | null;\n  /**\n   * 2-letter language code of the site's locale in\n   * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n   */\n  locale?: string;\n  /**\n   * 3-letter currency code for the site's billing in\n   * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n   */\n  paymentCurrency?: string;\n  /** Information about the site's supported languages. */\n  multilingual?: Multilingual;\n  /** URL of the site. Available only when the site has been published. */\n  url?: string | null;\n  /** Description of the site. */\n  description?: string | null;\n  /** Apps made by Wix that are installed on the site. */\n  installedWixApps?: string[];\n  /**\n   * > **Deprecation Notice:** This parameter will be removed on June 30, 2022. Use `ownerInfo` instead.\n   * @format EMAIL\n   * @deprecated\n   */\n  ownerEmail?: string | null;\n  /**\n   * Information about the site's Wix user. Available only when calling\n   * _Get App Instance_ with the __Read Site Owner Email__ permission scope.\n   */\n  ownerInfo?: OwnerInfo;\n  /** Site ID. */\n  siteId?: string;\n}\n\nexport interface Multilingual {\n  /** Whether the site supports more than a single language. */\n  isMultiLingual?: boolean;\n  /** List of supported languages. Returned only when `{\"isMultiLingual\": true}`. */\n  supportedLanguages?: SupportedLanguage[];\n}\n\nexport interface SupportedLanguage {\n  /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */\n  languageCode?: string;\n  /** Locale. */\n  locale?: Locale;\n  /** Whether the supported language is the primary language for the site. */\n  isPrimary?: boolean;\n  /** Language icon. */\n  countryCode?: string;\n  /** How the language will be resolved. For internal use. */\n  resolutionMethod?: ResolutionMethodWithLiterals;\n  /** Whether the supported language is the primary language for site visitors. */\n  isVisitorPrimary?: boolean | null;\n}\n\nexport interface Locale {\n  /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */\n  languageCode?: string;\n  /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */\n  country?: string;\n}\n\nexport enum ResolutionMethod {\n  QUERY_PARAM = 'QUERY_PARAM',\n  SUBDOMAIN = 'SUBDOMAIN',\n  SUBDIRECTORY = 'SUBDIRECTORY',\n}\n\n/** @enumType */\nexport type ResolutionMethodWithLiterals =\n  | ResolutionMethod\n  | 'QUERY_PARAM'\n  | 'SUBDOMAIN'\n  | 'SUBDIRECTORY';\n\nexport interface OwnerInfo {\n  /**\n   * Wix user's email address. Identical to the their login email.\n   * @format EMAIL\n   */\n  email?: string;\n  /**\n   * Supported values: `VERIFIED_OPT_IN`, `VERIFIED_OPT_OUT`,\n   * `NOT_VERIFIED_OPT_IN`, `NOT_VERIFIED_OPT_OUT`.\n   *\n   * Whether the Wix user has verified their email and whether they have chosen\n   * to receive email notifications from Wix.\n   */\n  emailStatus?: string;\n}\n\nexport interface GetComparatorFromFetchersRequest {}\n\nexport interface GetComparatorFromFetchersResponse {\n  /**\n   * List of differences between the app instance and the migrated app instance\n   * @maxSize 50\n   */\n  differences?: AppInstanceDifference[];\n}\n\nexport interface AppInstanceDifference {\n  /**\n   * The field that has a difference between the app instance and the migrated app instance.\n   * @maxLength 100\n   */\n  field?: string;\n  /**\n   * The value of the field in the app instance.\n   * @maxLength 100\n   */\n  fetchFrom?: string;\n  /**\n   * The value of the field in the migrated app instance.\n   * @maxLength 100\n   */\n  fetchFromV2?: string;\n}\n\nexport interface GetAppInstanceByInstanceIdRequest {\n  /**\n   * ID of the app instance to retrieve.\n   * @format GUID\n   */\n  instanceId?: string;\n}\n\nexport interface MessageEnvelope {\n  /**\n   * App instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n  /**\n   * Event type.\n   * @maxLength 150\n   */\n  eventType?: string;\n  /** The identification type and identity data. */\n  identity?: IdentificationData;\n  /** Stringify payload. */\n  data?: string;\n}\n\nexport interface IdentificationData extends IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n  /** @readonly */\n  identityType?: WebhookIdentityTypeWithLiterals;\n}\n\n/** @oneof */\nexport interface IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n}\n\nexport enum WebhookIdentityType {\n  UNKNOWN = 'UNKNOWN',\n  ANONYMOUS_VISITOR = 'ANONYMOUS_VISITOR',\n  MEMBER = 'MEMBER',\n  WIX_USER = 'WIX_USER',\n  APP = 'APP',\n}\n\n/** @enumType */\nexport type WebhookIdentityTypeWithLiterals =\n  | WebhookIdentityType\n  | 'UNKNOWN'\n  | 'ANONYMOUS_VISITOR'\n  | 'MEMBER'\n  | 'WIX_USER'\n  | 'APP';\n\nexport interface BaseEventMetadata {\n  /**\n   * App instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n  /**\n   * Event type.\n   * @maxLength 150\n   */\n  eventType?: string;\n  /** The identification type and identity data. */\n  identity?: IdentificationData;\n}\n\nexport interface AppInstanceInstalledEnvelope {\n  data: AppInstalled;\n  metadata: BaseEventMetadata;\n}\n\n/**\n * Triggered when an instance of your app is installed on a Wix site.\n * @permissionScope Manage Your App\n * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP\n * @permissionScope Read site, business, and email details\n * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO\n * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE\n * @webhook\n * @eventType AppInstalled\n * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService\n * @slug installed\n */\nexport declare function onAppInstanceInstalled(\n  handler: (event: AppInstanceInstalledEnvelope) => void | Promise<void>\n): void;\n\nexport interface AppInstanceRemovedEnvelope {\n  data: AppRemoved;\n  metadata: BaseEventMetadata;\n}\n\n/**\n * Triggered when an instance of your app is uninstalled from a Wix site.\n * @permissionScope Manage Your App\n * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP\n * @permissionScope Read site, business, and email details\n * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO\n * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE\n * @webhook\n * @eventType AppRemoved\n * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService\n * @slug removed\n */\nexport declare function onAppInstanceRemoved(\n  handler: (event: AppInstanceRemovedEnvelope) => void | Promise<void>\n): void;\n\nexport interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {\n  data: PaidPlanAutoRenewalCancelled;\n  metadata: BaseEventMetadata;\n}\n\n/**\n * Triggered when a Wix user either cancels a paid plan for your app, or cancels the plan's auto-renewal. The\n * Wix user can continue to use your app until the end of the current billing\n * cycle.\n * @permissionScope Manage Your App\n * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP\n * @permissionScope Read site, business, and email details\n * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO\n * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE\n * @webhook\n * @eventType PaidPlanAutoRenewalCancelled\n * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService\n * @slug paid_plan_auto_renewal_cancelled\n */\nexport declare function onAppInstancePaidPlanAutoRenewalCancelled(\n  handler: (\n    event: AppInstancePaidPlanAutoRenewalCancelledEnvelope\n  ) => void | Promise<void>\n): void;\n\nexport interface AppInstancePaidPlanChangedEnvelope {\n  data: PaidPlanChanged;\n  metadata: BaseEventMetadata;\n}\n\n/**\n * Triggered when a Wix user upgrades or downgrades their plan for your app.\n * @permissionScope Manage Your App\n * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP\n * @permissionScope Read site, business, and email details\n * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO\n * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE\n * @webhook\n * @eventType PaidPlanChanged\n * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService\n * @slug paid_plan_changed\n */\nexport declare function onAppInstancePaidPlanChanged(\n  handler: (event: AppInstancePaidPlanChangedEnvelope) => void | Promise<void>\n): void;\n\nexport interface AppInstancePaidPlanPurchasedEnvelope {\n  data: PaidPlanPurchased;\n  metadata: BaseEventMetadata;\n}\n\n/**\n * Triggered when a Wix user purchases a paid plan for your app.\n * @permissionScope Manage Your App\n * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP\n * @permissionScope Read site, business, and email details\n * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO\n * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE\n * @webhook\n * @eventType PaidPlanPurchased\n * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService\n * @slug paid_plan_purchased\n */\nexport declare function onAppInstancePaidPlanPurchased(\n  handler: (event: AppInstancePaidPlanPurchasedEnvelope) => void | Promise<void>\n): void;\n\nexport interface AppInstancePlanConvertedToPaidEnvelope {\n  data: PlanConvertedToPaid;\n  metadata: BaseEventMetadata;\n}\n\n/**\n * Triggered when a Wix user reaches the end of a free-trial period and is charged successfully.\n * @permissionScope Manage Your App\n * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP\n * @permissionScope Read site, business, and email details\n * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO\n * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE\n * @webhook\n * @eventType PlanConvertedToPaid\n * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService\n * @slug plan_converted_to_paid\n * @documentationMaturity preview\n */\nexport declare function onAppInstancePlanConvertedToPaid(\n  handler: (\n    event: AppInstancePlanConvertedToPaidEnvelope\n  ) => void | Promise<void>\n): void;\n\nexport interface AppInstancePlanReactivatedEnvelope {\n  data: PlanReactivated;\n  metadata: BaseEventMetadata;\n}\n\n/**\n * Triggered when auto-renewal is turned on for a paid plan.\n * @permissionScope Manage Your App\n * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP\n * @permissionScope Read site, business, and email details\n * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO\n * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE\n * @webhook\n * @eventType PlanReactivated\n * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService\n * @slug plan_reactivated\n * @documentationMaturity preview\n */\nexport declare function onAppInstancePlanReactivated(\n  handler: (event: AppInstancePlanReactivatedEnvelope) => void | Promise<void>\n): void;\n\nexport interface AppInstancePlanTransferredEnvelope {\n  data: PlanTransferred;\n  metadata: BaseEventMetadata;\n}\n\n/**\n * Triggered when a paid plan for your app is transferred to a different Wix account.\n * @permissionScope Manage Your App\n * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP\n * @permissionScope Read site, business, and email details\n * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO\n * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE\n * @webhook\n * @eventType PlanTransferred\n * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService\n * @slug plan_transferred\n * @documentationMaturity preview\n */\nexport declare function onAppInstancePlanTransferred(\n  handler: (event: AppInstancePlanTransferredEnvelope) => void | Promise<void>\n): void;\n\ntype AppInstanceNonNullablePaths =\n  | `instanceId`\n  | `appName`\n  | `isFree`\n  | `billing.packageName`\n  | `billing.billingCycle`\n  | `billing.timeStamp`\n  | `billing.freeTrialInfo.status`\n  | `permissions`\n  | `availablePlans`\n  | `availablePlans.${number}.packageName`\n  | `availablePlans.${number}.source`\n  | `isOriginSiteTemplate`\n  | `copiedFromTemplate`\n  | `freeTrialAvailable`;\n\n/**\n * Retrieves data about the instance of your app that's installed on a Wix\n * 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,\n * or to check which apps made by Wix are installed on the site.\n *\n * You must authenticate this method [as a Wix app](https://dev.wix.com/docs/build-apps/develop-your-app/access/authentication/authenticate-using-oauth#step-2--make-an-authenticated-api-request).\n *\n * To retrieve `site.ownerInfo` in the response, you must\n * have the __READ SITE OWNER EMAIL__ permission scope in addition to\n * __MANAGE YOUR APP__.\n * @public\n * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE\n * @applicableIdentity APP\n * @fqn com.wixpress.market.aim.api.AppInstanceService.GetAppInstance\n */\nexport async function getAppInstance(): Promise<\n  NonNullablePaths<\n    GetAppInstanceResponse,\n    | {\n        [P in AppInstanceNonNullablePaths]: `instance.${P}`;\n      }[AppInstanceNonNullablePaths]\n    | `site.locale`\n    | `site.paymentCurrency`\n    | `site.multilingual.isMultiLingual`\n    | `site.multilingual.supportedLanguages`\n    | `site.multilingual.supportedLanguages.${number}.languageCode`\n    | `site.multilingual.supportedLanguages.${number}.locale.languageCode`\n    | `site.multilingual.supportedLanguages.${number}.locale.country`\n    | `site.multilingual.supportedLanguages.${number}.isPrimary`\n    | `site.multilingual.supportedLanguages.${number}.countryCode`\n    | `site.multilingual.supportedLanguages.${number}.resolutionMethod`\n    | `site.installedWixApps`\n    | `site.ownerInfo.email`\n    | `site.ownerInfo.emailStatus`\n    | `site.siteId`\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[0] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({});\n\n  const reqOpts =\n    ambassadorWixDevcenterAppInstanceV1AppInstance.getAppInstance(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: {},\n        singleArgumentUnchanged: false,\n      },\n      []\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveComWixpressMarketAimApiAppInstanceServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'api._api_base_domain_': [\n      {\n        srcPath: '/app-instance-manager-webapp',\n        destPath: '',\n      },\n    ],\n    'www.wixapis.com': [\n      {\n        srcPath: '/apps',\n        destPath: '',\n      },\n    ],\n    'wixapis.com': [\n      {\n        srcPath: '/apps',\n        destPath: '',\n      },\n    ],\n    'dev._base_domain_': [\n      {\n        srcPath: '/_api/app-instance-manager',\n        destPath: '',\n      },\n      {\n        srcPath: '/api/v1/instance',\n        destPath: '/v1/instance',\n      },\n      {\n        srcPath: '/api/v1/scripts',\n        destPath: '/v1/scripts',\n      },\n    ],\n    'manage._base_domain_': [\n      {\n        srcPath: '/_api/app-instance-manager',\n        destPath: '',\n      },\n    ],\n    'www._base_domain_': [\n      {\n        srcPath: '/_api/app-instance-manager',\n        destPath: '',\n      },\n    ],\n    'editor._base_domain_': [\n      {\n        srcPath: '/_api/app-instance-manager',\n        destPath: '',\n      },\n    ],\n    'blocks._base_domain_': [\n      {\n        srcPath: '/_api/app-instance-manager',\n        destPath: '',\n      },\n    ],\n    'create.editorx': [\n      {\n        srcPath: '/_api/app-instance-manager',\n        destPath: '',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_app-management_app-instances';\n\n/**\n * Retrieves data about the instance of your app that's installed on a Wix\n * 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,\n * or to check which apps made by Wix are installed on the site.\n *\n * You must authenticate this method [as a Wix app](https://dev.wix.com/docs/build-apps/develop-your-app/access/authentication/authenticate-using-oauth#step-2--make-an-authenticated-api-request).\n *\n * To retrieve `site.ownerInfo` in the response, you must\n * have the __READ SITE OWNER EMAIL__ permission scope in addition to\n * __MANAGE YOUR APP__.\n */\nexport function getAppInstance(payload: object): RequestOptionsFactory<any> {\n  function __getAppInstance({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.devcenter.app_instance.v1.app_instance',\n      method: 'GET' as any,\n      methodFqn:\n        'com.wixpress.market.aim.api.AppInstanceService.GetAppInstance',\n      packageName: PACKAGE_NAME,\n      url: resolveComWixpressMarketAimApiAppInstanceServiceUrl({\n        protoPath: '/v1/instance',\n        data: payload,\n        host,\n      }),\n      params: toURLSearchParams(payload),\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'instance.billing.freeTrialInfo.endDate' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __getAppInstance;\n}\n","import { getAppInstance as publicGetAppInstance } from './devcenter-app-instance-v1-app-instance-app-instances.public.js';\nimport { createRESTModule } from '@wix/sdk-runtime/rest-modules';\nimport { createEventModule } from '@wix/sdk-runtime/event-definition-modules';\nimport {\n  BuildRESTFunction,\n  MaybeContext,\n  BuildEventDefinition,\n} from '@wix/sdk-types';\nimport { onAppInstanceInstalled as publicOnAppInstanceInstalled } from './devcenter-app-instance-v1-app-instance-app-instances.public.js';\nimport { onAppInstanceRemoved as publicOnAppInstanceRemoved } from './devcenter-app-instance-v1-app-instance-app-instances.public.js';\nimport { onAppInstancePaidPlanAutoRenewalCancelled as publicOnAppInstancePaidPlanAutoRenewalCancelled } from './devcenter-app-instance-v1-app-instance-app-instances.public.js';\nimport { onAppInstancePaidPlanChanged as publicOnAppInstancePaidPlanChanged } from './devcenter-app-instance-v1-app-instance-app-instances.public.js';\nimport { onAppInstancePaidPlanPurchased as publicOnAppInstancePaidPlanPurchased } from './devcenter-app-instance-v1-app-instance-app-instances.public.js';\nimport { onAppInstancePlanConvertedToPaid as publicOnAppInstancePlanConvertedToPaid } from './devcenter-app-instance-v1-app-instance-app-instances.public.js';\nimport { onAppInstancePlanReactivated as publicOnAppInstancePlanReactivated } from './devcenter-app-instance-v1-app-instance-app-instances.public.js';\nimport { onAppInstancePlanTransferred as publicOnAppInstancePlanTransferred } from './devcenter-app-instance-v1-app-instance-app-instances.public.js';\n\nexport const getAppInstance: MaybeContext<\n  BuildRESTFunction<typeof publicGetAppInstance> & typeof publicGetAppInstance\n> = /*#__PURE__*/ createRESTModule(publicGetAppInstance);\n/**\n * Triggered when an instance of your app is installed on a Wix site.\n */\nexport const onAppInstanceInstalled: BuildEventDefinition<\n  typeof publicOnAppInstanceInstalled\n> = createEventModule(publicOnAppInstanceInstalled);\n/**\n * Triggered when an instance of your app is uninstalled from a Wix site.\n */\nexport const onAppInstanceRemoved: BuildEventDefinition<\n  typeof publicOnAppInstanceRemoved\n> = createEventModule(publicOnAppInstanceRemoved);\n/**\n * Triggered when a Wix user either cancels a paid plan for your app, or cancels the plan's auto-renewal. The\n * Wix user can continue to use your app until the end of the current billing\n * cycle.\n */\nexport const onAppInstancePaidPlanAutoRenewalCancelled: BuildEventDefinition<\n  typeof publicOnAppInstancePaidPlanAutoRenewalCancelled\n> = createEventModule(publicOnAppInstancePaidPlanAutoRenewalCancelled);\n/**\n * Triggered when a Wix user upgrades or downgrades their plan for your app.\n */\nexport const onAppInstancePaidPlanChanged: BuildEventDefinition<\n  typeof publicOnAppInstancePaidPlanChanged\n> = createEventModule(publicOnAppInstancePaidPlanChanged);\n/**\n * Triggered when a Wix user purchases a paid plan for your app.\n */\nexport const onAppInstancePaidPlanPurchased: BuildEventDefinition<\n  typeof publicOnAppInstancePaidPlanPurchased\n> = createEventModule(publicOnAppInstancePaidPlanPurchased);\n/**\n * Triggered when a Wix user reaches the end of a free-trial period and is charged successfully.\n */\nexport const onAppInstancePlanConvertedToPaid: BuildEventDefinition<\n  typeof publicOnAppInstancePlanConvertedToPaid\n> = createEventModule(publicOnAppInstancePlanConvertedToPaid);\n/**\n * Triggered when auto-renewal is turned on for a paid plan.\n */\nexport const onAppInstancePlanReactivated: BuildEventDefinition<\n  typeof publicOnAppInstancePlanReactivated\n> = createEventModule(publicOnAppInstancePlanReactivated);\n/**\n * Triggered when a paid plan for your app is transferred to a different Wix account.\n */\nexport const onAppInstancePlanTransferred: BuildEventDefinition<\n  typeof publicOnAppInstancePlanTransferred\n> = createEventModule(publicOnAppInstancePlanTransferred);\n\nexport {\n  PaymentCycle,\n  FreeTrialStatus,\n  FreeTrialPeriod,\n  ReactivationReason,\n  ResolutionMethod,\n  WebhookIdentityType,\n} from './devcenter-app-instance-v1-app-instance-app-instances.universal.js';\nexport {\n  AppInstance,\n  BillingInfo,\n  FreeTrialInfo,\n  AvailablePlan,\n  AppInstalled,\n  AppRemoved,\n  PaidPlanPurchased,\n  PaidPlanChanged,\n  PaidPlanAutoRenewalCancelled,\n  PlanTransferred,\n  PlanReactivated,\n  PlanConvertedToPaid,\n  GetAppInstanceRequest,\n  GetAppInstanceResponse,\n  SiteInfo,\n  Multilingual,\n  SupportedLanguage,\n  Locale,\n  OwnerInfo,\n  GetComparatorFromFetchersRequest,\n  GetComparatorFromFetchersResponse,\n  AppInstanceDifference,\n  GetAppInstanceByInstanceIdRequest,\n  MessageEnvelope,\n  IdentificationData,\n  IdentificationDataIdOneOf,\n  BaseEventMetadata,\n  AppInstanceInstalledEnvelope,\n  AppInstanceRemovedEnvelope,\n  AppInstancePaidPlanAutoRenewalCancelledEnvelope,\n  AppInstancePaidPlanChangedEnvelope,\n  AppInstancePaidPlanPurchasedEnvelope,\n  AppInstancePlanConvertedToPaidEnvelope,\n  AppInstancePlanReactivatedEnvelope,\n  AppInstancePlanTransferredEnvelope,\n} from './devcenter-app-instance-v1-app-instance-app-instances.universal.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAAAA;AAAA,EAAA,8BAAAC;AAAA,EAAA,iDAAAC;AAAA,EAAA,oCAAAC;AAAA,EAAA,sCAAAC;AAAA,EAAA,wCAAAC;AAAA,EAAA,oCAAAC;AAAA,EAAA,oCAAAC;AAAA,EAAA,4BAAAC;AAAA;AAAA;;;ACAA,IAAAC,iCAAwD;AACxD,IAAAC,oBAAqD;AACrD,IAAAC,0BAA+B;AAC/B,uBAA4C;;;ACH5C,6BAAoD;AACpD,oCAGO;;;ACJP,0BAAkC;AAClC,uBAAqD;AACrD,6BAA+B;AAC/B,IAAAC,uBAA2B;AAI3B,SAAS,oDACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,yBAAyB;AAAA,MACvB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,eAAe;AAAA,MACb;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,qBAAqB;AAAA,MACnB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,qBAAqB;AAAA,MACnB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,kBAAkB;AAAA,MAChB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,iCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAad,SAAS,eAAe,SAA6C;AAC1E,WAAS,iBAAiB,EAAE,KAAK,GAAQ;AACvC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,KAAK,oDAAoD;AAAA,QACvD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,YAAQ,uCAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACC,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,yCAAyC,CAAC;AAAA,QAC5D;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADdO,IAAK,eAAL,kBAAKC,kBAAL;AACL,EAAAA,cAAA,cAAW;AACX,EAAAA,cAAA,aAAU;AACV,EAAAA,cAAA,YAAS;AACT,EAAAA,cAAA,cAAW;AACX,EAAAA,cAAA,eAAY;AACZ,EAAAA,cAAA,iBAAc;AACd,EAAAA,cAAA,gBAAa;AACb,EAAAA,cAAA,gBAAa;AARH,SAAAA;AAAA,GAAA;AAoCL,IAAK,kBAAL,kBAAKC,qBAAL;AAEL,EAAAA,iBAAA,oBAAiB;AAEjB,EAAAA,iBAAA,iBAAc;AAEd,EAAAA,iBAAA,WAAQ;AAER,EAAAA,iBAAA,mBAAgB;AARN,SAAAA;AAAA,GAAA;AAiIL,IAAK,kBAAL,kBAAKC,qBAAL;AAEL,EAAAA,iBAAA,+BAA4B;AAE5B,EAAAA,iBAAA,uBAAoB;AAEpB,EAAAA,iBAAA,2BAAwB;AANd,SAAAA;AAAA,GAAA;AAsDL,IAAK,qBAAL,kBAAKC,wBAAL;AAEL,EAAAA,oBAAA,iCAA8B;AAE9B,EAAAA,oBAAA,0BAAuB;AAJb,SAAAA;AAAA,GAAA;AAqGL,IAAK,mBAAL,kBAAKC,sBAAL;AACL,EAAAA,kBAAA,iBAAc;AACd,EAAAA,kBAAA,eAAY;AACZ,EAAAA,kBAAA,kBAAe;AAHL,SAAAA;AAAA,GAAA;AAmIL,IAAK,sBAAL,kBAAKC,yBAAL;AACL,EAAAA,qBAAA,aAAU;AACV,EAAAA,qBAAA,uBAAoB;AACpB,EAAAA,qBAAA,YAAS;AACT,EAAAA,qBAAA,cAAW;AACX,EAAAA,qBAAA,SAAM;AALI,SAAAA;AAAA,GAAA;AAgPZ,eAAsBC,kBAqBpB;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC,CAAC,CAAC;AAExD,QAAM,UAC2C,eAAe,OAAO;AAEvE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAC;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,CAAC;AAAA,QAC3B,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC;AAAA,IACH;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;;;AD7zBO,SAASC,gBACd,YACyB;AACzB,SAAO,MACLA;AAAA;AAAA,IAEE,EAAE,WAAW;AAAA,EACf;AACJ;AAiBO,IAAM,6BAAyB;AAAA,EACpC;AAAA,EACA;AAAA,EACA,CAAC,cACC,wEAAwC,KAAK;AACjD,EAAgC;AACzB,IAAM,2BAAuB;AAAA,EAClC;AAAA,EACA;AAAA,EACA,CAAC,cACC,wEAAwC,KAAK;AACjD,EAA8B;AACvB,IAAM,gDAA4C;AAAA,EACvD;AAAA,EACA;AAAA,EACA,CAAC,cACC;AAAA,QACE,wCAAe,OAAO;AAAA,MACpB;AAAA,QACE,aAAa;AAAA,QACb,OAAO,CAAC,EAAE,MAAM,0BAA0B,CAAC;AAAA,MAC7C;AAAA,IACF,CAAC;AAAA,EACH;AACJ,EAAmD;AAC5C,IAAM,mCAA+B;AAAA,EAC1C;AAAA,EACA;AAAA,EACA,CAAC,cACC;AAAA,QACE,wCAAe,OAAO;AAAA,MACpB;AAAA,QACE,aAAa;AAAA,QACb,OAAO,CAAC,EAAE,MAAM,0BAA0B,CAAC;AAAA,MAC7C;AAAA,IACF,CAAC;AAAA,EACH;AACJ,EAAsC;AAC/B,IAAM,qCAAiC;AAAA,EAC5C;AAAA,EACA;AAAA,EACA,CAAC,cACC;AAAA,QACE,wCAAe,OAAO;AAAA,MACpB;AAAA,QACE,aAAa;AAAA,QACb,OAAO;AAAA,UACL,EAAE,MAAM,0BAA0B;AAAA,UAClC,EAAE,MAAM,iBAAiB;AAAA,QAC3B;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AACJ,EAAwC;AACjC,IAAM,uCAAmC;AAAA,EAC9C;AAAA,EACA;AAAA,EACA,CAAC,cACC;AAAA,QACE,wCAAe,OAAO;AAAA,MACpB;AAAA,QACE,aAAa;AAAA,QACb,OAAO;AAAA,UACL,EAAE,MAAM,0BAA0B;AAAA,UAClC,EAAE,MAAM,iBAAiB;AAAA,QAC3B;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AACJ,EAA0C;AACnC,IAAM,mCAA+B;AAAA,EAC1C;AAAA,EACA;AAAA,EACA,CAAC,cACC;AAAA,QACE,wCAAe,OAAO;AAAA,MACpB;AAAA,QACE,aAAa;AAAA,QACb,OAAO;AAAA,UACL,EAAE,MAAM,0BAA0B;AAAA,UAClC,EAAE,MAAM,iBAAiB;AAAA,QAC3B;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AACJ,EAAsC;AAC/B,IAAM,mCAA+B;AAAA,EAC1C;AAAA,EACA;AAAA,EACA,CAAC,cACC;AAAA,QACE,wCAAe,OAAO;AAAA,MACpB;AAAA,QACE,aAAa;AAAA,QACb,OAAO,CAAC,EAAE,MAAM,0BAA0B,CAAC;AAAA,MAC7C;AAAA,IACF,CAAC;AAAA,EACH;AACJ,EAAsC;;;AG7ItC,IAAAC,uBAAiC;AACjC,sCAAkC;AAe3B,IAAMC,kBAEK,2DAAiBA,eAAoB;AAIhD,IAAMC,8BAET,mDAAkB,sBAA4B;AAI3C,IAAMC,4BAET,mDAAkB,oBAA0B;AAMzC,IAAMC,iDAET,mDAAkB,yCAA+C;AAI9D,IAAMC,oCAET,mDAAkB,4BAAkC;AAIjD,IAAMC,sCAET,mDAAkB,8BAAoC;AAInD,IAAMC,wCAET,mDAAkB,gCAAsC;AAIrD,IAAMC,oCAET,mDAAkB,4BAAkC;AAIjD,IAAMC,oCAET,mDAAkB,4BAAkC;","names":["getAppInstance","onAppInstanceInstalled","onAppInstancePaidPlanAutoRenewalCancelled","onAppInstancePaidPlanChanged","onAppInstancePaidPlanPurchased","onAppInstancePlanConvertedToPaid","onAppInstancePlanReactivated","onAppInstancePlanTransferred","onAppInstanceRemoved","import_rename_all_nested_keys","import_timestamp","import_transform_paths","import_rest_modules","payload","PaymentCycle","FreeTrialStatus","FreeTrialPeriod","ReactivationReason","ResolutionMethod","WebhookIdentityType","getAppInstance","sdkTransformError","getAppInstance","import_rest_modules","getAppInstance","onAppInstanceInstalled","onAppInstanceRemoved","onAppInstancePaidPlanAutoRenewalCancelled","onAppInstancePaidPlanChanged","onAppInstancePaidPlanPurchased","onAppInstancePlanConvertedToPaid","onAppInstancePlanReactivated","onAppInstancePlanTransferred"]}
+{"version":3,"sources":["../../index.ts","../../src/devcenter-app-instance-v1-app-instance-app-instances.public.ts","../../src/devcenter-app-instance-v1-app-instance-app-instances.universal.ts","../../src/devcenter-app-instance-v1-app-instance-app-instances.http.ts","../../src/devcenter-app-instance-v1-app-instance-app-instances.context.ts"],"sourcesContent":["export * from './src/devcenter-app-instance-v1-app-instance-app-instances.context.js';\n","import { renameKeysFromRESTResponseToSDKResponse } from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { EventDefinition, HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport {\n  AppInstanceInstalledEnvelope,\n  AppInstancePaidPlanAutoRenewalCancelledEnvelope,\n  AppInstancePaidPlanChangedEnvelope,\n  AppInstancePaidPlanPurchasedEnvelope,\n  AppInstancePlanConvertedToPaidEnvelope,\n  AppInstancePlanReactivatedEnvelope,\n  AppInstancePlanTransferredEnvelope,\n  AppInstanceRemovedEnvelope,\n  GetAppInstanceResponse,\n  getAppInstance as universalGetAppInstance,\n} from './devcenter-app-instance-v1-app-instance-app-instances.universal.js';\n\nexport const __metadata = { PACKAGE_NAME: '@wix/app-management' };\n\ntype AppInstanceNonNullablePaths =\n  | `instanceId`\n  | `appName`\n  | `isFree`\n  | `billing.packageName`\n  | `billing.billingCycle`\n  | `billing.timeStamp`\n  | `billing.freeTrialInfo.status`\n  | `permissions`\n  | `availablePlans`\n  | `availablePlans.${number}.packageName`\n  | `availablePlans.${number}.source`\n  | `isOriginSiteTemplate`\n  | `copiedFromTemplate`\n  | `freeTrialAvailable`;\n\nexport function getAppInstance(\n  httpClient: HttpClient\n): GetAppInstanceSignature {\n  return () =>\n    universalGetAppInstance(\n      // @ts-ignore\n      { httpClient }\n    );\n}\n\ninterface GetAppInstanceSignature {\n  /**\n   * Retrieves data about the instance of your app that's installed on a Wix\n   * 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,\n   * or to check which apps made by Wix are installed on the site.\n   *\n   * You must authenticate this method [as a Wix app](https://dev.wix.com/docs/build-apps/develop-your-app/access/authentication/authenticate-using-oauth#step-2--make-an-authenticated-api-request).\n   *\n   * To retrieve `site.ownerInfo` in the response, you must\n   * have the __READ SITE OWNER EMAIL__ permission scope in addition to\n   * __MANAGE YOUR APP__.\n   */\n  (): Promise<\n    NonNullablePaths<\n      GetAppInstanceResponse,\n      | {\n          [P in AppInstanceNonNullablePaths]: `instance.${P}`;\n        }[AppInstanceNonNullablePaths]\n      | `site.locale`\n      | `site.paymentCurrency`\n      | `site.multilingual.isMultiLingual`\n      | `site.multilingual.supportedLanguages`\n      | `site.multilingual.supportedLanguages.${number}.languageCode`\n      | `site.multilingual.supportedLanguages.${number}.locale.languageCode`\n      | `site.multilingual.supportedLanguages.${number}.locale.country`\n      | `site.multilingual.supportedLanguages.${number}.isPrimary`\n      | `site.multilingual.supportedLanguages.${number}.countryCode`\n      | `site.multilingual.supportedLanguages.${number}.resolutionMethod`\n      | `site.installedWixApps`\n      | `site.ownerInfo.email`\n      | `site.ownerInfo.emailStatus`\n      | `site.siteId`\n    >\n  >;\n}\n\nexport const onAppInstanceInstalled = EventDefinition(\n  'AppInstalled',\n  false,\n  (event: AppInstanceInstalledEnvelope) =>\n    renameKeysFromRESTResponseToSDKResponse(event)\n)<AppInstanceInstalledEnvelope>();\nexport const onAppInstanceRemoved = EventDefinition(\n  'AppRemoved',\n  false,\n  (event: AppInstanceRemovedEnvelope) =>\n    renameKeysFromRESTResponseToSDKResponse(event)\n)<AppInstanceRemovedEnvelope>();\nexport const onAppInstancePaidPlanAutoRenewalCancelled = EventDefinition(\n  'PaidPlanAutoRenewalCancelled',\n  false,\n  (event: AppInstancePaidPlanAutoRenewalCancelledEnvelope) =>\n    renameKeysFromRESTResponseToSDKResponse(\n      transformPaths(event, [\n        {\n          transformFn: transformRESTTimestampToSDKTimestamp,\n          paths: [{ path: 'data.operationTimeStamp' }],\n        },\n      ])\n    )\n)<AppInstancePaidPlanAutoRenewalCancelledEnvelope>();\nexport const onAppInstancePaidPlanChanged = EventDefinition(\n  'PaidPlanChanged',\n  false,\n  (event: AppInstancePaidPlanChangedEnvelope) =>\n    renameKeysFromRESTResponseToSDKResponse(\n      transformPaths(event, [\n        {\n          transformFn: transformRESTTimestampToSDKTimestamp,\n          paths: [{ path: 'data.operationTimeStamp' }],\n        },\n      ])\n    )\n)<AppInstancePaidPlanChangedEnvelope>();\nexport const onAppInstancePaidPlanPurchased = EventDefinition(\n  'PaidPlanPurchased',\n  false,\n  (event: AppInstancePaidPlanPurchasedEnvelope) =>\n    renameKeysFromRESTResponseToSDKResponse(\n      transformPaths(event, [\n        {\n          transformFn: transformRESTTimestampToSDKTimestamp,\n          paths: [\n            { path: 'data.operationTimeStamp' },\n            { path: 'data.expiresOn' },\n          ],\n        },\n      ])\n    )\n)<AppInstancePaidPlanPurchasedEnvelope>();\nexport const onAppInstancePlanConvertedToPaid = EventDefinition(\n  'PlanConvertedToPaid',\n  false,\n  (event: AppInstancePlanConvertedToPaidEnvelope) =>\n    renameKeysFromRESTResponseToSDKResponse(\n      transformPaths(event, [\n        {\n          transformFn: transformRESTTimestampToSDKTimestamp,\n          paths: [\n            { path: 'data.operationTimeStamp' },\n            { path: 'data.expiresOn' },\n          ],\n        },\n      ])\n    )\n)<AppInstancePlanConvertedToPaidEnvelope>();\nexport const onAppInstancePlanReactivated = EventDefinition(\n  'PlanReactivated',\n  false,\n  (event: AppInstancePlanReactivatedEnvelope) =>\n    renameKeysFromRESTResponseToSDKResponse(\n      transformPaths(event, [\n        {\n          transformFn: transformRESTTimestampToSDKTimestamp,\n          paths: [\n            { path: 'data.operationTimeStamp' },\n            { path: 'data.expiresOn' },\n          ],\n        },\n      ])\n    )\n)<AppInstancePlanReactivatedEnvelope>();\nexport const onAppInstancePlanTransferred = EventDefinition(\n  'PlanTransferred',\n  false,\n  (event: AppInstancePlanTransferredEnvelope) =>\n    renameKeysFromRESTResponseToSDKResponse(\n      transformPaths(event, [\n        {\n          transformFn: transformRESTTimestampToSDKTimestamp,\n          paths: [{ path: 'data.operationTimeStamp' }],\n        },\n      ])\n    )\n)<AppInstancePlanTransferredEnvelope>();\n\nexport {\n  AppInstalled,\n  AppInstance,\n  AppInstanceDifference,\n  AppInstanceInstalledEnvelope,\n  AppInstancePaidPlanAutoRenewalCancelledEnvelope,\n  AppInstancePaidPlanChangedEnvelope,\n  AppInstancePaidPlanPurchasedEnvelope,\n  AppInstancePlanConvertedToPaidEnvelope,\n  AppInstancePlanReactivatedEnvelope,\n  AppInstancePlanTransferredEnvelope,\n  AppInstanceRemovedEnvelope,\n  AppRemoved,\n  AvailablePlan,\n  BaseEventMetadata,\n  BillingInfo,\n  FreeTrialInfo,\n  FreeTrialPeriod,\n  FreeTrialStatus,\n  GetAppInstanceByInstanceIdRequest,\n  GetAppInstanceRequest,\n  GetAppInstanceResponse,\n  GetComparatorFromFetchersRequest,\n  GetComparatorFromFetchersResponse,\n  IdentificationData,\n  IdentificationDataIdOneOf,\n  Locale,\n  MessageEnvelope,\n  Multilingual,\n  OwnerInfo,\n  PaidPlanAutoRenewalCancelled,\n  PaidPlanChanged,\n  PaidPlanPurchased,\n  PaymentCycle,\n  PlanConvertedToPaid,\n  PlanReactivated,\n  PlanTransferred,\n  ReactivationReason,\n  ResolutionMethod,\n  SiteInfo,\n  SupportedLanguage,\n  WebhookIdentityType,\n} from './devcenter-app-instance-v1-app-instance-app-instances.universal.js';\n","import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n  renameKeysFromSDKRequestToRESTRequest,\n  renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixDevcenterAppInstanceV1AppInstance from './devcenter-app-instance-v1-app-instance-app-instances.http.js';\n\n/**\n * An app instance is a specific occurrence of an app on a Wix site.\n * When a Wix user installs an app, a unique instance is generated for that\n * specific site. Use the `instanceId` to keep track of the individual data\n * associated with each app instance.\n */\nexport interface AppInstance {\n  /**\n   * App instance ID. Useful to keep track of the\n   * data that's associated with the specific instance of your app\n   * installed on a Wix site.\n   */\n  instanceId?: string;\n  /** App name, as you entered it in the App Dashboard. */\n  appName?: string;\n  /** Version of your app that's installed on the Wix site. */\n  appVersion?: string | null;\n  /**\n   * Whether the Wix user has installed a free or paid version of your app\n   * on their site.\n   */\n  isFree?: boolean;\n  /**\n   * Billing information for the app instance. Available only in case\n   * `{\"isFree\": false}`.\n   */\n  billing?: BillingInfo;\n  /**\n   * List of [permissions](https://dev.wix.com/docs/build-apps/developer-tools/developers-center/example-app-walkthrough/build-an-app#4-add-permissions)\n   * that the Wix user has granted your app. You set the list of permissions that\n   * your app requires from the Wix user in your app's Permissions page.\n   */\n  permissions?: string[];\n  /** Plans available to this app instance. */\n  availablePlans?: AvailablePlan[];\n  /**\n   * ID of the Wix site from which the instance of your app has been cloned.\n   * Available only when `{\"copiedFromTemplate\": true}`.\n   * All visual settings of the Wix site and app data are duplicated during the\n   * cloning process. Wix also notifies you in case there is any additional\n   * external functionality for the original site.\n   */\n  originInstanceId?: string | null;\n  /**\n   * __Deprecated__. This parameter will be removed on March 30, 2023. Use\n   * `copiedFromTemplate` instead.\n   * @deprecated\n   */\n  isOriginSiteTemplate?: boolean;\n  /** Whether this app instance was created when another Wix site was cloned. */\n  copiedFromTemplate?: boolean;\n  /** Whether this app instance includes a free trial that hasn't started yet. */\n  freeTrialAvailable?: boolean;\n}\n\nexport interface BillingInfo {\n  /** Name of the package that the site owner has paid for. */\n  packageName?: string;\n  /**\n   * Interval of the billing cycle. `ONE_TIME` indicates that the Wix user has\n   * made a single upfront payment without any automatic subscription renewal.\n   * This is primarily for usage credits (for example, 5 SMS) but may occasionally apply\n   * to a one-time setup for the app.\n   */\n  billingCycle?: PaymentCycleWithLiterals;\n  /**\n   * Date and time the Wix user purchased the app's paid plan or began their free trial. In\n   * `YYYY-MM-DDThh:mm:ss.sssZ` format.\n   */\n  timeStamp?: string;\n  /**\n   * Date and time the app's current billing cycle ends in\n   * `YYYY-MM-DDThh:mm:ss.sssZ` format. Available only for yearly and\n   * multi-yearly plans.\n   */\n  expirationDate?: string | null;\n  /**\n   * Whether the app's subscription automatically renews at the end of the\n   * current billing cycle.\n   */\n  autoRenewing?: boolean | null;\n  /** ID of the invoice for the current billing cycle. */\n  invoiceId?: string | null;\n  /**\n   * Information about any discounts applied to the app instance's current billing cycle.\n   * If the site owners applied a developer coupon or Wix Voucher\n   * when installing the paid version of your app, this field holds the coupon's\n   * name or `“Wix discount coupon”`. Site owners may receive a Wix Voucher when\n   * upgrading their Wix subscription. If there is no discount for the\n   * current billing cycle, the field is an empty string.\n   */\n  source?: string | null;\n  /** Information about the free trial applied, if relevant. */\n  freeTrialInfo?: FreeTrialInfo;\n}\n\nexport enum PaymentCycle {\n  NO_CYCLE = 'NO_CYCLE',\n  MONTHLY = 'MONTHLY',\n  YEARLY = 'YEARLY',\n  ONE_TIME = 'ONE_TIME',\n  TWO_YEARS = 'TWO_YEARS',\n  THREE_YEARS = 'THREE_YEARS',\n  FOUR_YEARS = 'FOUR_YEARS',\n  FIVE_YEARS = 'FIVE_YEARS',\n}\n\n/** @enumType */\nexport type PaymentCycleWithLiterals =\n  | PaymentCycle\n  | 'NO_CYCLE'\n  | 'MONTHLY'\n  | 'YEARLY'\n  | 'ONE_TIME'\n  | 'TWO_YEARS'\n  | 'THREE_YEARS'\n  | 'FOUR_YEARS'\n  | 'FIVE_YEARS';\n\nexport interface FreeTrialInfo {\n  /**\n   * Current free trial status.\n   * @readonly\n   */\n  status?: FreeTrialStatusWithLiterals;\n  /**\n   * When the free trial has ended. Populated only once the free trial is over.\n   * @readonly\n   */\n  endDate?: Date | null;\n}\n\nexport enum FreeTrialStatus {\n  /** Unknown trial status. */\n  UNKNOWN_STATUS = 'UNKNOWN_STATUS',\n  /** The free trial is currently in progress. */\n  IN_PROGRESS = 'IN_PROGRESS',\n  /** The free trial has ended. */\n  ENDED = 'ENDED',\n  /** No free trial was applied, as none was available. */\n  NOT_AVAILABLE = 'NOT_AVAILABLE',\n}\n\n/** @enumType */\nexport type FreeTrialStatusWithLiterals =\n  | FreeTrialStatus\n  | 'UNKNOWN_STATUS'\n  | 'IN_PROGRESS'\n  | 'ENDED'\n  | 'NOT_AVAILABLE';\n\nexport interface AvailablePlan {\n  /** Package name of the available plan. */\n  packageName?: string;\n  /** Source of the available plan. Can be a bundle or 3rd-party app. */\n  source?: string;\n}\n\nexport interface AppInstalled {\n  /**\n   * Unique identifier of the app within the website.\n   * @format GUID\n   */\n  appId?: string;\n  /**\n   * Instance ID of the app in the original website (relevant only when this site was [duplicated from another site](https://support.wix.com/en/article/duplicating-your-site-1472847)).\n   * @format GUID\n   */\n  originInstanceId?: string | null;\n}\n\nexport interface AppRemoved {\n  /**\n   * Unique identifier of the app within the website.\n   * @format GUID\n   */\n  appId?: string;\n}\n\nexport interface PaidPlanPurchased {\n  /** Date and time of purchase. */\n  operationTimeStamp?: Date | null;\n  /**\n   * Purchased app plan.\n   * @maxLength 100\n   */\n  vendorProductId?: string;\n  /** Selected payment cycle. */\n  cycle?: PaymentCycleWithLiterals;\n  /** Plan expiration date. */\n  expiresOn?: Date | null;\n  /**\n   * Coupon applied to purchase (if relevant).\n   * @maxLength 150\n   */\n  couponName?: string | null;\n  /**\n   * Invoice ID.\n   * @maxLength 50\n   */\n  invoiceId?: string | null;\n}\n\nexport interface PaidPlanChanged {\n  /** Date and time of change. */\n  operationTimeStamp?: Date | null;\n  /**\n   * Newly purchased app plan.\n   * @maxLength 100\n   */\n  vendorProductId?: string;\n  /** Newly selected payment cycle. */\n  cycle?: PaymentCycleWithLiterals;\n  /**\n   * Previous app plan.\n   * @maxLength 100\n   */\n  previousVendorProductId?: string | null;\n  /** Previous payment cycle. */\n  previousCycle?: PaymentCycleWithLiterals;\n  /**\n   * Coupon applied to purchase (if relevant).\n   * @maxLength 150\n   */\n  couponName?: string | null;\n  /**\n   * Invoice ID.\n   * @maxLength 50\n   */\n  invoiceId?: string | null;\n}\n\nexport interface PaidPlanAutoRenewalCancelled {\n  /** Date and time of auto-renewal cancellation. */\n  operationTimeStamp?: Date | null;\n  /**\n   * Current app plan.\n   * @maxLength 100\n   */\n  vendorProductId?: string;\n  /** Current payment cycle. */\n  cycle?: PaymentCycleWithLiterals;\n  /**\n   * Supported values: `UNKNOWN_CANCELLATION_TYPE_ERROR_STATE`, `USER_CANCEL`, `FAILED_PAYMENT`, `TRANSFER_CANCELLATION_REASON`. Reason provided by app for cancellation (if relevant).\n   * @maxLength 100\n   */\n  cancelReason?: string | null;\n  /**\n   * Reason provided by site owner for cancellation (if relevant).\n   * @maxLength 150\n   */\n  userReason?: string | null;\n  /**\n   * Cancellation type.\n   * @maxLength 100\n   */\n  subscriptionCancellationType?: string | null;\n  /** Whether the cancellation occurred during a free trial. */\n  cancelledDuringFreeTrial?: FreeTrialPeriodWithLiterals;\n}\n\nexport enum FreeTrialPeriod {\n  /** Free trial status unknown. */\n  FREE_TRIAL_PERIOD_UNKNOWN = 'FREE_TRIAL_PERIOD_UNKNOWN',\n  /** During a free trial period. */\n  DURING_FREE_TRIAL = 'DURING_FREE_TRIAL',\n  /** Not during a free trial period. */\n  NOT_DURING_FREE_TRIAL = 'NOT_DURING_FREE_TRIAL',\n}\n\n/** @enumType */\nexport type FreeTrialPeriodWithLiterals =\n  | FreeTrialPeriod\n  | 'FREE_TRIAL_PERIOD_UNKNOWN'\n  | 'DURING_FREE_TRIAL'\n  | 'NOT_DURING_FREE_TRIAL';\n\nexport interface PlanTransferred {\n  /** Date and time of transfer. */\n  operationTimeStamp?: Date | null;\n  /**\n   * Current app plan.\n   * @maxLength 100\n   */\n  vendorProductId?: string;\n  /** Selected payment cycle. */\n  cycle?: PaymentCycleWithLiterals;\n  /**\n   * Invoice ID.\n   * @maxLength 50\n   */\n  invoiceId?: string | null;\n}\n\nexport interface PlanReactivated {\n  /** Date and time of reactivation. */\n  operationTimeStamp?: Date | null;\n  /**\n   * Current app plan.\n   * @maxLength 100\n   */\n  vendorProductId?: string;\n  /** Selected payment cycle. */\n  cycle?: PaymentCycleWithLiterals;\n  /** Plan expiration date. */\n  expiresOn?: Date | null;\n  /**\n   * Invoice ID.\n   * @maxLength 50\n   */\n  invoiceId?: string | null;\n  /** Reason for reactivation. */\n  reason?: ReactivationReasonWithLiterals;\n}\n\nexport enum ReactivationReason {\n  /** Reactivation reason unknown. */\n  REACTIVATION_REASON_UNKNOWN = 'REACTIVATION_REASON_UNKNOWN',\n  /** The subscription's auto-renewal is turned on. */\n  AUTO_RENEW_TURNED_ON = 'AUTO_RENEW_TURNED_ON',\n}\n\n/** @enumType */\nexport type ReactivationReasonWithLiterals =\n  | ReactivationReason\n  | 'REACTIVATION_REASON_UNKNOWN'\n  | 'AUTO_RENEW_TURNED_ON';\n\nexport interface PlanConvertedToPaid {\n  /** Date and time of conversion to paid subscription (free-trial ended). */\n  operationTimeStamp?: Date | null;\n  /**\n   * Current app plan.\n   * @maxLength 100\n   */\n  vendorProductId?: string;\n  /** Selected payment cycle. */\n  cycle?: PaymentCycleWithLiterals;\n  /** Plan expiration date. */\n  expiresOn?: Date | null;\n}\n\nexport interface GetAppInstanceRequest {}\n\nexport interface GetAppInstanceResponse {\n  /** Retrieved app instance. */\n  instance?: AppInstance;\n  /** Information about the site. */\n  site?: SiteInfo;\n}\n\nexport interface SiteInfo {\n  /** Display name of the site. */\n  siteDisplayName?: string | null;\n  /**\n   * 2-letter language code of the site's locale in\n   * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n   */\n  locale?: string;\n  /**\n   * 3-letter currency code for the site's billing in\n   * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n   */\n  paymentCurrency?: string;\n  /** Information about the site's supported languages. */\n  multilingual?: Multilingual;\n  /** URL of the site. Available only when the site has been published. */\n  url?: string | null;\n  /** Description of the site. */\n  description?: string | null;\n  /** Apps made by Wix that are installed on the site. */\n  installedWixApps?: string[];\n  /**\n   * > **Deprecation Notice:** This parameter will be removed on June 30, 2022. Use `ownerInfo` instead.\n   * @format EMAIL\n   * @deprecated\n   */\n  ownerEmail?: string | null;\n  /**\n   * Information about the site's Wix user. Available only when calling\n   * _Get App Instance_ with the __Read Site Owner Email__ permission scope.\n   */\n  ownerInfo?: OwnerInfo;\n  /** Site ID. */\n  siteId?: string;\n}\n\nexport interface Multilingual {\n  /** Whether the site supports more than a single language. */\n  isMultiLingual?: boolean;\n  /** List of supported languages. Returned only when `{\"isMultiLingual\": true}`. */\n  supportedLanguages?: SupportedLanguage[];\n}\n\nexport interface SupportedLanguage {\n  /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */\n  languageCode?: string;\n  /** Locale. */\n  locale?: Locale;\n  /** Whether the supported language is the primary language for the site. */\n  isPrimary?: boolean;\n  /** Language icon. */\n  countryCode?: string;\n  /** How the language will be resolved. For internal use. */\n  resolutionMethod?: ResolutionMethodWithLiterals;\n  /** Whether the supported language is the primary language for site visitors. */\n  isVisitorPrimary?: boolean | null;\n}\n\nexport interface Locale {\n  /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */\n  languageCode?: string;\n  /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */\n  country?: string;\n}\n\nexport enum ResolutionMethod {\n  QUERY_PARAM = 'QUERY_PARAM',\n  SUBDOMAIN = 'SUBDOMAIN',\n  SUBDIRECTORY = 'SUBDIRECTORY',\n}\n\n/** @enumType */\nexport type ResolutionMethodWithLiterals =\n  | ResolutionMethod\n  | 'QUERY_PARAM'\n  | 'SUBDOMAIN'\n  | 'SUBDIRECTORY';\n\nexport interface OwnerInfo {\n  /**\n   * Wix user's email address. Identical to the their login email.\n   * @format EMAIL\n   */\n  email?: string;\n  /**\n   * Supported values: `VERIFIED_OPT_IN`, `VERIFIED_OPT_OUT`,\n   * `NOT_VERIFIED_OPT_IN`, `NOT_VERIFIED_OPT_OUT`.\n   *\n   * Whether the Wix user has verified their email and whether they have chosen\n   * to receive email notifications from Wix.\n   */\n  emailStatus?: string;\n}\n\nexport interface GetComparatorFromFetchersRequest {}\n\nexport interface GetComparatorFromFetchersResponse {\n  /**\n   * List of differences between the app instance and the migrated app instance\n   * @maxSize 50\n   */\n  differences?: AppInstanceDifference[];\n}\n\nexport interface AppInstanceDifference {\n  /**\n   * The field that has a difference between the app instance and the migrated app instance.\n   * @maxLength 100\n   */\n  field?: string;\n  /**\n   * The value of the field in the app instance.\n   * @maxLength 100\n   */\n  fetchFrom?: string;\n  /**\n   * The value of the field in the migrated app instance.\n   * @maxLength 100\n   */\n  fetchFromV2?: string;\n}\n\nexport interface GetAppInstanceByInstanceIdRequest {\n  /**\n   * ID of the app instance to retrieve.\n   * @format GUID\n   */\n  instanceId?: string;\n}\n\nexport interface MessageEnvelope {\n  /**\n   * App instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n  /**\n   * Event type.\n   * @maxLength 150\n   */\n  eventType?: string;\n  /** The identification type and identity data. */\n  identity?: IdentificationData;\n  /** Stringify payload. */\n  data?: string;\n}\n\nexport interface IdentificationData extends IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n  /** @readonly */\n  identityType?: WebhookIdentityTypeWithLiterals;\n}\n\n/** @oneof */\nexport interface IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n}\n\nexport enum WebhookIdentityType {\n  UNKNOWN = 'UNKNOWN',\n  ANONYMOUS_VISITOR = 'ANONYMOUS_VISITOR',\n  MEMBER = 'MEMBER',\n  WIX_USER = 'WIX_USER',\n  APP = 'APP',\n}\n\n/** @enumType */\nexport type WebhookIdentityTypeWithLiterals =\n  | WebhookIdentityType\n  | 'UNKNOWN'\n  | 'ANONYMOUS_VISITOR'\n  | 'MEMBER'\n  | 'WIX_USER'\n  | 'APP';\n\nexport interface BaseEventMetadata {\n  /**\n   * App instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n  /**\n   * Event type.\n   * @maxLength 150\n   */\n  eventType?: string;\n  /** The identification type and identity data. */\n  identity?: IdentificationData;\n}\n\nexport interface AppInstanceInstalledEnvelope {\n  data: AppInstalled;\n  metadata: BaseEventMetadata;\n}\n\n/**\n * Triggered when an instance of your app is installed on a Wix site.\n * @permissionScope Manage Your App\n * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP\n * @permissionScope Read site, business, and email details\n * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO\n * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE\n * @webhook\n * @eventType AppInstalled\n * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService\n * @slug installed\n */\nexport declare function onAppInstanceInstalled(\n  handler: (event: AppInstanceInstalledEnvelope) => void | Promise<void>\n): void;\n\nexport interface AppInstanceRemovedEnvelope {\n  data: AppRemoved;\n  metadata: BaseEventMetadata;\n}\n\n/**\n * Triggered when an instance of your app is uninstalled from a Wix site.\n * @permissionScope Manage Your App\n * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP\n * @permissionScope Read site, business, and email details\n * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO\n * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE\n * @webhook\n * @eventType AppRemoved\n * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService\n * @slug removed\n */\nexport declare function onAppInstanceRemoved(\n  handler: (event: AppInstanceRemovedEnvelope) => void | Promise<void>\n): void;\n\nexport interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {\n  data: PaidPlanAutoRenewalCancelled;\n  metadata: BaseEventMetadata;\n}\n\n/**\n * Triggered when a Wix user either cancels a paid plan for your app, or cancels the plan's auto-renewal. The\n * Wix user can continue to use your app until the end of the current billing\n * cycle.\n * @permissionScope Manage Your App\n * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP\n * @permissionScope Read site, business, and email details\n * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO\n * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE\n * @webhook\n * @eventType PaidPlanAutoRenewalCancelled\n * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService\n * @slug paid_plan_auto_renewal_cancelled\n */\nexport declare function onAppInstancePaidPlanAutoRenewalCancelled(\n  handler: (\n    event: AppInstancePaidPlanAutoRenewalCancelledEnvelope\n  ) => void | Promise<void>\n): void;\n\nexport interface AppInstancePaidPlanChangedEnvelope {\n  data: PaidPlanChanged;\n  metadata: BaseEventMetadata;\n}\n\n/**\n * Triggered when a Wix user upgrades or downgrades their plan for your app.\n * @permissionScope Manage Your App\n * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP\n * @permissionScope Read site, business, and email details\n * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO\n * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE\n * @webhook\n * @eventType PaidPlanChanged\n * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService\n * @slug paid_plan_changed\n */\nexport declare function onAppInstancePaidPlanChanged(\n  handler: (event: AppInstancePaidPlanChangedEnvelope) => void | Promise<void>\n): void;\n\nexport interface AppInstancePaidPlanPurchasedEnvelope {\n  data: PaidPlanPurchased;\n  metadata: BaseEventMetadata;\n}\n\n/**\n * Triggered when a Wix user purchases a paid plan for your app.\n * @permissionScope Manage Your App\n * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP\n * @permissionScope Read site, business, and email details\n * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO\n * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE\n * @webhook\n * @eventType PaidPlanPurchased\n * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService\n * @slug paid_plan_purchased\n */\nexport declare function onAppInstancePaidPlanPurchased(\n  handler: (event: AppInstancePaidPlanPurchasedEnvelope) => void | Promise<void>\n): void;\n\nexport interface AppInstancePlanConvertedToPaidEnvelope {\n  data: PlanConvertedToPaid;\n  metadata: BaseEventMetadata;\n}\n\n/**\n * Triggered when a Wix user reaches the end of a free-trial period and is charged successfully.\n * @permissionScope Manage Your App\n * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP\n * @permissionScope Read site, business, and email details\n * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO\n * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE\n * @webhook\n * @eventType PlanConvertedToPaid\n * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService\n * @slug plan_converted_to_paid\n * @documentationMaturity preview\n */\nexport declare function onAppInstancePlanConvertedToPaid(\n  handler: (\n    event: AppInstancePlanConvertedToPaidEnvelope\n  ) => void | Promise<void>\n): void;\n\nexport interface AppInstancePlanReactivatedEnvelope {\n  data: PlanReactivated;\n  metadata: BaseEventMetadata;\n}\n\n/**\n * Triggered when auto-renewal is turned on for a paid plan.\n * @permissionScope Manage Your App\n * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP\n * @permissionScope Read site, business, and email details\n * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO\n * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE\n * @webhook\n * @eventType PlanReactivated\n * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService\n * @slug plan_reactivated\n * @documentationMaturity preview\n */\nexport declare function onAppInstancePlanReactivated(\n  handler: (event: AppInstancePlanReactivatedEnvelope) => void | Promise<void>\n): void;\n\nexport interface AppInstancePlanTransferredEnvelope {\n  data: PlanTransferred;\n  metadata: BaseEventMetadata;\n}\n\n/**\n * Triggered when a paid plan for your app is transferred to a different Wix account.\n * @permissionScope Manage Your App\n * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP\n * @permissionScope Read site, business, and email details\n * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO\n * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE\n * @webhook\n * @eventType PlanTransferred\n * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService\n * @slug plan_transferred\n * @documentationMaturity preview\n */\nexport declare function onAppInstancePlanTransferred(\n  handler: (event: AppInstancePlanTransferredEnvelope) => void | Promise<void>\n): void;\n\ntype AppInstanceNonNullablePaths =\n  | `instanceId`\n  | `appName`\n  | `isFree`\n  | `billing.packageName`\n  | `billing.billingCycle`\n  | `billing.timeStamp`\n  | `billing.freeTrialInfo.status`\n  | `permissions`\n  | `availablePlans`\n  | `availablePlans.${number}.packageName`\n  | `availablePlans.${number}.source`\n  | `isOriginSiteTemplate`\n  | `copiedFromTemplate`\n  | `freeTrialAvailable`;\n\n/**\n * Retrieves data about the instance of your app that's installed on a Wix\n * 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,\n * or to check which apps made by Wix are installed on the site.\n *\n * You must authenticate this method [as a Wix app](https://dev.wix.com/docs/build-apps/develop-your-app/access/authentication/authenticate-using-oauth#step-2--make-an-authenticated-api-request).\n *\n * To retrieve `site.ownerInfo` in the response, you must\n * have the __READ SITE OWNER EMAIL__ permission scope in addition to\n * __MANAGE YOUR APP__.\n * @public\n * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE\n * @applicableIdentity APP\n * @fqn com.wixpress.market.aim.api.AppInstanceService.GetAppInstance\n */\nexport async function getAppInstance(): Promise<\n  NonNullablePaths<\n    GetAppInstanceResponse,\n    | {\n        [P in AppInstanceNonNullablePaths]: `instance.${P}`;\n      }[AppInstanceNonNullablePaths]\n    | `site.locale`\n    | `site.paymentCurrency`\n    | `site.multilingual.isMultiLingual`\n    | `site.multilingual.supportedLanguages`\n    | `site.multilingual.supportedLanguages.${number}.languageCode`\n    | `site.multilingual.supportedLanguages.${number}.locale.languageCode`\n    | `site.multilingual.supportedLanguages.${number}.locale.country`\n    | `site.multilingual.supportedLanguages.${number}.isPrimary`\n    | `site.multilingual.supportedLanguages.${number}.countryCode`\n    | `site.multilingual.supportedLanguages.${number}.resolutionMethod`\n    | `site.installedWixApps`\n    | `site.ownerInfo.email`\n    | `site.ownerInfo.emailStatus`\n    | `site.siteId`\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[0] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({});\n\n  const reqOpts =\n    ambassadorWixDevcenterAppInstanceV1AppInstance.getAppInstance(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: {},\n        singleArgumentUnchanged: false,\n      },\n      []\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveComWixpressMarketAimApiAppInstanceServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'api._api_base_domain_': [\n      {\n        srcPath: '/app-instance-manager-webapp',\n        destPath: '',\n      },\n    ],\n    'www.wixapis.com': [\n      {\n        srcPath: '/apps',\n        destPath: '',\n      },\n    ],\n    'wixapis.com': [\n      {\n        srcPath: '/apps',\n        destPath: '',\n      },\n    ],\n    'dev._base_domain_': [\n      {\n        srcPath: '/_api/app-instance-manager',\n        destPath: '',\n      },\n      {\n        srcPath: '/api/v1/instance',\n        destPath: '/v1/instance',\n      },\n      {\n        srcPath: '/api/v1/scripts',\n        destPath: '/v1/scripts',\n      },\n    ],\n    'manage._base_domain_': [\n      {\n        srcPath: '/_api/app-instance-manager',\n        destPath: '',\n      },\n    ],\n    'www._base_domain_': [\n      {\n        srcPath: '/_api/app-instance-manager',\n        destPath: '',\n      },\n    ],\n    'editor._base_domain_': [\n      {\n        srcPath: '/_api/app-instance-manager',\n        destPath: '',\n      },\n    ],\n    'blocks._base_domain_': [\n      {\n        srcPath: '/_api/app-instance-manager',\n        destPath: '',\n      },\n    ],\n    'create.editorx': [\n      {\n        srcPath: '/_api/app-instance-manager',\n        destPath: '',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_app-management_app-instances';\n\n/**\n * Retrieves data about the instance of your app that's installed on a Wix\n * 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,\n * or to check which apps made by Wix are installed on the site.\n *\n * You must authenticate this method [as a Wix app](https://dev.wix.com/docs/build-apps/develop-your-app/access/authentication/authenticate-using-oauth#step-2--make-an-authenticated-api-request).\n *\n * To retrieve `site.ownerInfo` in the response, you must\n * have the __READ SITE OWNER EMAIL__ permission scope in addition to\n * __MANAGE YOUR APP__.\n */\nexport function getAppInstance(payload: object): RequestOptionsFactory<any> {\n  function __getAppInstance({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.devcenter.app_instance.v1.app_instance',\n      method: 'GET' as any,\n      methodFqn:\n        'com.wixpress.market.aim.api.AppInstanceService.GetAppInstance',\n      packageName: PACKAGE_NAME,\n      url: resolveComWixpressMarketAimApiAppInstanceServiceUrl({\n        protoPath: '/v1/instance',\n        data: payload,\n        host,\n      }),\n      params: toURLSearchParams(payload),\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'instance.billing.freeTrialInfo.endDate' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __getAppInstance;\n}\n","import { getAppInstance as publicGetAppInstance } from './devcenter-app-instance-v1-app-instance-app-instances.public.js';\nimport { createRESTModule } from '@wix/sdk-runtime/rest-modules';\nimport { createEventModule } from '@wix/sdk-runtime/event-definition-modules';\nimport {\n  BuildRESTFunction,\n  MaybeContext,\n  BuildEventDefinition,\n} from '@wix/sdk-types';\nimport { onAppInstanceInstalled as publicOnAppInstanceInstalled } from './devcenter-app-instance-v1-app-instance-app-instances.public.js';\nimport { onAppInstanceRemoved as publicOnAppInstanceRemoved } from './devcenter-app-instance-v1-app-instance-app-instances.public.js';\nimport { onAppInstancePaidPlanAutoRenewalCancelled as publicOnAppInstancePaidPlanAutoRenewalCancelled } from './devcenter-app-instance-v1-app-instance-app-instances.public.js';\nimport { onAppInstancePaidPlanChanged as publicOnAppInstancePaidPlanChanged } from './devcenter-app-instance-v1-app-instance-app-instances.public.js';\nimport { onAppInstancePaidPlanPurchased as publicOnAppInstancePaidPlanPurchased } from './devcenter-app-instance-v1-app-instance-app-instances.public.js';\nimport { onAppInstancePlanConvertedToPaid as publicOnAppInstancePlanConvertedToPaid } from './devcenter-app-instance-v1-app-instance-app-instances.public.js';\nimport { onAppInstancePlanReactivated as publicOnAppInstancePlanReactivated } from './devcenter-app-instance-v1-app-instance-app-instances.public.js';\nimport { onAppInstancePlanTransferred as publicOnAppInstancePlanTransferred } from './devcenter-app-instance-v1-app-instance-app-instances.public.js';\n\nexport const getAppInstance: MaybeContext<\n  BuildRESTFunction<typeof publicGetAppInstance> & typeof publicGetAppInstance\n> = /*#__PURE__*/ createRESTModule(publicGetAppInstance);\n/**\n * Triggered when an instance of your app is installed on a Wix site.\n */\nexport const onAppInstanceInstalled: BuildEventDefinition<\n  typeof publicOnAppInstanceInstalled\n> = createEventModule(publicOnAppInstanceInstalled);\n/**\n * Triggered when an instance of your app is uninstalled from a Wix site.\n */\nexport const onAppInstanceRemoved: BuildEventDefinition<\n  typeof publicOnAppInstanceRemoved\n> = createEventModule(publicOnAppInstanceRemoved);\n/**\n * Triggered when a Wix user either cancels a paid plan for your app, or cancels the plan's auto-renewal. The\n * Wix user can continue to use your app until the end of the current billing\n * cycle.\n */\nexport const onAppInstancePaidPlanAutoRenewalCancelled: BuildEventDefinition<\n  typeof publicOnAppInstancePaidPlanAutoRenewalCancelled\n> = createEventModule(publicOnAppInstancePaidPlanAutoRenewalCancelled);\n/**\n * Triggered when a Wix user upgrades or downgrades their plan for your app.\n */\nexport const onAppInstancePaidPlanChanged: BuildEventDefinition<\n  typeof publicOnAppInstancePaidPlanChanged\n> = createEventModule(publicOnAppInstancePaidPlanChanged);\n/**\n * Triggered when a Wix user purchases a paid plan for your app.\n */\nexport const onAppInstancePaidPlanPurchased: BuildEventDefinition<\n  typeof publicOnAppInstancePaidPlanPurchased\n> = createEventModule(publicOnAppInstancePaidPlanPurchased);\n/**\n * Triggered when a Wix user reaches the end of a free-trial period and is charged successfully.\n */\nexport const onAppInstancePlanConvertedToPaid: BuildEventDefinition<\n  typeof publicOnAppInstancePlanConvertedToPaid\n> = createEventModule(publicOnAppInstancePlanConvertedToPaid);\n/**\n * Triggered when auto-renewal is turned on for a paid plan.\n */\nexport const onAppInstancePlanReactivated: BuildEventDefinition<\n  typeof publicOnAppInstancePlanReactivated\n> = createEventModule(publicOnAppInstancePlanReactivated);\n/**\n * Triggered when a paid plan for your app is transferred to a different Wix account.\n */\nexport const onAppInstancePlanTransferred: BuildEventDefinition<\n  typeof publicOnAppInstancePlanTransferred\n> = createEventModule(publicOnAppInstancePlanTransferred);\n\nexport {\n  PaymentCycle,\n  FreeTrialStatus,\n  FreeTrialPeriod,\n  ReactivationReason,\n  ResolutionMethod,\n  WebhookIdentityType,\n} from './devcenter-app-instance-v1-app-instance-app-instances.universal.js';\nexport {\n  AppInstance,\n  BillingInfo,\n  FreeTrialInfo,\n  AvailablePlan,\n  AppInstalled,\n  AppRemoved,\n  PaidPlanPurchased,\n  PaidPlanChanged,\n  PaidPlanAutoRenewalCancelled,\n  PlanTransferred,\n  PlanReactivated,\n  PlanConvertedToPaid,\n  GetAppInstanceRequest,\n  GetAppInstanceResponse,\n  SiteInfo,\n  Multilingual,\n  SupportedLanguage,\n  Locale,\n  OwnerInfo,\n  GetComparatorFromFetchersRequest,\n  GetComparatorFromFetchersResponse,\n  AppInstanceDifference,\n  GetAppInstanceByInstanceIdRequest,\n  MessageEnvelope,\n  IdentificationData,\n  IdentificationDataIdOneOf,\n  BaseEventMetadata,\n  AppInstanceInstalledEnvelope,\n  AppInstanceRemovedEnvelope,\n  AppInstancePaidPlanAutoRenewalCancelledEnvelope,\n  AppInstancePaidPlanChangedEnvelope,\n  AppInstancePaidPlanPurchasedEnvelope,\n  AppInstancePlanConvertedToPaidEnvelope,\n  AppInstancePlanReactivatedEnvelope,\n  AppInstancePlanTransferredEnvelope,\n} from './devcenter-app-instance-v1-app-instance-app-instances.universal.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAAAA;AAAA,EAAA,8BAAAC;AAAA,EAAA,iDAAAC;AAAA,EAAA,oCAAAC;AAAA,EAAA,sCAAAC;AAAA,EAAA,wCAAAC;AAAA,EAAA,oCAAAC;AAAA,EAAA,oCAAAC;AAAA,EAAA,4BAAAC;AAAA;AAAA;;;ACAA,IAAAC,iCAAwD;AACxD,IAAAC,oBAAqD;AACrD,IAAAC,0BAA+B;AAC/B,uBAA8D;;;ACH9D,6BAAoD;AACpD,oCAGO;;;ACJP,0BAAkC;AAClC,uBAAqD;AACrD,6BAA+B;AAC/B,IAAAC,uBAA2B;AAI3B,SAAS,oDACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,yBAAyB;AAAA,MACvB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,eAAe;AAAA,MACb;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,qBAAqB;AAAA,MACnB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,qBAAqB;AAAA,MACnB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,kBAAkB;AAAA,MAChB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,iCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAad,SAAS,eAAe,SAA6C;AAC1E,WAAS,iBAAiB,EAAE,KAAK,GAAQ;AACvC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,KAAK,oDAAoD;AAAA,QACvD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,YAAQ,uCAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACC,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,yCAAyC,CAAC;AAAA,QAC5D;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADdO,IAAK,eAAL,kBAAKC,kBAAL;AACL,EAAAA,cAAA,cAAW;AACX,EAAAA,cAAA,aAAU;AACV,EAAAA,cAAA,YAAS;AACT,EAAAA,cAAA,cAAW;AACX,EAAAA,cAAA,eAAY;AACZ,EAAAA,cAAA,iBAAc;AACd,EAAAA,cAAA,gBAAa;AACb,EAAAA,cAAA,gBAAa;AARH,SAAAA;AAAA,GAAA;AAoCL,IAAK,kBAAL,kBAAKC,qBAAL;AAEL,EAAAA,iBAAA,oBAAiB;AAEjB,EAAAA,iBAAA,iBAAc;AAEd,EAAAA,iBAAA,WAAQ;AAER,EAAAA,iBAAA,mBAAgB;AARN,SAAAA;AAAA,GAAA;AAiIL,IAAK,kBAAL,kBAAKC,qBAAL;AAEL,EAAAA,iBAAA,+BAA4B;AAE5B,EAAAA,iBAAA,uBAAoB;AAEpB,EAAAA,iBAAA,2BAAwB;AANd,SAAAA;AAAA,GAAA;AAsDL,IAAK,qBAAL,kBAAKC,wBAAL;AAEL,EAAAA,oBAAA,iCAA8B;AAE9B,EAAAA,oBAAA,0BAAuB;AAJb,SAAAA;AAAA,GAAA;AAqGL,IAAK,mBAAL,kBAAKC,sBAAL;AACL,EAAAA,kBAAA,iBAAc;AACd,EAAAA,kBAAA,eAAY;AACZ,EAAAA,kBAAA,kBAAe;AAHL,SAAAA;AAAA,GAAA;AAmIL,IAAK,sBAAL,kBAAKC,yBAAL;AACL,EAAAA,qBAAA,aAAU;AACV,EAAAA,qBAAA,uBAAoB;AACpB,EAAAA,qBAAA,YAAS;AACT,EAAAA,qBAAA,cAAW;AACX,EAAAA,qBAAA,SAAM;AALI,SAAAA;AAAA,GAAA;AAgPZ,eAAsBC,kBAqBpB;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC,CAAC,CAAC;AAExD,QAAM,UAC2C,eAAe,OAAO;AAEvE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAC;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,CAAC;AAAA,QAC3B,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC;AAAA,IACH;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;;;AD7yBO,SAASC,gBACd,YACyB;AACzB,SAAO,MACLA;AAAA;AAAA,IAEE,EAAE,WAAW;AAAA,EACf;AACJ;AAsCO,IAAM,6BAAyB;AAAA,EACpC;AAAA,EACA;AAAA,EACA,CAAC,cACC,wEAAwC,KAAK;AACjD,EAAgC;AACzB,IAAM,2BAAuB;AAAA,EAClC;AAAA,EACA;AAAA,EACA,CAAC,cACC,wEAAwC,KAAK;AACjD,EAA8B;AACvB,IAAM,gDAA4C;AAAA,EACvD;AAAA,EACA;AAAA,EACA,CAAC,cACC;AAAA,QACE,wCAAe,OAAO;AAAA,MACpB;AAAA,QACE,aAAa;AAAA,QACb,OAAO,CAAC,EAAE,MAAM,0BAA0B,CAAC;AAAA,MAC7C;AAAA,IACF,CAAC;AAAA,EACH;AACJ,EAAmD;AAC5C,IAAM,mCAA+B;AAAA,EAC1C;AAAA,EACA;AAAA,EACA,CAAC,cACC;AAAA,QACE,wCAAe,OAAO;AAAA,MACpB;AAAA,QACE,aAAa;AAAA,QACb,OAAO,CAAC,EAAE,MAAM,0BAA0B,CAAC;AAAA,MAC7C;AAAA,IACF,CAAC;AAAA,EACH;AACJ,EAAsC;AAC/B,IAAM,qCAAiC;AAAA,EAC5C;AAAA,EACA;AAAA,EACA,CAAC,cACC;AAAA,QACE,wCAAe,OAAO;AAAA,MACpB;AAAA,QACE,aAAa;AAAA,QACb,OAAO;AAAA,UACL,EAAE,MAAM,0BAA0B;AAAA,UAClC,EAAE,MAAM,iBAAiB;AAAA,QAC3B;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AACJ,EAAwC;AACjC,IAAM,uCAAmC;AAAA,EAC9C;AAAA,EACA;AAAA,EACA,CAAC,cACC;AAAA,QACE,wCAAe,OAAO;AAAA,MACpB;AAAA,QACE,aAAa;AAAA,QACb,OAAO;AAAA,UACL,EAAE,MAAM,0BAA0B;AAAA,UAClC,EAAE,MAAM,iBAAiB;AAAA,QAC3B;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AACJ,EAA0C;AACnC,IAAM,mCAA+B;AAAA,EAC1C;AAAA,EACA;AAAA,EACA,CAAC,cACC;AAAA,QACE,wCAAe,OAAO;AAAA,MACpB;AAAA,QACE,aAAa;AAAA,QACb,OAAO;AAAA,UACL,EAAE,MAAM,0BAA0B;AAAA,UAClC,EAAE,MAAM,iBAAiB;AAAA,QAC3B;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AACJ,EAAsC;AAC/B,IAAM,mCAA+B;AAAA,EAC1C;AAAA,EACA;AAAA,EACA,CAAC,cACC;AAAA,QACE,wCAAe,OAAO;AAAA,MACpB;AAAA,QACE,aAAa;AAAA,QACb,OAAO,CAAC,EAAE,MAAM,0BAA0B,CAAC;AAAA,MAC7C;AAAA,IACF,CAAC;AAAA,EACH;AACJ,EAAsC;;;AGlLtC,IAAAC,uBAAiC;AACjC,sCAAkC;AAe3B,IAAMC,kBAEK,2DAAiBA,eAAoB;AAIhD,IAAMC,8BAET,mDAAkB,sBAA4B;AAI3C,IAAMC,4BAET,mDAAkB,oBAA0B;AAMzC,IAAMC,iDAET,mDAAkB,yCAA+C;AAI9D,IAAMC,oCAET,mDAAkB,4BAAkC;AAIjD,IAAMC,sCAET,mDAAkB,8BAAoC;AAInD,IAAMC,wCAET,mDAAkB,gCAAsC;AAIrD,IAAMC,oCAET,mDAAkB,4BAAkC;AAIjD,IAAMC,oCAET,mDAAkB,4BAAkC;","names":["getAppInstance","onAppInstanceInstalled","onAppInstancePaidPlanAutoRenewalCancelled","onAppInstancePaidPlanChanged","onAppInstancePaidPlanPurchased","onAppInstancePlanConvertedToPaid","onAppInstancePlanReactivated","onAppInstancePlanTransferred","onAppInstanceRemoved","import_rename_all_nested_keys","import_timestamp","import_transform_paths","import_rest_modules","payload","PaymentCycle","FreeTrialStatus","FreeTrialPeriod","ReactivationReason","ResolutionMethod","WebhookIdentityType","getAppInstance","sdkTransformError","getAppInstance","import_rest_modules","getAppInstance","onAppInstanceInstalled","onAppInstanceRemoved","onAppInstancePaidPlanAutoRenewalCancelled","onAppInstancePaidPlanChanged","onAppInstancePaidPlanPurchased","onAppInstancePlanConvertedToPaid","onAppInstancePlanReactivated","onAppInstancePlanTransferred"]}

package/build/cjs/{devcenter-app-instance-v1-app-instance-app-instances.universal-BPA1V_1w.d.ts → index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 /**
  * An app instance is a specific occurrence of an app on a Wix site.
  * When a Wix user installs an app, a unique instance is generated for that
@@ -513,33 +515,161 @@ interface AppInstanceInstalledEnvelope {
     data: AppInstalled;
     metadata: BaseEventMetadata;
 }
+/**
+ * Triggered when an instance of your app is installed on a Wix site.
+ * @permissionScope Manage Your App
+ * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP
+ * @permissionScope Read site, business, and email details
+ * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO
+ * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE
+ * @webhook
+ * @eventType AppInstalled
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
+ * @slug installed
+ */
+declare function onAppInstanceInstalled(handler: (event: AppInstanceInstalledEnvelope) => void | Promise<void>): void;
 interface AppInstanceRemovedEnvelope {
     data: AppRemoved;
     metadata: BaseEventMetadata;
 }
+/**
+ * Triggered when an instance of your app is uninstalled from a Wix site.
+ * @permissionScope Manage Your App
+ * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP
+ * @permissionScope Read site, business, and email details
+ * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO
+ * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE
+ * @webhook
+ * @eventType AppRemoved
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
+ * @slug removed
+ */
+declare function onAppInstanceRemoved(handler: (event: AppInstanceRemovedEnvelope) => void | Promise<void>): void;
 interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
     data: PaidPlanAutoRenewalCancelled;
     metadata: BaseEventMetadata;
 }
+/**
+ * Triggered when a Wix user either cancels a paid plan for your app, or cancels the plan's auto-renewal. The
+ * Wix user can continue to use your app until the end of the current billing
+ * cycle.
+ * @permissionScope Manage Your App
+ * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP
+ * @permissionScope Read site, business, and email details
+ * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO
+ * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE
+ * @webhook
+ * @eventType PaidPlanAutoRenewalCancelled
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
+ * @slug paid_plan_auto_renewal_cancelled
+ */
+declare function onAppInstancePaidPlanAutoRenewalCancelled(handler: (event: AppInstancePaidPlanAutoRenewalCancelledEnvelope) => void | Promise<void>): void;
 interface AppInstancePaidPlanChangedEnvelope {
     data: PaidPlanChanged;
     metadata: BaseEventMetadata;
 }
+/**
+ * Triggered when a Wix user upgrades or downgrades their plan for your app.
+ * @permissionScope Manage Your App
+ * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP
+ * @permissionScope Read site, business, and email details
+ * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO
+ * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE
+ * @webhook
+ * @eventType PaidPlanChanged
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
+ * @slug paid_plan_changed
+ */
+declare function onAppInstancePaidPlanChanged(handler: (event: AppInstancePaidPlanChangedEnvelope) => void | Promise<void>): void;
 interface AppInstancePaidPlanPurchasedEnvelope {
     data: PaidPlanPurchased;
     metadata: BaseEventMetadata;
 }
+/**
+ * Triggered when a Wix user purchases a paid plan for your app.
+ * @permissionScope Manage Your App
+ * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP
+ * @permissionScope Read site, business, and email details
+ * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO
+ * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE
+ * @webhook
+ * @eventType PaidPlanPurchased
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
+ * @slug paid_plan_purchased
+ */
+declare function onAppInstancePaidPlanPurchased(handler: (event: AppInstancePaidPlanPurchasedEnvelope) => void | Promise<void>): void;
 interface AppInstancePlanConvertedToPaidEnvelope {
     data: PlanConvertedToPaid;
     metadata: BaseEventMetadata;
 }
+/**
+ * Triggered when a Wix user reaches the end of a free-trial period and is charged successfully.
+ * @permissionScope Manage Your App
+ * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP
+ * @permissionScope Read site, business, and email details
+ * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO
+ * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE
+ * @webhook
+ * @eventType PlanConvertedToPaid
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
+ * @slug plan_converted_to_paid
+ * @documentationMaturity preview
+ */
+declare function onAppInstancePlanConvertedToPaid(handler: (event: AppInstancePlanConvertedToPaidEnvelope) => void | Promise<void>): void;
 interface AppInstancePlanReactivatedEnvelope {
     data: PlanReactivated;
     metadata: BaseEventMetadata;
 }
+/**
+ * Triggered when auto-renewal is turned on for a paid plan.
+ * @permissionScope Manage Your App
+ * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP
+ * @permissionScope Read site, business, and email details
+ * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO
+ * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE
+ * @webhook
+ * @eventType PlanReactivated
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
+ * @slug plan_reactivated
+ * @documentationMaturity preview
+ */
+declare function onAppInstancePlanReactivated(handler: (event: AppInstancePlanReactivatedEnvelope) => void | Promise<void>): void;
 interface AppInstancePlanTransferredEnvelope {
     data: PlanTransferred;
     metadata: BaseEventMetadata;
 }
+/**
+ * Triggered when a paid plan for your app is transferred to a different Wix account.
+ * @permissionScope Manage Your App
+ * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP
+ * @permissionScope Read site, business, and email details
+ * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO
+ * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE
+ * @webhook
+ * @eventType PlanTransferred
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
+ * @slug plan_transferred
+ * @documentationMaturity preview
+ */
+declare function onAppInstancePlanTransferred(handler: (event: AppInstancePlanTransferredEnvelope) => void | Promise<void>): void;
+type AppInstanceNonNullablePaths = `instanceId` | `appName` | `isFree` | `billing.packageName` | `billing.billingCycle` | `billing.timeStamp` | `billing.freeTrialInfo.status` | `permissions` | `availablePlans` | `availablePlans.${number}.packageName` | `availablePlans.${number}.source` | `isOriginSiteTemplate` | `copiedFromTemplate` | `freeTrialAvailable`;
+/**
+ * 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](https://dev.wix.com/docs/build-apps/develop-your-app/access/authentication/authenticate-using-oauth#step-2--make-an-authenticated-api-request).
+ *
+ * To retrieve `site.ownerInfo` in the response, you must
+ * have the __READ SITE OWNER EMAIL__ permission scope in addition to
+ * __MANAGE YOUR APP__.
+ * @public
+ * @permissionId WIX_DEVELOPERS.MANAGE_APP_INSTANCE
+ * @applicableIdentity APP
+ * @fqn com.wixpress.market.aim.api.AppInstanceService.GetAppInstance
+ */
+declare function getAppInstance(): Promise<NonNullablePaths<GetAppInstanceResponse, {
+    [P in AppInstanceNonNullablePaths]: `instance.${P}`;
+}[AppInstanceNonNullablePaths] | `site.locale` | `site.paymentCurrency` | `site.multilingual.isMultiLingual` | `site.multilingual.supportedLanguages` | `site.multilingual.supportedLanguages.${number}.languageCode` | `site.multilingual.supportedLanguages.${number}.locale.languageCode` | `site.multilingual.supportedLanguages.${number}.locale.country` | `site.multilingual.supportedLanguages.${number}.isPrimary` | `site.multilingual.supportedLanguages.${number}.countryCode` | `site.multilingual.supportedLanguages.${number}.resolutionMethod` | `site.installedWixApps` | `site.ownerInfo.email` | `site.ownerInfo.emailStatus` | `site.siteId`>>;
 
-export { type AppInstanceInstalledEnvelope as A, type BillingInfo as B, type MessageEnvelope as C, type IdentificationDataIdOneOf as D, type BaseEventMetadata as E, 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, type AppInstanceRemovedEnvelope as a, type AppInstancePaidPlanAutoRenewalCancelledEnvelope as b, type AppInstancePaidPlanChangedEnvelope as c, type AppInstancePaidPlanPurchasedEnvelope as d, type AppInstancePlanConvertedToPaidEnvelope as e, type AppInstancePlanReactivatedEnvelope as f, type AppInstancePlanTransferredEnvelope as g, FreeTrialPeriod as h, ResolutionMethod as i, type AppInstance as j, type FreeTrialInfo as k, type AvailablePlan as l, type AppInstalled as m, type AppRemoved as n, type PaidPlanPurchased as o, type PaidPlanChanged as p, type PaidPlanAutoRenewalCancelled as q, type PlanTransferred as r, type PlanReactivated as s, type PlanConvertedToPaid as t, type GetAppInstanceRequest as u, type SupportedLanguage as v, type GetComparatorFromFetchersRequest as w, type GetComparatorFromFetchersResponse as x, type AppInstanceDifference as y, type GetAppInstanceByInstanceIdRequest as z };
+export { type AppInstalled, type AppInstance, type AppInstanceDifference, type AppInstanceInstalledEnvelope, type AppInstancePaidPlanAutoRenewalCancelledEnvelope, type AppInstancePaidPlanChangedEnvelope, type AppInstancePaidPlanPurchasedEnvelope, type AppInstancePlanConvertedToPaidEnvelope, type AppInstancePlanReactivatedEnvelope, type AppInstancePlanTransferredEnvelope, type AppInstanceRemovedEnvelope, type AppRemoved, type AvailablePlan, type BaseEventMetadata, type BillingInfo, type FreeTrialInfo, FreeTrialPeriod, type FreeTrialPeriodWithLiterals, FreeTrialStatus, type FreeTrialStatusWithLiterals, type GetAppInstanceByInstanceIdRequest, type GetAppInstanceRequest, type GetAppInstanceResponse, type GetComparatorFromFetchersRequest, type GetComparatorFromFetchersResponse, type IdentificationData, type IdentificationDataIdOneOf, type Locale, type MessageEnvelope, type Multilingual, type OwnerInfo, type PaidPlanAutoRenewalCancelled, type PaidPlanChanged, type PaidPlanPurchased, PaymentCycle, type PaymentCycleWithLiterals, type PlanConvertedToPaid, type PlanReactivated, type PlanTransferred, ReactivationReason, type ReactivationReasonWithLiterals, ResolutionMethod, type ResolutionMethodWithLiterals, type SiteInfo, type SupportedLanguage, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, getAppInstance, onAppInstanceInstalled, onAppInstancePaidPlanAutoRenewalCancelled, onAppInstancePaidPlanChanged, onAppInstancePaidPlanPurchased, onAppInstancePlanConvertedToPaid, onAppInstancePlanReactivated, onAppInstancePlanTransferred, onAppInstanceRemoved };