@wix/app-management 1.0.44 → 1.0.46

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -29,3 +29,4 @@ exports.appInstances = __importStar(require("@wix/app-management_app-instances/c
29
29
  exports.biEvents = __importStar(require("@wix/app-management_bi-events/context"));
30
30
  exports.billing = __importStar(require("@wix/app-management_billing/context"));
31
31
  exports.embeddedScripts = __importStar(require("@wix/app-management_embedded-scripts/context"));
32
+ //# sourceMappingURL=context.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"context.js","sourceRoot":"","sources":["../../context.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kFAAkE;AAClE,0FAA0E;AAC1E,kFAAkE;AAClE,+EAA+D;AAC/D,gGAAgF"}
@@ -34,3 +34,4 @@ const billing = __importStar(require("@wix/app-management_billing"));
34
34
  exports.billing = billing;
35
35
  const embeddedScripts = __importStar(require("@wix/app-management_embedded-scripts"));
36
36
  exports.embeddedScripts = embeddedScripts;
37
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,wEAA0D;AAMjD,4BAAQ;AALjB,gFAAkE;AAK/C,oCAAY;AAJ/B,wEAA0D;AAIzB,4BAAQ;AAHzC,qEAAuD;AAGZ,0BAAO;AAFlD,sFAAwE;AAEpB,0CAAe"}
package/build/cjs/meta.js CHANGED
@@ -29,3 +29,4 @@ exports.appInstances = __importStar(require("@wix/app-management_app-instances/m
29
29
  exports.biEvents = __importStar(require("@wix/app-management_bi-events/meta"));
30
30
  exports.billing = __importStar(require("@wix/app-management_billing/meta"));
31
31
  exports.embeddedScripts = __importStar(require("@wix/app-management_embedded-scripts/meta"));
32
+ //# sourceMappingURL=meta.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"meta.js","sourceRoot":"","sources":["../../meta.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+EAA+D;AAC/D,uFAAuE;AACvE,+EAA+D;AAC/D,4EAA4D;AAC5D,6FAA6E"}
@@ -25,3 +25,4 @@ var __importStar = (this && this.__importStar) || function (mod) {
25
25
  Object.defineProperty(exports, "__esModule", { value: true });
26
26
  exports.customCharges = void 0;
27
27
  exports.customCharges = __importStar(require("@wix/app-management_custom-charges/context"));
28
+ //# sourceMappingURL=service-plugins-context.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"service-plugins-context.js","sourceRoot":"","sources":["../../service-plugins-context.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4FAA4E"}
@@ -25,3 +25,4 @@ var __importStar = (this && this.__importStar) || function (mod) {
25
25
  Object.defineProperty(exports, "__esModule", { value: true });
26
26
  exports.customCharges = void 0;
27
27
  exports.customCharges = __importStar(require("@wix/app-management_custom-charges"));
28
+ //# sourceMappingURL=service-plugins.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"service-plugins.js","sourceRoot":"","sources":["../../service-plugins.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oFAAoE"}
@@ -3,3 +3,4 @@ export * as appInstances from '@wix/app-management_app-instances/context';
3
3
  export * as biEvents from '@wix/app-management_bi-events/context';
4
4
  export * as billing from '@wix/app-management_billing/context';
5
5
  export * as embeddedScripts from '@wix/app-management_embedded-scripts/context';
6
+ //# sourceMappingURL=context.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"context.js","sourceRoot":"","sources":["../../context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,uCAAuC,CAAC;AAClE,OAAO,KAAK,YAAY,MAAM,2CAA2C,CAAC;AAC1E,OAAO,KAAK,QAAQ,MAAM,uCAAuC,CAAC;AAClE,OAAO,KAAK,OAAO,MAAM,qCAAqC,CAAC;AAC/D,OAAO,KAAK,eAAe,MAAM,8CAA8C,CAAC"}
package/build/es/index.js CHANGED
@@ -4,3 +4,4 @@ import * as biEvents from '@wix/app-management_bi-events';
4
4
  import * as billing from '@wix/app-management_billing';
5
5
  import * as embeddedScripts from '@wix/app-management_embedded-scripts';
6
6
  export { appPlans, appInstances, biEvents, billing, embeddedScripts };
7
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,+BAA+B,CAAC;AAC1D,OAAO,KAAK,YAAY,MAAM,mCAAmC,CAAC;AAClE,OAAO,KAAK,QAAQ,MAAM,+BAA+B,CAAC;AAC1D,OAAO,KAAK,OAAO,MAAM,6BAA6B,CAAC;AACvD,OAAO,KAAK,eAAe,MAAM,sCAAsC,CAAC;AAExE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC"}
package/build/es/meta.js CHANGED
@@ -3,3 +3,4 @@ export * as appInstances from '@wix/app-management_app-instances/meta';
3
3
  export * as biEvents from '@wix/app-management_bi-events/meta';
4
4
  export * as billing from '@wix/app-management_billing/meta';
5
5
  export * as embeddedScripts from '@wix/app-management_embedded-scripts/meta';
6
+ //# sourceMappingURL=meta.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"meta.js","sourceRoot":"","sources":["../../meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,oCAAoC,CAAC;AAC/D,OAAO,KAAK,YAAY,MAAM,wCAAwC,CAAC;AACvE,OAAO,KAAK,QAAQ,MAAM,oCAAoC,CAAC;AAC/D,OAAO,KAAK,OAAO,MAAM,kCAAkC,CAAC;AAC5D,OAAO,KAAK,eAAe,MAAM,2CAA2C,CAAC"}
@@ -1 +1,2 @@
1
1
  export * as customCharges from '@wix/app-management_custom-charges/context';
2
+ //# sourceMappingURL=service-plugins-context.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"service-plugins-context.js","sourceRoot":"","sources":["../../service-plugins-context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,aAAa,MAAM,4CAA4C,CAAC"}
@@ -1 +1,2 @@
1
1
  export * as customCharges from '@wix/app-management_custom-charges';
2
+ //# sourceMappingURL=service-plugins.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"service-plugins.js","sourceRoot":"","sources":["../../service-plugins.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,aAAa,MAAM,oCAAoC,CAAC"}
package/package.json CHANGED
@@ -1,10 +1,13 @@
1
1
  {
2
2
  "name": "@wix/app-management",
3
- "version": "1.0.44",
3
+ "version": "1.0.46",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
7
7
  },
8
+ "keywords": [
9
+ "wix-sdk-module=backend,page,public"
10
+ ],
8
11
  "sideEffects": false,
9
12
  "module": "build/es/index.js",
10
13
  "main": "build/cjs/index.js",
@@ -19,12 +22,12 @@
19
22
  "service-plugins"
20
23
  ],
21
24
  "dependencies": {
22
- "@wix/app-management_app-instances": "1.0.24",
23
- "@wix/app-management_app-plans": "1.0.23",
24
- "@wix/app-management_bi-events": "1.0.22",
25
- "@wix/app-management_billing": "1.0.23",
26
- "@wix/app-management_custom-charges": "1.0.20",
27
- "@wix/app-management_embedded-scripts": "1.0.20"
25
+ "@wix/app-management_app-instances": "1.0.26",
26
+ "@wix/app-management_app-plans": "1.0.24",
27
+ "@wix/app-management_bi-events": "1.0.24",
28
+ "@wix/app-management_billing": "1.0.24",
29
+ "@wix/app-management_custom-charges": "1.0.21",
30
+ "@wix/app-management_embedded-scripts": "1.0.21"
28
31
  },
29
32
  "devDependencies": {
30
33
  "glob": "^10.4.1",
@@ -49,5 +52,5 @@
49
52
  "fqdn": ""
50
53
  }
51
54
  },
52
- "falconPackageHash": "d24e56204132f305ab647a1163fdaa8e8bf399c8be54264a0ad16fb0"
55
+ "falconPackageHash": "6100eefd2bc54e1e714c61fe6dbcf46653a60b849aef0d3947db07f5"
53
56
  }
@@ -614,6 +614,8 @@ interface Price {
614
614
  usageBaseOptions?: UsageBasedDetails;
615
615
  discount?: Discount;
616
616
  billingSource?: BillingSource;
617
+ /** Can be shown instead of plan price - used for dynamic plans */
618
+ customPaymentTitle?: string | null;
617
619
  }
618
620
  interface Plan {
619
621
  /**
@@ -931,12 +933,6 @@ declare enum PaymentCycle$1 {
931
933
  interface FreeTrialInfo {
932
934
  /**
933
935
  * Current free trial status.
934
- *
935
- * Supported values:
936
- *
937
- * - `IN_PROGRESS`: The free trial is currently in progress.
938
- * - `ENDED`: The free trial has ended.
939
- * - `NOT_AVAILABLE`: No free trial was applied, as none was available.
940
936
  * @readonly
941
937
  */
942
938
  status?: FreeTrialStatus;
@@ -947,9 +943,13 @@ interface FreeTrialInfo {
947
943
  endDate?: Date | null;
948
944
  }
949
945
  declare enum FreeTrialStatus {
946
+ /** Unknown trial status. */
950
947
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
948
+ /** The free trial is currently in progress. */
951
949
  IN_PROGRESS = "IN_PROGRESS",
950
+ /** The free trial has ended. */
952
951
  ENDED = "ENDED",
952
+ /** No free trial was applied, as none was available. */
953
953
  NOT_AVAILABLE = "NOT_AVAILABLE"
954
954
  }
955
955
  interface AvailablePlan {
@@ -1210,16 +1210,16 @@ interface AppInstanceRemovedEnvelope {
1210
1210
  data: AppRemoved;
1211
1211
  metadata: BaseEventMetadata;
1212
1212
  }
1213
- interface AppInstancePaidPlanPurchasedEnvelope {
1214
- data: PaidPlanPurchased;
1213
+ interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
1214
+ data: PaidPlanAutoRenewalCancelled;
1215
1215
  metadata: BaseEventMetadata;
1216
1216
  }
1217
1217
  interface AppInstancePaidPlanChangedEnvelope {
1218
1218
  data: PaidPlanChanged;
1219
1219
  metadata: BaseEventMetadata;
1220
1220
  }
1221
- interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
1222
- data: PaidPlanAutoRenewalCancelled;
1221
+ interface AppInstancePaidPlanPurchasedEnvelope {
1222
+ data: PaidPlanPurchased;
1223
1223
  metadata: BaseEventMetadata;
1224
1224
  }
1225
1225
 
@@ -1238,9 +1238,9 @@ interface GetAppInstanceSignature {
1238
1238
  }
1239
1239
  declare const onAppInstanceInstalled$1: EventDefinition<AppInstanceInstalledEnvelope, "AppInstalled">;
1240
1240
  declare const onAppInstanceRemoved$1: EventDefinition<AppInstanceRemovedEnvelope, "AppRemoved">;
1241
- declare const onAppInstancePaidPlanPurchased$1: EventDefinition<AppInstancePaidPlanPurchasedEnvelope, "PaidPlanPurchased">;
1242
- declare const onAppInstancePaidPlanChanged$1: EventDefinition<AppInstancePaidPlanChangedEnvelope, "PaidPlanChanged">;
1243
1241
  declare const onAppInstancePaidPlanAutoRenewalCancelled$1: EventDefinition<AppInstancePaidPlanAutoRenewalCancelledEnvelope, "PaidPlanAutoRenewalCancelled">;
1242
+ declare const onAppInstancePaidPlanChanged$1: EventDefinition<AppInstancePaidPlanChangedEnvelope, "PaidPlanChanged">;
1243
+ declare const onAppInstancePaidPlanPurchased$1: EventDefinition<AppInstancePaidPlanPurchasedEnvelope, "PaidPlanPurchased">;
1244
1244
 
1245
1245
  declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
1246
1246
 
@@ -1258,11 +1258,13 @@ type _publicOnAppInstanceRemovedType = typeof onAppInstanceRemoved$1;
1258
1258
  */
1259
1259
  declare const onAppInstanceRemoved: ReturnType<typeof createEventModule<_publicOnAppInstanceRemovedType>>;
1260
1260
 
1261
- type _publicOnAppInstancePaidPlanPurchasedType = typeof onAppInstancePaidPlanPurchased$1;
1261
+ type _publicOnAppInstancePaidPlanAutoRenewalCancelledType = typeof onAppInstancePaidPlanAutoRenewalCancelled$1;
1262
1262
  /**
1263
- * Triggered when a site owner purchases a paid plan for your app.
1263
+ * Triggered when a site owner cancels a paid plan for your app. The
1264
+ * site owner can continue to use your app until the end of the current billing
1265
+ * cycle.
1264
1266
  */
1265
- declare const onAppInstancePaidPlanPurchased: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanPurchasedType>>;
1267
+ declare const onAppInstancePaidPlanAutoRenewalCancelled: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanAutoRenewalCancelledType>>;
1266
1268
 
1267
1269
  type _publicOnAppInstancePaidPlanChangedType = typeof onAppInstancePaidPlanChanged$1;
1268
1270
  /**
@@ -1270,13 +1272,11 @@ type _publicOnAppInstancePaidPlanChangedType = typeof onAppInstancePaidPlanChang
1270
1272
  */
1271
1273
  declare const onAppInstancePaidPlanChanged: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanChangedType>>;
1272
1274
 
1273
- type _publicOnAppInstancePaidPlanAutoRenewalCancelledType = typeof onAppInstancePaidPlanAutoRenewalCancelled$1;
1275
+ type _publicOnAppInstancePaidPlanPurchasedType = typeof onAppInstancePaidPlanPurchased$1;
1274
1276
  /**
1275
- * Triggered when a site owner cancels a paid plan for your app. The
1276
- * site owner can continue to use your app until the end of the current billing
1277
- * cycle.
1277
+ * Triggered when a site owner purchases a paid plan for your app.
1278
1278
  */
1279
- declare const onAppInstancePaidPlanAutoRenewalCancelled: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanAutoRenewalCancelledType>>;
1279
+ declare const onAppInstancePaidPlanPurchased: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanPurchasedType>>;
1280
1280
 
1281
1281
  type context$3_AppInstalled = AppInstalled;
1282
1282
  type context$3_AppInstance = AppInstance;
@@ -1324,20 +1324,7 @@ declare namespace context$3 {
1324
1324
  interface SendBIEventResponse {
1325
1325
  }
1326
1326
  interface SendBIEventRequest {
1327
- /**
1328
- * Name of the event that's triggered in your app.
1329
- *
1330
- * + `"APP_DASHBOARD_LOADED"`: A site onwer or contributor loads your app's dashboard.
1331
- * + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in your app's dashboard.
1332
- * + `"APP_UPGRADED"`: The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side.
1333
- * + `"PRIMARY_ACTION_PERFORMED"`: A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app.
1334
- * + `"CHARGE"`: You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`.
1335
- * + `"FUNDS_RETURNED"`: Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`.
1336
- * + `"CUSTOM"`: Any event that's not listed here. Make sure to also send `customEventName`.
1337
- * + `"APP_DEPLOYED"`: Your app’s internal code implementation is changed and might affect user flows or cause a regression.
1338
- * + `"APP_FINISH_BUSINESS_SETUP"`: __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead.
1339
- * + `"APP_SETUP_FINISHED"`: The site owner completes your app's required business setup.
1340
- */
1327
+ /** Name of the event that's triggered in your app. */
1341
1328
  eventName?: EventName;
1342
1329
  /**
1343
1330
  * Name of your app's custom event that was triggered. Required when `{"eventName": "CUSTOM"}`.
@@ -1360,33 +1347,31 @@ interface SendBIEventRequest {
1360
1347
  eventData?: Record<string, string>;
1361
1348
  }
1362
1349
  declare enum EventName {
1350
+ /** Unknown event name. */
1363
1351
  UNKNOWN = "UNKNOWN",
1352
+ /** A site owner or contributor loads your app's dashboard. */
1364
1353
  APP_DASHBOARD_LOADED = "APP_DASHBOARD_LOADED",
1354
+ /** The site owner completes all required configurations for your app in your app's dashboard. */
1365
1355
  APP_FINISHED_CONFIGURATION = "APP_FINISHED_CONFIGURATION",
1356
+ /** The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side. */
1366
1357
  APP_UPGRADED = "APP_UPGRADED",
1358
+ /** A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app. */
1367
1359
  PRIMARY_ACTION_PERFORMED = "PRIMARY_ACTION_PERFORMED",
1360
+ /** Any event that's not listed here. Make sure to also send `customEventName`. */
1368
1361
  CUSTOM = "CUSTOM",
1362
+ /** You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`. */
1369
1363
  CHARGE = "CHARGE",
1364
+ /** Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`. */
1370
1365
  FUNDS_RETURNED = "FUNDS_RETURNED",
1366
+ /** __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead. */
1371
1367
  APP_FINISH_BUSINESS_SETUP = "APP_FINISH_BUSINESS_SETUP",
1368
+ /** Your app’s internal code implementation is changed and might affect user flows or cause a regression. */
1372
1369
  APP_DEPLOYED = "APP_DEPLOYED",
1370
+ /** The site owner completes your app's required business setup. */
1373
1371
  APP_SETUP_FINISHED = "APP_SETUP_FINISHED"
1374
1372
  }
1375
1373
  interface SendBiEventOptions {
1376
- /**
1377
- * Name of the event that's triggered in your app.
1378
- *
1379
- * + `"APP_DASHBOARD_LOADED"`: A site onwer or contributor loads your app's dashboard.
1380
- * + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in your app's dashboard.
1381
- * + `"APP_UPGRADED"`: The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side.
1382
- * + `"PRIMARY_ACTION_PERFORMED"`: A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app.
1383
- * + `"CHARGE"`: You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`.
1384
- * + `"FUNDS_RETURNED"`: Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`.
1385
- * + `"CUSTOM"`: Any event that's not listed here. Make sure to also send `customEventName`.
1386
- * + `"APP_DEPLOYED"`: Your app’s internal code implementation is changed and might affect user flows or cause a regression.
1387
- * + `"APP_FINISH_BUSINESS_SETUP"`: __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead.
1388
- * + `"APP_SETUP_FINISHED"`: The site owner completes your app's required business setup.
1389
- */
1374
+ /** Name of the event that's triggered in your app. */
1390
1375
  eventName?: EventName;
1391
1376
  /**
1392
1377
  * Name of your app's custom event that was triggered. Required when `{"eventName": "CUSTOM"}`.
@@ -614,6 +614,8 @@ interface Price {
614
614
  usageBaseOptions?: UsageBasedDetails;
615
615
  discount?: Discount;
616
616
  billingSource?: BillingSource;
617
+ /** Can be shown instead of plan price - used for dynamic plans */
618
+ customPaymentTitle?: string | null;
617
619
  }
618
620
  interface Plan {
619
621
  /**
@@ -931,12 +933,6 @@ declare enum PaymentCycle$1 {
931
933
  interface FreeTrialInfo {
932
934
  /**
933
935
  * Current free trial status.
934
- *
935
- * Supported values:
936
- *
937
- * - `IN_PROGRESS`: The free trial is currently in progress.
938
- * - `ENDED`: The free trial has ended.
939
- * - `NOT_AVAILABLE`: No free trial was applied, as none was available.
940
936
  * @readonly
941
937
  */
942
938
  status?: FreeTrialStatus;
@@ -947,9 +943,13 @@ interface FreeTrialInfo {
947
943
  endDate?: Date | null;
948
944
  }
949
945
  declare enum FreeTrialStatus {
946
+ /** Unknown trial status. */
950
947
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
948
+ /** The free trial is currently in progress. */
951
949
  IN_PROGRESS = "IN_PROGRESS",
950
+ /** The free trial has ended. */
952
951
  ENDED = "ENDED",
952
+ /** No free trial was applied, as none was available. */
953
953
  NOT_AVAILABLE = "NOT_AVAILABLE"
954
954
  }
955
955
  interface AvailablePlan {
@@ -1210,16 +1210,16 @@ interface AppInstanceRemovedEnvelope {
1210
1210
  data: AppRemoved;
1211
1211
  metadata: BaseEventMetadata;
1212
1212
  }
1213
- interface AppInstancePaidPlanPurchasedEnvelope {
1214
- data: PaidPlanPurchased;
1213
+ interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
1214
+ data: PaidPlanAutoRenewalCancelled;
1215
1215
  metadata: BaseEventMetadata;
1216
1216
  }
1217
1217
  interface AppInstancePaidPlanChangedEnvelope {
1218
1218
  data: PaidPlanChanged;
1219
1219
  metadata: BaseEventMetadata;
1220
1220
  }
1221
- interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
1222
- data: PaidPlanAutoRenewalCancelled;
1221
+ interface AppInstancePaidPlanPurchasedEnvelope {
1222
+ data: PaidPlanPurchased;
1223
1223
  metadata: BaseEventMetadata;
1224
1224
  }
1225
1225
 
@@ -1238,9 +1238,9 @@ interface GetAppInstanceSignature {
1238
1238
  }
1239
1239
  declare const onAppInstanceInstalled$1: EventDefinition<AppInstanceInstalledEnvelope, "AppInstalled">;
1240
1240
  declare const onAppInstanceRemoved$1: EventDefinition<AppInstanceRemovedEnvelope, "AppRemoved">;
1241
- declare const onAppInstancePaidPlanPurchased$1: EventDefinition<AppInstancePaidPlanPurchasedEnvelope, "PaidPlanPurchased">;
1242
- declare const onAppInstancePaidPlanChanged$1: EventDefinition<AppInstancePaidPlanChangedEnvelope, "PaidPlanChanged">;
1243
1241
  declare const onAppInstancePaidPlanAutoRenewalCancelled$1: EventDefinition<AppInstancePaidPlanAutoRenewalCancelledEnvelope, "PaidPlanAutoRenewalCancelled">;
1242
+ declare const onAppInstancePaidPlanChanged$1: EventDefinition<AppInstancePaidPlanChangedEnvelope, "PaidPlanChanged">;
1243
+ declare const onAppInstancePaidPlanPurchased$1: EventDefinition<AppInstancePaidPlanPurchasedEnvelope, "PaidPlanPurchased">;
1244
1244
 
1245
1245
  declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
1246
1246
 
@@ -1258,11 +1258,13 @@ type _publicOnAppInstanceRemovedType = typeof onAppInstanceRemoved$1;
1258
1258
  */
1259
1259
  declare const onAppInstanceRemoved: ReturnType<typeof createEventModule<_publicOnAppInstanceRemovedType>>;
1260
1260
 
1261
- type _publicOnAppInstancePaidPlanPurchasedType = typeof onAppInstancePaidPlanPurchased$1;
1261
+ type _publicOnAppInstancePaidPlanAutoRenewalCancelledType = typeof onAppInstancePaidPlanAutoRenewalCancelled$1;
1262
1262
  /**
1263
- * Triggered when a site owner purchases a paid plan for your app.
1263
+ * Triggered when a site owner cancels a paid plan for your app. The
1264
+ * site owner can continue to use your app until the end of the current billing
1265
+ * cycle.
1264
1266
  */
1265
- declare const onAppInstancePaidPlanPurchased: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanPurchasedType>>;
1267
+ declare const onAppInstancePaidPlanAutoRenewalCancelled: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanAutoRenewalCancelledType>>;
1266
1268
 
1267
1269
  type _publicOnAppInstancePaidPlanChangedType = typeof onAppInstancePaidPlanChanged$1;
1268
1270
  /**
@@ -1270,13 +1272,11 @@ type _publicOnAppInstancePaidPlanChangedType = typeof onAppInstancePaidPlanChang
1270
1272
  */
1271
1273
  declare const onAppInstancePaidPlanChanged: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanChangedType>>;
1272
1274
 
1273
- type _publicOnAppInstancePaidPlanAutoRenewalCancelledType = typeof onAppInstancePaidPlanAutoRenewalCancelled$1;
1275
+ type _publicOnAppInstancePaidPlanPurchasedType = typeof onAppInstancePaidPlanPurchased$1;
1274
1276
  /**
1275
- * Triggered when a site owner cancels a paid plan for your app. The
1276
- * site owner can continue to use your app until the end of the current billing
1277
- * cycle.
1277
+ * Triggered when a site owner purchases a paid plan for your app.
1278
1278
  */
1279
- declare const onAppInstancePaidPlanAutoRenewalCancelled: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanAutoRenewalCancelledType>>;
1279
+ declare const onAppInstancePaidPlanPurchased: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanPurchasedType>>;
1280
1280
 
1281
1281
  type index_d$3_AppInstalled = AppInstalled;
1282
1282
  type index_d$3_AppInstance = AppInstance;
@@ -1324,20 +1324,7 @@ declare namespace index_d$3 {
1324
1324
  interface SendBIEventResponse {
1325
1325
  }
1326
1326
  interface SendBIEventRequest {
1327
- /**
1328
- * Name of the event that's triggered in your app.
1329
- *
1330
- * + `"APP_DASHBOARD_LOADED"`: A site onwer or contributor loads your app's dashboard.
1331
- * + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in your app's dashboard.
1332
- * + `"APP_UPGRADED"`: The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side.
1333
- * + `"PRIMARY_ACTION_PERFORMED"`: A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app.
1334
- * + `"CHARGE"`: You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`.
1335
- * + `"FUNDS_RETURNED"`: Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`.
1336
- * + `"CUSTOM"`: Any event that's not listed here. Make sure to also send `customEventName`.
1337
- * + `"APP_DEPLOYED"`: Your app’s internal code implementation is changed and might affect user flows or cause a regression.
1338
- * + `"APP_FINISH_BUSINESS_SETUP"`: __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead.
1339
- * + `"APP_SETUP_FINISHED"`: The site owner completes your app's required business setup.
1340
- */
1327
+ /** Name of the event that's triggered in your app. */
1341
1328
  eventName?: EventName;
1342
1329
  /**
1343
1330
  * Name of your app's custom event that was triggered. Required when `{"eventName": "CUSTOM"}`.
@@ -1360,33 +1347,31 @@ interface SendBIEventRequest {
1360
1347
  eventData?: Record<string, string>;
1361
1348
  }
1362
1349
  declare enum EventName {
1350
+ /** Unknown event name. */
1363
1351
  UNKNOWN = "UNKNOWN",
1352
+ /** A site owner or contributor loads your app's dashboard. */
1364
1353
  APP_DASHBOARD_LOADED = "APP_DASHBOARD_LOADED",
1354
+ /** The site owner completes all required configurations for your app in your app's dashboard. */
1365
1355
  APP_FINISHED_CONFIGURATION = "APP_FINISHED_CONFIGURATION",
1356
+ /** The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side. */
1366
1357
  APP_UPGRADED = "APP_UPGRADED",
1358
+ /** A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app. */
1367
1359
  PRIMARY_ACTION_PERFORMED = "PRIMARY_ACTION_PERFORMED",
1360
+ /** Any event that's not listed here. Make sure to also send `customEventName`. */
1368
1361
  CUSTOM = "CUSTOM",
1362
+ /** You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`. */
1369
1363
  CHARGE = "CHARGE",
1364
+ /** Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`. */
1370
1365
  FUNDS_RETURNED = "FUNDS_RETURNED",
1366
+ /** __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead. */
1371
1367
  APP_FINISH_BUSINESS_SETUP = "APP_FINISH_BUSINESS_SETUP",
1368
+ /** Your app’s internal code implementation is changed and might affect user flows or cause a regression. */
1372
1369
  APP_DEPLOYED = "APP_DEPLOYED",
1370
+ /** The site owner completes your app's required business setup. */
1373
1371
  APP_SETUP_FINISHED = "APP_SETUP_FINISHED"
1374
1372
  }
1375
1373
  interface SendBiEventOptions {
1376
- /**
1377
- * Name of the event that's triggered in your app.
1378
- *
1379
- * + `"APP_DASHBOARD_LOADED"`: A site onwer or contributor loads your app's dashboard.
1380
- * + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in your app's dashboard.
1381
- * + `"APP_UPGRADED"`: The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side.
1382
- * + `"PRIMARY_ACTION_PERFORMED"`: A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app.
1383
- * + `"CHARGE"`: You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`.
1384
- * + `"FUNDS_RETURNED"`: Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`.
1385
- * + `"CUSTOM"`: Any event that's not listed here. Make sure to also send `customEventName`.
1386
- * + `"APP_DEPLOYED"`: Your app’s internal code implementation is changed and might affect user flows or cause a regression.
1387
- * + `"APP_FINISH_BUSINESS_SETUP"`: __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead.
1388
- * + `"APP_SETUP_FINISHED"`: The site owner completes your app's required business setup.
1389
- */
1374
+ /** Name of the event that's triggered in your app. */
1390
1375
  eventName?: EventName;
1391
1376
  /**
1392
1377
  * Name of your app's custom event that was triggered. Required when `{"eventName": "CUSTOM"}`.
@@ -136,6 +136,8 @@ interface Price$1 {
136
136
  usageBaseOptions?: UsageBasedDetails$1;
137
137
  discount?: Discount$1;
138
138
  billingSource?: BillingSource$1;
139
+ /** Can be shown instead of plan price - used for dynamic plans */
140
+ customPaymentTitle?: string | null;
139
141
  }
140
142
  interface Plan$1 {
141
143
  /**
@@ -418,6 +420,8 @@ interface Price {
418
420
  usageBaseOptions?: UsageBasedDetails;
419
421
  discount?: Discount;
420
422
  billingSource?: BillingSource;
423
+ /** Can be shown instead of plan price - used for dynamic plans */
424
+ customPaymentTitle?: string | null;
421
425
  }
422
426
  interface Plan {
423
427
  /**
@@ -690,12 +694,6 @@ declare enum PaymentCycle$3 {
690
694
  interface FreeTrialInfo$1 {
691
695
  /**
692
696
  * Current free trial status.
693
- *
694
- * Supported values:
695
- *
696
- * - `IN_PROGRESS`: The free trial is currently in progress.
697
- * - `ENDED`: The free trial has ended.
698
- * - `NOT_AVAILABLE`: No free trial was applied, as none was available.
699
697
  * @readonly
700
698
  */
701
699
  status?: FreeTrialStatus$1;
@@ -706,9 +704,13 @@ interface FreeTrialInfo$1 {
706
704
  endDate?: Date | null;
707
705
  }
708
706
  declare enum FreeTrialStatus$1 {
707
+ /** Unknown trial status. */
709
708
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
709
+ /** The free trial is currently in progress. */
710
710
  IN_PROGRESS = "IN_PROGRESS",
711
+ /** The free trial has ended. */
711
712
  ENDED = "ENDED",
713
+ /** No free trial was applied, as none was available. */
712
714
  NOT_AVAILABLE = "NOT_AVAILABLE"
713
715
  }
714
716
  interface AvailablePlan$1 {
@@ -965,12 +967,6 @@ declare enum PaymentCycle$2 {
965
967
  interface FreeTrialInfo {
966
968
  /**
967
969
  * Current free trial status.
968
- *
969
- * Supported values:
970
- *
971
- * - `IN_PROGRESS`: The free trial is currently in progress.
972
- * - `ENDED`: The free trial has ended.
973
- * - `NOT_AVAILABLE`: No free trial was applied, as none was available.
974
970
  * @readonly
975
971
  */
976
972
  status?: FreeTrialStatus;
@@ -981,9 +977,13 @@ interface FreeTrialInfo {
981
977
  endDate?: Date | null;
982
978
  }
983
979
  declare enum FreeTrialStatus {
980
+ /** Unknown trial status. */
984
981
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
982
+ /** The free trial is currently in progress. */
985
983
  IN_PROGRESS = "IN_PROGRESS",
984
+ /** The free trial has ended. */
986
985
  ENDED = "ENDED",
986
+ /** No free trial was applied, as none was available. */
987
987
  NOT_AVAILABLE = "NOT_AVAILABLE"
988
988
  }
989
989
  interface AvailablePlan {
@@ -1151,20 +1151,7 @@ declare namespace meta$3 {
1151
1151
  interface SendBIEventResponse$1 {
1152
1152
  }
1153
1153
  interface SendBIEventRequest$1 {
1154
- /**
1155
- * Name of the event that's triggered in your app.
1156
- *
1157
- * + `"APP_DASHBOARD_LOADED"`: A site onwer or contributor loads your app's dashboard.
1158
- * + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in your app's dashboard.
1159
- * + `"APP_UPGRADED"`: The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side.
1160
- * + `"PRIMARY_ACTION_PERFORMED"`: A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app.
1161
- * + `"CHARGE"`: You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`.
1162
- * + `"FUNDS_RETURNED"`: Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`.
1163
- * + `"CUSTOM"`: Any event that's not listed here. Make sure to also send `customEventName`.
1164
- * + `"APP_DEPLOYED"`: Your app’s internal code implementation is changed and might affect user flows or cause a regression.
1165
- * + `"APP_FINISH_BUSINESS_SETUP"`: __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead.
1166
- * + `"APP_SETUP_FINISHED"`: The site owner completes your app's required business setup.
1167
- */
1154
+ /** Name of the event that's triggered in your app. */
1168
1155
  eventName?: EventName$1;
1169
1156
  /**
1170
1157
  * Name of your app's custom event that was triggered. Required when `{"eventName": "CUSTOM"}`.
@@ -1187,36 +1174,34 @@ interface SendBIEventRequest$1 {
1187
1174
  eventData?: Record<string, string>;
1188
1175
  }
1189
1176
  declare enum EventName$1 {
1177
+ /** Unknown event name. */
1190
1178
  UNKNOWN = "UNKNOWN",
1179
+ /** A site owner or contributor loads your app's dashboard. */
1191
1180
  APP_DASHBOARD_LOADED = "APP_DASHBOARD_LOADED",
1181
+ /** The site owner completes all required configurations for your app in your app's dashboard. */
1192
1182
  APP_FINISHED_CONFIGURATION = "APP_FINISHED_CONFIGURATION",
1183
+ /** The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side. */
1193
1184
  APP_UPGRADED = "APP_UPGRADED",
1185
+ /** A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app. */
1194
1186
  PRIMARY_ACTION_PERFORMED = "PRIMARY_ACTION_PERFORMED",
1187
+ /** Any event that's not listed here. Make sure to also send `customEventName`. */
1195
1188
  CUSTOM = "CUSTOM",
1189
+ /** You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`. */
1196
1190
  CHARGE = "CHARGE",
1191
+ /** Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`. */
1197
1192
  FUNDS_RETURNED = "FUNDS_RETURNED",
1193
+ /** __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead. */
1198
1194
  APP_FINISH_BUSINESS_SETUP = "APP_FINISH_BUSINESS_SETUP",
1195
+ /** Your app’s internal code implementation is changed and might affect user flows or cause a regression. */
1199
1196
  APP_DEPLOYED = "APP_DEPLOYED",
1197
+ /** The site owner completes your app's required business setup. */
1200
1198
  APP_SETUP_FINISHED = "APP_SETUP_FINISHED"
1201
1199
  }
1202
1200
 
1203
1201
  interface SendBIEventResponse {
1204
1202
  }
1205
1203
  interface SendBIEventRequest {
1206
- /**
1207
- * Name of the event that's triggered in your app.
1208
- *
1209
- * + `"APP_DASHBOARD_LOADED"`: A site onwer or contributor loads your app's dashboard.
1210
- * + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in your app's dashboard.
1211
- * + `"APP_UPGRADED"`: The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side.
1212
- * + `"PRIMARY_ACTION_PERFORMED"`: A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app.
1213
- * + `"CHARGE"`: You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`.
1214
- * + `"FUNDS_RETURNED"`: Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`.
1215
- * + `"CUSTOM"`: Any event that's not listed here. Make sure to also send `customEventName`.
1216
- * + `"APP_DEPLOYED"`: Your app’s internal code implementation is changed and might affect user flows or cause a regression.
1217
- * + `"APP_FINISH_BUSINESS_SETUP"`: __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead.
1218
- * + `"APP_SETUP_FINISHED"`: The site owner completes your app's required business setup.
1219
- */
1204
+ /** Name of the event that's triggered in your app. */
1220
1205
  eventName?: EventName;
1221
1206
  /**
1222
1207
  * Name of your app's custom event that was triggered. Required when `{"eventName": "CUSTOM"}`.
@@ -1239,16 +1224,27 @@ interface SendBIEventRequest {
1239
1224
  eventData?: Record<string, string>;
1240
1225
  }
1241
1226
  declare enum EventName {
1227
+ /** Unknown event name. */
1242
1228
  UNKNOWN = "UNKNOWN",
1229
+ /** A site owner or contributor loads your app's dashboard. */
1243
1230
  APP_DASHBOARD_LOADED = "APP_DASHBOARD_LOADED",
1231
+ /** The site owner completes all required configurations for your app in your app's dashboard. */
1244
1232
  APP_FINISHED_CONFIGURATION = "APP_FINISHED_CONFIGURATION",
1233
+ /** The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side. */
1245
1234
  APP_UPGRADED = "APP_UPGRADED",
1235
+ /** A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app. */
1246
1236
  PRIMARY_ACTION_PERFORMED = "PRIMARY_ACTION_PERFORMED",
1237
+ /** Any event that's not listed here. Make sure to also send `customEventName`. */
1247
1238
  CUSTOM = "CUSTOM",
1239
+ /** You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`. */
1248
1240
  CHARGE = "CHARGE",
1241
+ /** Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`. */
1249
1242
  FUNDS_RETURNED = "FUNDS_RETURNED",
1243
+ /** __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead. */
1250
1244
  APP_FINISH_BUSINESS_SETUP = "APP_FINISH_BUSINESS_SETUP",
1245
+ /** Your app’s internal code implementation is changed and might affect user flows or cause a regression. */
1251
1246
  APP_DEPLOYED = "APP_DEPLOYED",
1247
+ /** The site owner completes your app's required business setup. */
1252
1248
  APP_SETUP_FINISHED = "APP_SETUP_FINISHED"
1253
1249
  }
1254
1250