@wix/app-management 1.0.34 → 1.0.36
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/app-management",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.36",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -19,11 +19,11 @@
|
|
|
19
19
|
"service-plugins"
|
|
20
20
|
],
|
|
21
21
|
"dependencies": {
|
|
22
|
-
"@wix/app-management_app-instances": "1.0.
|
|
22
|
+
"@wix/app-management_app-instances": "1.0.20",
|
|
23
23
|
"@wix/app-management_app-plans": "1.0.19",
|
|
24
|
-
"@wix/app-management_bi-events": "1.0.
|
|
25
|
-
"@wix/app-management_billing": "1.0.
|
|
26
|
-
"@wix/app-management_custom-charges": "1.0.
|
|
24
|
+
"@wix/app-management_bi-events": "1.0.18",
|
|
25
|
+
"@wix/app-management_billing": "1.0.19",
|
|
26
|
+
"@wix/app-management_custom-charges": "1.0.16",
|
|
27
27
|
"@wix/app-management_embedded-scripts": "1.0.15"
|
|
28
28
|
},
|
|
29
29
|
"devDependencies": {
|
|
@@ -49,5 +49,5 @@
|
|
|
49
49
|
"fqdn": ""
|
|
50
50
|
}
|
|
51
51
|
},
|
|
52
|
-
"falconPackageHash": "
|
|
52
|
+
"falconPackageHash": "4f49ab71a49994f41062887b3c4025e3cbd51a8551b4608ef9d21890"
|
|
53
53
|
}
|
|
@@ -380,14 +380,11 @@ interface AppInstance {
|
|
|
380
380
|
*/
|
|
381
381
|
instanceId?: string;
|
|
382
382
|
/**
|
|
383
|
-
* App name, as set by you in the
|
|
383
|
+
* App name, as set by you in the Customs Apps page during the app creation
|
|
384
384
|
* process.
|
|
385
385
|
*/
|
|
386
386
|
appName?: string;
|
|
387
|
-
/**
|
|
388
|
-
* Version of your app that's installed on the Wix site, as set by you in the
|
|
389
|
-
* Wix Developers Center during the app creation process.
|
|
390
|
-
*/
|
|
387
|
+
/** Version of your app that's installed on the Wix site, as set by you during the app creation process. */
|
|
391
388
|
appVersion?: string | null;
|
|
392
389
|
/**
|
|
393
390
|
* Whether the site owners have installed a free or paid version of your app
|
|
@@ -402,7 +399,7 @@ interface AppInstance {
|
|
|
402
399
|
/**
|
|
403
400
|
* List of [permissions](https://dev.wix.com/docs/build-apps/developer-tools/developers-center/example-app-walkthrough/build-an-app#4-add-permissions)
|
|
404
401
|
* that the site owners have granted your app. You set the list of permissions that
|
|
405
|
-
* your app requires from the site owners in
|
|
402
|
+
* your app requires from the site owners in your app's Permissions page during the
|
|
406
403
|
* app creation process.
|
|
407
404
|
*/
|
|
408
405
|
permissions?: string[];
|
|
@@ -875,7 +872,7 @@ interface SendBIEventRequest {
|
|
|
875
872
|
* Name of the event that's triggered in your app.
|
|
876
873
|
*
|
|
877
874
|
* + `"APP_DASHBOARD_LOADED"`: A site onwer or contributor loads your app's dashboard.
|
|
878
|
-
* + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in
|
|
875
|
+
* + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in your app's dashboard.
|
|
879
876
|
* + `"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.
|
|
880
877
|
* + `"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.
|
|
881
878
|
* + `"CHARGE"`: You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`.
|
|
@@ -902,7 +899,7 @@ interface SendBIEventRequest {
|
|
|
902
899
|
* + `"currency"`: 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
903
900
|
* + `"sum"`: Amount of money. Required for `{"eventName": "CHARGE"}` and `{"eventName": "FUNDS_RETURNED"}`.
|
|
904
901
|
* + `"reason"`: Information about why the event was triggered in your app.
|
|
905
|
-
* + `"app_plan_id"`: ID of the your app's plan as displayed in
|
|
902
|
+
* + `"app_plan_id"`: ID of the your app's plan as displayed in your app's dashboard. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
|
|
906
903
|
*/
|
|
907
904
|
eventData?: Record<string, string>;
|
|
908
905
|
}
|
|
@@ -924,7 +921,7 @@ interface SendBiEventOptions {
|
|
|
924
921
|
* Name of the event that's triggered in your app.
|
|
925
922
|
*
|
|
926
923
|
* + `"APP_DASHBOARD_LOADED"`: A site onwer or contributor loads your app's dashboard.
|
|
927
|
-
* + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in
|
|
924
|
+
* + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in your app's dashboard.
|
|
928
925
|
* + `"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.
|
|
929
926
|
* + `"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.
|
|
930
927
|
* + `"CHARGE"`: You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`.
|
|
@@ -951,7 +948,7 @@ interface SendBiEventOptions {
|
|
|
951
948
|
* + `"currency"`: 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
952
949
|
* + `"sum"`: Amount of money. Required for `{"eventName": "CHARGE"}` and `{"eventName": "FUNDS_RETURNED"}`.
|
|
953
950
|
* + `"reason"`: Information about why the event was triggered in your app.
|
|
954
|
-
* + `"app_plan_id"`: ID of the your app's plan as displayed in
|
|
951
|
+
* + `"app_plan_id"`: ID of the your app's plan as displayed in your app's dashboard. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
|
|
955
952
|
*/
|
|
956
953
|
eventData?: Record<string, string>;
|
|
957
954
|
}
|
|
@@ -1024,8 +1021,8 @@ declare enum InvoiceStatus {
|
|
|
1024
1021
|
}
|
|
1025
1022
|
interface GetUrlRequest {
|
|
1026
1023
|
/**
|
|
1027
|
-
* ID of your app's paid plan to retrieve the Wix checkout URL for. Check
|
|
1028
|
-
*
|
|
1024
|
+
* ID of your app's paid plan to retrieve the Wix checkout URL for. Check your app's dashboard
|
|
1025
|
+
* for a list of your app's supported product IDs.
|
|
1029
1026
|
*/
|
|
1030
1027
|
productId: string;
|
|
1031
1028
|
/**
|
|
@@ -1062,8 +1059,7 @@ interface GetUrlRequest {
|
|
|
1062
1059
|
interface ChargeOverride {
|
|
1063
1060
|
/**
|
|
1064
1061
|
* Override price. In case you omit the override price, Wix charges site
|
|
1065
|
-
* owners the app's default price that's configured in the
|
|
1066
|
-
* Center.
|
|
1062
|
+
* owners the app's default price that's configured in the Pricing page of your app's dashboard.
|
|
1067
1063
|
*/
|
|
1068
1064
|
price?: number;
|
|
1069
1065
|
/**
|
|
@@ -1236,14 +1232,14 @@ interface GetUrlSignature {
|
|
|
1236
1232
|
*
|
|
1237
1233
|
*
|
|
1238
1234
|
* This call succeeds only in case you have previously
|
|
1239
|
-
* [set up an external pricing page in
|
|
1235
|
+
* [set up an external pricing page in your app's dashboard](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-an-external-pricing-page).
|
|
1240
1236
|
*
|
|
1241
1237
|
* The returned checkout URL is valid for 48 hours.
|
|
1242
1238
|
*
|
|
1243
1239
|
* This API allows your app to manage your pricing page outside of Wix while
|
|
1244
1240
|
* still using the standard Wix checkout flow.
|
|
1245
|
-
* @param - ID of your app's paid plan to retrieve the Wix checkout URL for. Check
|
|
1246
|
-
*
|
|
1241
|
+
* @param - ID of your app's paid plan to retrieve the Wix checkout URL for. Check your app's dashboard
|
|
1242
|
+
* for a list of your app's supported product IDs.
|
|
1247
1243
|
*/
|
|
1248
1244
|
(productId: string, options?: GetUrlOptions | undefined): Promise<GetUrlResponse & GetUrlResponseNonNullableFields>;
|
|
1249
1245
|
}
|
|
@@ -380,14 +380,11 @@ interface AppInstance {
|
|
|
380
380
|
*/
|
|
381
381
|
instanceId?: string;
|
|
382
382
|
/**
|
|
383
|
-
* App name, as set by you in the
|
|
383
|
+
* App name, as set by you in the Customs Apps page during the app creation
|
|
384
384
|
* process.
|
|
385
385
|
*/
|
|
386
386
|
appName?: string;
|
|
387
|
-
/**
|
|
388
|
-
* Version of your app that's installed on the Wix site, as set by you in the
|
|
389
|
-
* Wix Developers Center during the app creation process.
|
|
390
|
-
*/
|
|
387
|
+
/** Version of your app that's installed on the Wix site, as set by you during the app creation process. */
|
|
391
388
|
appVersion?: string | null;
|
|
392
389
|
/**
|
|
393
390
|
* Whether the site owners have installed a free or paid version of your app
|
|
@@ -402,7 +399,7 @@ interface AppInstance {
|
|
|
402
399
|
/**
|
|
403
400
|
* List of [permissions](https://dev.wix.com/docs/build-apps/developer-tools/developers-center/example-app-walkthrough/build-an-app#4-add-permissions)
|
|
404
401
|
* that the site owners have granted your app. You set the list of permissions that
|
|
405
|
-
* your app requires from the site owners in
|
|
402
|
+
* your app requires from the site owners in your app's Permissions page during the
|
|
406
403
|
* app creation process.
|
|
407
404
|
*/
|
|
408
405
|
permissions?: string[];
|
|
@@ -875,7 +872,7 @@ interface SendBIEventRequest {
|
|
|
875
872
|
* Name of the event that's triggered in your app.
|
|
876
873
|
*
|
|
877
874
|
* + `"APP_DASHBOARD_LOADED"`: A site onwer or contributor loads your app's dashboard.
|
|
878
|
-
* + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in
|
|
875
|
+
* + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in your app's dashboard.
|
|
879
876
|
* + `"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.
|
|
880
877
|
* + `"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.
|
|
881
878
|
* + `"CHARGE"`: You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`.
|
|
@@ -902,7 +899,7 @@ interface SendBIEventRequest {
|
|
|
902
899
|
* + `"currency"`: 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
903
900
|
* + `"sum"`: Amount of money. Required for `{"eventName": "CHARGE"}` and `{"eventName": "FUNDS_RETURNED"}`.
|
|
904
901
|
* + `"reason"`: Information about why the event was triggered in your app.
|
|
905
|
-
* + `"app_plan_id"`: ID of the your app's plan as displayed in
|
|
902
|
+
* + `"app_plan_id"`: ID of the your app's plan as displayed in your app's dashboard. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
|
|
906
903
|
*/
|
|
907
904
|
eventData?: Record<string, string>;
|
|
908
905
|
}
|
|
@@ -924,7 +921,7 @@ interface SendBiEventOptions {
|
|
|
924
921
|
* Name of the event that's triggered in your app.
|
|
925
922
|
*
|
|
926
923
|
* + `"APP_DASHBOARD_LOADED"`: A site onwer or contributor loads your app's dashboard.
|
|
927
|
-
* + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in
|
|
924
|
+
* + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in your app's dashboard.
|
|
928
925
|
* + `"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.
|
|
929
926
|
* + `"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.
|
|
930
927
|
* + `"CHARGE"`: You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`.
|
|
@@ -951,7 +948,7 @@ interface SendBiEventOptions {
|
|
|
951
948
|
* + `"currency"`: 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
952
949
|
* + `"sum"`: Amount of money. Required for `{"eventName": "CHARGE"}` and `{"eventName": "FUNDS_RETURNED"}`.
|
|
953
950
|
* + `"reason"`: Information about why the event was triggered in your app.
|
|
954
|
-
* + `"app_plan_id"`: ID of the your app's plan as displayed in
|
|
951
|
+
* + `"app_plan_id"`: ID of the your app's plan as displayed in your app's dashboard. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
|
|
955
952
|
*/
|
|
956
953
|
eventData?: Record<string, string>;
|
|
957
954
|
}
|
|
@@ -1024,8 +1021,8 @@ declare enum InvoiceStatus {
|
|
|
1024
1021
|
}
|
|
1025
1022
|
interface GetUrlRequest {
|
|
1026
1023
|
/**
|
|
1027
|
-
* ID of your app's paid plan to retrieve the Wix checkout URL for. Check
|
|
1028
|
-
*
|
|
1024
|
+
* ID of your app's paid plan to retrieve the Wix checkout URL for. Check your app's dashboard
|
|
1025
|
+
* for a list of your app's supported product IDs.
|
|
1029
1026
|
*/
|
|
1030
1027
|
productId: string;
|
|
1031
1028
|
/**
|
|
@@ -1062,8 +1059,7 @@ interface GetUrlRequest {
|
|
|
1062
1059
|
interface ChargeOverride {
|
|
1063
1060
|
/**
|
|
1064
1061
|
* Override price. In case you omit the override price, Wix charges site
|
|
1065
|
-
* owners the app's default price that's configured in the
|
|
1066
|
-
* Center.
|
|
1062
|
+
* owners the app's default price that's configured in the Pricing page of your app's dashboard.
|
|
1067
1063
|
*/
|
|
1068
1064
|
price?: number;
|
|
1069
1065
|
/**
|
|
@@ -1236,14 +1232,14 @@ interface GetUrlSignature {
|
|
|
1236
1232
|
*
|
|
1237
1233
|
*
|
|
1238
1234
|
* This call succeeds only in case you have previously
|
|
1239
|
-
* [set up an external pricing page in
|
|
1235
|
+
* [set up an external pricing page in your app's dashboard](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-an-external-pricing-page).
|
|
1240
1236
|
*
|
|
1241
1237
|
* The returned checkout URL is valid for 48 hours.
|
|
1242
1238
|
*
|
|
1243
1239
|
* This API allows your app to manage your pricing page outside of Wix while
|
|
1244
1240
|
* still using the standard Wix checkout flow.
|
|
1245
|
-
* @param - ID of your app's paid plan to retrieve the Wix checkout URL for. Check
|
|
1246
|
-
*
|
|
1241
|
+
* @param - ID of your app's paid plan to retrieve the Wix checkout URL for. Check your app's dashboard
|
|
1242
|
+
* for a list of your app's supported product IDs.
|
|
1247
1243
|
*/
|
|
1248
1244
|
(productId: string, options?: GetUrlOptions | undefined): Promise<GetUrlResponse & GetUrlResponseNonNullableFields>;
|
|
1249
1245
|
}
|
|
@@ -559,14 +559,11 @@ interface AppInstance$1 {
|
|
|
559
559
|
*/
|
|
560
560
|
instanceId?: string;
|
|
561
561
|
/**
|
|
562
|
-
* App name, as set by you in the
|
|
562
|
+
* App name, as set by you in the Customs Apps page during the app creation
|
|
563
563
|
* process.
|
|
564
564
|
*/
|
|
565
565
|
appName?: string;
|
|
566
|
-
/**
|
|
567
|
-
* Version of your app that's installed on the Wix site, as set by you in the
|
|
568
|
-
* Wix Developers Center during the app creation process.
|
|
569
|
-
*/
|
|
566
|
+
/** Version of your app that's installed on the Wix site, as set by you during the app creation process. */
|
|
570
567
|
appVersion?: string | null;
|
|
571
568
|
/**
|
|
572
569
|
* Whether the site owners have installed a free or paid version of your app
|
|
@@ -581,7 +578,7 @@ interface AppInstance$1 {
|
|
|
581
578
|
/**
|
|
582
579
|
* List of [permissions](https://dev.wix.com/docs/build-apps/developer-tools/developers-center/example-app-walkthrough/build-an-app#4-add-permissions)
|
|
583
580
|
* that the site owners have granted your app. You set the list of permissions that
|
|
584
|
-
* your app requires from the site owners in
|
|
581
|
+
* your app requires from the site owners in your app's Permissions page during the
|
|
585
582
|
* app creation process.
|
|
586
583
|
*/
|
|
587
584
|
permissions?: string[];
|
|
@@ -837,14 +834,11 @@ interface AppInstance {
|
|
|
837
834
|
*/
|
|
838
835
|
instanceId?: string;
|
|
839
836
|
/**
|
|
840
|
-
* App name, as set by you in the
|
|
837
|
+
* App name, as set by you in the Customs Apps page during the app creation
|
|
841
838
|
* process.
|
|
842
839
|
*/
|
|
843
840
|
appName?: string;
|
|
844
|
-
/**
|
|
845
|
-
* Version of your app that's installed on the Wix site, as set by you in the
|
|
846
|
-
* Wix Developers Center during the app creation process.
|
|
847
|
-
*/
|
|
841
|
+
/** Version of your app that's installed on the Wix site, as set by you during the app creation process. */
|
|
848
842
|
appVersion?: string | null;
|
|
849
843
|
/**
|
|
850
844
|
* Whether the site owners have installed a free or paid version of your app
|
|
@@ -859,7 +853,7 @@ interface AppInstance {
|
|
|
859
853
|
/**
|
|
860
854
|
* List of [permissions](https://dev.wix.com/docs/build-apps/developer-tools/developers-center/example-app-walkthrough/build-an-app#4-add-permissions)
|
|
861
855
|
* that the site owners have granted your app. You set the list of permissions that
|
|
862
|
-
* your app requires from the site owners in
|
|
856
|
+
* your app requires from the site owners in your app's Permissions page during the
|
|
863
857
|
* app creation process.
|
|
864
858
|
*/
|
|
865
859
|
permissions?: string[];
|
|
@@ -1125,7 +1119,7 @@ interface SendBIEventRequest$1 {
|
|
|
1125
1119
|
* Name of the event that's triggered in your app.
|
|
1126
1120
|
*
|
|
1127
1121
|
* + `"APP_DASHBOARD_LOADED"`: A site onwer or contributor loads your app's dashboard.
|
|
1128
|
-
* + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in
|
|
1122
|
+
* + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in your app's dashboard.
|
|
1129
1123
|
* + `"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.
|
|
1130
1124
|
* + `"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.
|
|
1131
1125
|
* + `"CHARGE"`: You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`.
|
|
@@ -1152,7 +1146,7 @@ interface SendBIEventRequest$1 {
|
|
|
1152
1146
|
* + `"currency"`: 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
1153
1147
|
* + `"sum"`: Amount of money. Required for `{"eventName": "CHARGE"}` and `{"eventName": "FUNDS_RETURNED"}`.
|
|
1154
1148
|
* + `"reason"`: Information about why the event was triggered in your app.
|
|
1155
|
-
* + `"app_plan_id"`: ID of the your app's plan as displayed in
|
|
1149
|
+
* + `"app_plan_id"`: ID of the your app's plan as displayed in your app's dashboard. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
|
|
1156
1150
|
*/
|
|
1157
1151
|
eventData?: Record<string, string>;
|
|
1158
1152
|
}
|
|
@@ -1177,7 +1171,7 @@ interface SendBIEventRequest {
|
|
|
1177
1171
|
* Name of the event that's triggered in your app.
|
|
1178
1172
|
*
|
|
1179
1173
|
* + `"APP_DASHBOARD_LOADED"`: A site onwer or contributor loads your app's dashboard.
|
|
1180
|
-
* + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in
|
|
1174
|
+
* + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in your app's dashboard.
|
|
1181
1175
|
* + `"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.
|
|
1182
1176
|
* + `"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.
|
|
1183
1177
|
* + `"CHARGE"`: You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`.
|
|
@@ -1204,7 +1198,7 @@ interface SendBIEventRequest {
|
|
|
1204
1198
|
* + `"currency"`: 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
1205
1199
|
* + `"sum"`: Amount of money. Required for `{"eventName": "CHARGE"}` and `{"eventName": "FUNDS_RETURNED"}`.
|
|
1206
1200
|
* + `"reason"`: Information about why the event was triggered in your app.
|
|
1207
|
-
* + `"app_plan_id"`: ID of the your app's plan as displayed in
|
|
1201
|
+
* + `"app_plan_id"`: ID of the your app's plan as displayed in your app's dashboard. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
|
|
1208
1202
|
*/
|
|
1209
1203
|
eventData?: Record<string, string>;
|
|
1210
1204
|
}
|
|
@@ -1269,8 +1263,8 @@ declare enum PaymentCycle$1 {
|
|
|
1269
1263
|
}
|
|
1270
1264
|
interface GetUrlRequest$1 {
|
|
1271
1265
|
/**
|
|
1272
|
-
* ID of your app's paid plan to retrieve the Wix checkout URL for. Check
|
|
1273
|
-
*
|
|
1266
|
+
* ID of your app's paid plan to retrieve the Wix checkout URL for. Check your app's dashboard
|
|
1267
|
+
* for a list of your app's supported product IDs.
|
|
1274
1268
|
*/
|
|
1275
1269
|
productId: string;
|
|
1276
1270
|
/**
|
|
@@ -1363,8 +1357,8 @@ declare enum PaymentCycle {
|
|
|
1363
1357
|
}
|
|
1364
1358
|
interface GetUrlRequest {
|
|
1365
1359
|
/**
|
|
1366
|
-
* ID of your app's paid plan to retrieve the Wix checkout URL for. Check
|
|
1367
|
-
*
|
|
1360
|
+
* ID of your app's paid plan to retrieve the Wix checkout URL for. Check your app's dashboard
|
|
1361
|
+
* for a list of your app's supported product IDs.
|
|
1368
1362
|
*/
|
|
1369
1363
|
productId: string;
|
|
1370
1364
|
/**
|
|
@@ -202,15 +202,26 @@ interface CustomChargesConfig {
|
|
|
202
202
|
baseUri?: SpiBaseUri;
|
|
203
203
|
}
|
|
204
204
|
interface SpiBaseUri {
|
|
205
|
-
/**
|
|
205
|
+
/**
|
|
206
|
+
* Base URI where the methods are called. Wix appends the path to the `baseUri`.
|
|
207
|
+
* For example, to call the Get Shipping Rates method at `https://my-shipping-provider.com/v1/getRates`, the base URI you provide here is `https://my-shipping-provider.com/`.
|
|
208
|
+
*/
|
|
206
209
|
baseUri?: string;
|
|
207
|
-
/**
|
|
210
|
+
/** Alternate, custom URIs to replace the default URIs for specific service plugin methods. */
|
|
208
211
|
alternativeUris?: AlternativeUri[];
|
|
209
212
|
}
|
|
210
213
|
interface AlternativeUri {
|
|
211
|
-
/**
|
|
214
|
+
/**
|
|
215
|
+
* Name of the method to create a custom URI for.
|
|
216
|
+
*
|
|
217
|
+
* For `methodName`, use the name of the method in PascalCase.
|
|
218
|
+
* For example, for Get Shipping Rates use `GetShippingRates`.
|
|
219
|
+
*/
|
|
212
220
|
methodName?: string;
|
|
213
|
-
/**
|
|
221
|
+
/**
|
|
222
|
+
* Custom URI that Wix uses to call your server for this method. The path-suffix documented in the method will not be appended to this URI.
|
|
223
|
+
* Must be a secured endpoint beginning with `https://`. For example, `https://www.my-shipping-provider.com/my-shipping-rates`.
|
|
224
|
+
*/
|
|
214
225
|
absoluteUri?: string;
|
|
215
226
|
}
|
|
216
227
|
/**
|
|
@@ -202,15 +202,26 @@ interface CustomChargesConfig {
|
|
|
202
202
|
baseUri?: SpiBaseUri;
|
|
203
203
|
}
|
|
204
204
|
interface SpiBaseUri {
|
|
205
|
-
/**
|
|
205
|
+
/**
|
|
206
|
+
* Base URI where the methods are called. Wix appends the path to the `baseUri`.
|
|
207
|
+
* For example, to call the Get Shipping Rates method at `https://my-shipping-provider.com/v1/getRates`, the base URI you provide here is `https://my-shipping-provider.com/`.
|
|
208
|
+
*/
|
|
206
209
|
baseUri?: string;
|
|
207
|
-
/**
|
|
210
|
+
/** Alternate, custom URIs to replace the default URIs for specific service plugin methods. */
|
|
208
211
|
alternativeUris?: AlternativeUri[];
|
|
209
212
|
}
|
|
210
213
|
interface AlternativeUri {
|
|
211
|
-
/**
|
|
214
|
+
/**
|
|
215
|
+
* Name of the method to create a custom URI for.
|
|
216
|
+
*
|
|
217
|
+
* For `methodName`, use the name of the method in PascalCase.
|
|
218
|
+
* For example, for Get Shipping Rates use `GetShippingRates`.
|
|
219
|
+
*/
|
|
212
220
|
methodName?: string;
|
|
213
|
-
/**
|
|
221
|
+
/**
|
|
222
|
+
* Custom URI that Wix uses to call your server for this method. The path-suffix documented in the method will not be appended to this URI.
|
|
223
|
+
* Must be a secured endpoint beginning with `https://`. For example, `https://www.my-shipping-provider.com/my-shipping-rates`.
|
|
224
|
+
*/
|
|
214
225
|
absoluteUri?: string;
|
|
215
226
|
}
|
|
216
227
|
/**
|