@wix/app-management 1.0.29 → 1.0.31

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.
@@ -1,5 +1,6 @@
1
- export * as appPlans from '@wix/app-management_app-plans';
2
- export * as appInstances from '@wix/app-management_app-instances';
3
- export * as biEvents from '@wix/app-management_bi-events';
4
- export * as billing from '@wix/app-management_billing';
5
- export * as embeddedScripts from '@wix/app-management_embedded-scripts';
1
+ import * as appPlans from '@wix/app-management_app-plans';
2
+ import * as appInstances from '@wix/app-management_app-instances';
3
+ import * as biEvents from '@wix/app-management_bi-events';
4
+ import * as billing from '@wix/app-management_billing';
5
+ import * as embeddedScripts from '@wix/app-management_embedded-scripts';
6
+ export { appPlans, appInstances, biEvents, billing, embeddedScripts };
@@ -24,9 +24,14 @@ var __importStar = (this && this.__importStar) || function (mod) {
24
24
  };
25
25
  Object.defineProperty(exports, "__esModule", { value: true });
26
26
  exports.embeddedScripts = exports.billing = exports.biEvents = exports.appInstances = exports.appPlans = void 0;
27
- exports.appPlans = __importStar(require("@wix/app-management_app-plans"));
28
- exports.appInstances = __importStar(require("@wix/app-management_app-instances"));
29
- exports.biEvents = __importStar(require("@wix/app-management_bi-events"));
30
- exports.billing = __importStar(require("@wix/app-management_billing"));
31
- exports.embeddedScripts = __importStar(require("@wix/app-management_embedded-scripts"));
27
+ const appPlans = __importStar(require("@wix/app-management_app-plans"));
28
+ exports.appPlans = appPlans;
29
+ const appInstances = __importStar(require("@wix/app-management_app-instances"));
30
+ exports.appInstances = appInstances;
31
+ const biEvents = __importStar(require("@wix/app-management_bi-events"));
32
+ exports.biEvents = biEvents;
33
+ const billing = __importStar(require("@wix/app-management_billing"));
34
+ exports.billing = billing;
35
+ const embeddedScripts = __importStar(require("@wix/app-management_embedded-scripts"));
36
+ exports.embeddedScripts = embeddedScripts;
32
37
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0EAA0D;AAC1D,kFAAkE;AAClE,0EAA0D;AAC1D,uEAAuD;AACvD,wFAAwE"}
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"}
@@ -1,5 +1,6 @@
1
- export * as appPlans from '@wix/app-management_app-plans';
2
- export * as appInstances from '@wix/app-management_app-instances';
3
- export * as biEvents from '@wix/app-management_bi-events';
4
- export * as billing from '@wix/app-management_billing';
5
- export * as embeddedScripts from '@wix/app-management_embedded-scripts';
1
+ import * as appPlans from '@wix/app-management_app-plans';
2
+ import * as appInstances from '@wix/app-management_app-instances';
3
+ import * as biEvents from '@wix/app-management_bi-events';
4
+ import * as billing from '@wix/app-management_billing';
5
+ import * as embeddedScripts from '@wix/app-management_embedded-scripts';
6
+ export { appPlans, appInstances, biEvents, billing, embeddedScripts };
package/build/es/index.js CHANGED
@@ -1,6 +1,7 @@
1
- export * as appPlans from '@wix/app-management_app-plans';
2
- export * as appInstances from '@wix/app-management_app-instances';
3
- export * as biEvents from '@wix/app-management_bi-events';
4
- export * as billing from '@wix/app-management_billing';
5
- export * as embeddedScripts from '@wix/app-management_embedded-scripts';
1
+ import * as appPlans from '@wix/app-management_app-plans';
2
+ import * as appInstances from '@wix/app-management_app-instances';
3
+ import * as biEvents from '@wix/app-management_bi-events';
4
+ import * as billing from '@wix/app-management_billing';
5
+ import * as embeddedScripts from '@wix/app-management_embedded-scripts';
6
+ export { appPlans, appInstances, biEvents, billing, embeddedScripts };
6
7
  //# sourceMappingURL=index.js.map
@@ -1 +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"}
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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/app-management",
3
- "version": "1.0.29",
3
+ "version": "1.0.31",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -19,12 +19,12 @@
19
19
  "service-plugins"
20
20
  ],
21
21
  "dependencies": {
22
- "@wix/app-management_app-instances": "1.0.15",
23
- "@wix/app-management_app-plans": "1.0.15",
24
- "@wix/app-management_bi-events": "1.0.14",
25
- "@wix/app-management_billing": "1.0.15",
26
- "@wix/app-management_custom-charges": "1.0.13",
27
- "@wix/app-management_embedded-scripts": "1.0.12"
22
+ "@wix/app-management_app-instances": "1.0.17",
23
+ "@wix/app-management_app-plans": "1.0.17",
24
+ "@wix/app-management_bi-events": "1.0.16",
25
+ "@wix/app-management_billing": "1.0.17",
26
+ "@wix/app-management_custom-charges": "1.0.14",
27
+ "@wix/app-management_embedded-scripts": "1.0.14"
28
28
  },
29
29
  "devDependencies": {
30
30
  "glob": "^10.4.1",
@@ -33,8 +33,9 @@
33
33
  "typescript": "^5.3.2"
34
34
  },
35
35
  "scripts": {
36
- "build": "tsc -b tsconfig.json tsconfig.esm.json && npm run build:dts-bundles",
36
+ "build": "tsc -b tsconfig.json tsconfig.esm.json && npm run build:dts-bundles && npm run build:validate-dts",
37
37
  "build:dts-bundles": "test -f config/rollup-config.js && NODE_OPTIONS=--max-old-space-size=8192 rollup --config config/rollup-config.js || echo 'Warning: config/rollup-config.js not found!'",
38
+ "build:validate-dts": "tsc type-bundles/*.d.ts --noEmit",
38
39
  "test": ":"
39
40
  },
40
41
  "wix": {
@@ -48,5 +49,5 @@
48
49
  "fqdn": ""
49
50
  }
50
51
  },
51
- "falconPackageHash": "cd068854d380024da58d92eff52eef9b18a8f45fa27600c745b0f513"
52
+ "falconPackageHash": "2706f85ff49e879a3fdb9c6f6bb9361bd5ca377d95fdc9389c4caa57"
52
53
  }
@@ -1,10 +1,47 @@
1
- /**
2
- * An `appPlans` object describes how you charge users for using your app.
3
- * You can set up multiple plans for a single app, with different plans giving access to
4
- * different tiers of functionality. For example, you can offer a free plan and
5
- * 3 paid plans with an increasing number of benefits. Learn more about
6
- * [setting up your app pricing](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-your-app-pricing).
7
- */
1
+ type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
2
+ interface HttpClient {
3
+ request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
4
+ fetchWithAuth: typeof fetch;
5
+ wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
6
+ }
7
+ type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
8
+ type HttpResponse<T = any> = {
9
+ data: T;
10
+ status: number;
11
+ statusText: string;
12
+ headers: any;
13
+ request?: any;
14
+ };
15
+ type RequestOptions<_TResponse = any, Data = any> = {
16
+ method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
17
+ url: string;
18
+ data?: Data;
19
+ params?: URLSearchParams;
20
+ } & APIMetadata;
21
+ type APIMetadata = {
22
+ methodFqn?: string;
23
+ entityFqdn?: string;
24
+ packageName?: string;
25
+ };
26
+ type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
27
+ type EventDefinition<Payload = unknown, Type extends string = string> = {
28
+ __type: 'event-definition';
29
+ type: Type;
30
+ isDomainEvent?: boolean;
31
+ transformations?: (envelope: unknown) => Payload;
32
+ __payload: Payload;
33
+ };
34
+ declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
35
+ type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
36
+ type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
37
+
38
+ declare global {
39
+ // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
40
+ interface SymbolConstructor {
41
+ readonly observable: symbol;
42
+ }
43
+ }
44
+
8
45
  interface AppPlans {
9
46
  /** App ID, as defined in the [Wix Dev Center](https://dev.wix.com/). */
10
47
  _id?: string;
@@ -234,53 +271,44 @@ interface ListAppPlansByAppIdResponseNonNullableFields {
234
271
  appPlans: AppPlansNonNullableFields[];
235
272
  }
236
273
 
237
- type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
238
- interface HttpClient {
239
- request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
240
- fetchWithAuth: typeof fetch;
241
- wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
242
- }
243
- type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
244
- type HttpResponse<T = any> = {
245
- data: T;
246
- status: number;
247
- statusText: string;
248
- headers: any;
249
- request?: any;
250
- };
251
- type RequestOptions<_TResponse = any, Data = any> = {
252
- method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
253
- url: string;
254
- data?: Data;
255
- params?: URLSearchParams;
256
- } & APIMetadata;
257
- type APIMetadata = {
258
- methodFqn?: string;
259
- entityFqdn?: string;
260
- packageName?: string;
261
- };
262
- type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
263
- type EventDefinition<Payload = unknown, Type extends string = string> = {
264
- __type: 'event-definition';
265
- type: Type;
266
- isDomainEvent?: boolean;
267
- transformations?: (envelope: unknown) => Payload;
268
- __payload: Payload;
269
- };
270
- declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
271
- type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
272
- type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
273
-
274
- declare global {
275
- // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
276
- interface SymbolConstructor {
277
- readonly observable: symbol;
278
- }
274
+ declare function listAppPlansByAppId$1(httpClient: HttpClient): ListAppPlansByAppIdSignature;
275
+ interface ListAppPlansByAppIdSignature {
276
+ /**
277
+ * Retrieves plans for the given apps.
278
+ *
279
+ *
280
+ * Also returns tax settings and currency details. Wix calculates this information
281
+ * based on the 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
282
+ * format that you pass in the call's header. If you don't pass a country code in
283
+ * the header, Wix calculates the tax settings and currency details based on the
284
+ * call's IP address. Note that the tax settings and currency details may not resolve
285
+ * properly if you call through a VPN.
286
+ *
287
+ * Prices for plans that are managed outside of Wix aren't returned.
288
+ *
289
+ * Consumers must pay for yearly and multi-yearly plans of your app every month.
290
+ * For these plans this endpoint returns the price that the consumer must pay every
291
+ * month and not the total price for the entire year.
292
+ *
293
+ * <blockquote class="important">
294
+ *
295
+ * __Important:__
296
+ * The App Plans API doesn't follow any tenancy model. You don't need any
297
+ * permissions to call `List App Plans by App ID`.
298
+ *
299
+ * </blockquote>
300
+ * @param - List of app IDs to retrieve plans for.
301
+ *
302
+ * Min: 1 app ID
303
+ * Max: 100 app IDs
304
+ */
305
+ (appIds: string[]): Promise<ListAppPlansByAppIdResponse & ListAppPlansByAppIdResponseNonNullableFields>;
279
306
  }
280
307
 
281
308
  declare function createRESTModule$4<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
282
309
 
283
- declare const listAppPlansByAppId: ReturnType<typeof createRESTModule$4<typeof publicListAppPlansByAppId>>;
310
+ type _publicListAppPlansByAppIdType = typeof listAppPlansByAppId$1;
311
+ declare const listAppPlansByAppId: ReturnType<typeof createRESTModule$4<_publicListAppPlansByAppIdType>>;
284
312
 
285
313
  type context$4_AppPlans = AppPlans;
286
314
  type context$4_Cycle = Cycle;
@@ -298,9 +326,10 @@ type context$4_TaxSettings = TaxSettings;
298
326
  type context$4_TaxType = TaxType;
299
327
  declare const context$4_TaxType: typeof TaxType;
300
328
  type context$4_UsageBasedDetails = UsageBasedDetails;
329
+ type context$4__publicListAppPlansByAppIdType = _publicListAppPlansByAppIdType;
301
330
  declare const context$4_listAppPlansByAppId: typeof listAppPlansByAppId;
302
331
  declare namespace context$4 {
303
- export { type context$4_AppPlans as AppPlans, type context$4_Cycle as Cycle, context$4_CycleType as CycleType, type context$4_Duration as Duration, context$4_DurationUnit as DurationUnit, type context$4_ListAppPlansByAppIdRequest as ListAppPlansByAppIdRequest, type context$4_ListAppPlansByAppIdResponse as ListAppPlansByAppIdResponse, type context$4_ListAppPlansByAppIdResponseNonNullableFields as ListAppPlansByAppIdResponseNonNullableFields, type context$4_Plan as Plan, type context$4_Price as Price, type context$4_TaxSettings as TaxSettings, context$4_TaxType as TaxType, type context$4_UsageBasedDetails as UsageBasedDetails, context$4_listAppPlansByAppId as listAppPlansByAppId };
332
+ export { type context$4_AppPlans as AppPlans, type context$4_Cycle as Cycle, context$4_CycleType as CycleType, type context$4_Duration as Duration, context$4_DurationUnit as DurationUnit, type context$4_ListAppPlansByAppIdRequest as ListAppPlansByAppIdRequest, type context$4_ListAppPlansByAppIdResponse as ListAppPlansByAppIdResponse, type context$4_ListAppPlansByAppIdResponseNonNullableFields as ListAppPlansByAppIdResponseNonNullableFields, type context$4_Plan as Plan, type context$4_Price as Price, type context$4_TaxSettings as TaxSettings, context$4_TaxType as TaxType, type context$4_UsageBasedDetails as UsageBasedDetails, type context$4__publicListAppPlansByAppIdType as _publicListAppPlansByAppIdType, context$4_listAppPlansByAppId as listAppPlansByAppId };
304
333
  }
305
334
 
306
335
  /**
@@ -707,16 +736,66 @@ interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
707
736
  metadata: BaseEventMetadata;
708
737
  }
709
738
 
739
+ declare function getAppInstance$1(httpClient: HttpClient): GetAppInstanceSignature;
740
+ interface GetAppInstanceSignature {
741
+ /**
742
+ * Retrieves data about the instance of your app that's installed on the Wix
743
+ * site and the site itself.
744
+ *
745
+ *
746
+ * You don't have to explicitly pass an identifier for the Wix site as part of
747
+ * the request, since this information is taken automatically from the context.
748
+ *
749
+ * In case you want `site.ownerInfo` to be included in the response, you must
750
+ * have the __Read Site Owner Email__ permission scope in addition to
751
+ * __WIX_DEVELOPERS.MANAGE_APP_INSTANCE__.
752
+ */
753
+ (): Promise<GetAppInstanceResponse & GetAppInstanceResponseNonNullableFields>;
754
+ }
755
+ declare const onAppInstanceInstalled$1: EventDefinition<AppInstanceInstalledEnvelope, "AppInstalled">;
756
+ declare const onAppInstanceRemoved$1: EventDefinition<AppInstanceRemovedEnvelope, "AppRemoved">;
757
+ declare const onAppInstancePaidPlanPurchased$1: EventDefinition<AppInstancePaidPlanPurchasedEnvelope, "PaidPlanPurchased">;
758
+ declare const onAppInstancePaidPlanChanged$1: EventDefinition<AppInstancePaidPlanChangedEnvelope, "PaidPlanChanged">;
759
+ declare const onAppInstancePaidPlanAutoRenewalCancelled$1: EventDefinition<AppInstancePaidPlanAutoRenewalCancelledEnvelope, "PaidPlanAutoRenewalCancelled">;
760
+
710
761
  declare function createRESTModule$3<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
711
762
 
712
763
  declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
713
764
 
714
- declare const getAppInstance: ReturnType<typeof createRESTModule$3<typeof publicGetAppInstance>>;
715
- declare const onAppInstanceInstalled: ReturnType<typeof createEventModule<typeof publicOnAppInstanceInstalled>>;
716
- declare const onAppInstanceRemoved: ReturnType<typeof createEventModule<typeof publicOnAppInstanceRemoved>>;
717
- declare const onAppInstancePaidPlanPurchased: ReturnType<typeof createEventModule<typeof publicOnAppInstancePaidPlanPurchased>>;
718
- declare const onAppInstancePaidPlanChanged: ReturnType<typeof createEventModule<typeof publicOnAppInstancePaidPlanChanged>>;
719
- declare const onAppInstancePaidPlanAutoRenewalCancelled: ReturnType<typeof createEventModule<typeof publicOnAppInstancePaidPlanAutoRenewalCancelled>>;
765
+ type _publicGetAppInstanceType = typeof getAppInstance$1;
766
+ declare const getAppInstance: ReturnType<typeof createRESTModule$3<_publicGetAppInstanceType>>;
767
+
768
+ type _publicOnAppInstanceInstalledType = typeof onAppInstanceInstalled$1;
769
+ /**
770
+ * Triggered when an instance of your app is installed on a Wix site.
771
+ */
772
+ declare const onAppInstanceInstalled: ReturnType<typeof createEventModule<_publicOnAppInstanceInstalledType>>;
773
+
774
+ type _publicOnAppInstanceRemovedType = typeof onAppInstanceRemoved$1;
775
+ /**
776
+ * Triggered when an instance of your app is uninstalled from a Wix site.
777
+ */
778
+ declare const onAppInstanceRemoved: ReturnType<typeof createEventModule<_publicOnAppInstanceRemovedType>>;
779
+
780
+ type _publicOnAppInstancePaidPlanPurchasedType = typeof onAppInstancePaidPlanPurchased$1;
781
+ /**
782
+ * Triggered when a site owner purchases a paid plan for your app.
783
+ */
784
+ declare const onAppInstancePaidPlanPurchased: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanPurchasedType>>;
785
+
786
+ type _publicOnAppInstancePaidPlanChangedType = typeof onAppInstancePaidPlanChanged$1;
787
+ /**
788
+ * Triggered when a site owner upgrades or downgrades their plan for your app.
789
+ */
790
+ declare const onAppInstancePaidPlanChanged: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanChangedType>>;
791
+
792
+ type _publicOnAppInstancePaidPlanAutoRenewalCancelledType = typeof onAppInstancePaidPlanAutoRenewalCancelled$1;
793
+ /**
794
+ * Triggered when a site owner cancels a paid plan for your app. The
795
+ * site owner can continue to use your app until the end of the current billing
796
+ * cycle.
797
+ */
798
+ declare const onAppInstancePaidPlanAutoRenewalCancelled: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanAutoRenewalCancelledType>>;
720
799
 
721
800
  type context$3_AppInstalled = AppInstalled;
722
801
  type context$3_AppInstance = AppInstance;
@@ -746,6 +825,12 @@ type context$3_ResolutionMethod = ResolutionMethod;
746
825
  declare const context$3_ResolutionMethod: typeof ResolutionMethod;
747
826
  type context$3_SiteInfo = SiteInfo;
748
827
  type context$3_SupportedLanguage = SupportedLanguage;
828
+ type context$3__publicGetAppInstanceType = _publicGetAppInstanceType;
829
+ type context$3__publicOnAppInstanceInstalledType = _publicOnAppInstanceInstalledType;
830
+ type context$3__publicOnAppInstancePaidPlanAutoRenewalCancelledType = _publicOnAppInstancePaidPlanAutoRenewalCancelledType;
831
+ type context$3__publicOnAppInstancePaidPlanChangedType = _publicOnAppInstancePaidPlanChangedType;
832
+ type context$3__publicOnAppInstancePaidPlanPurchasedType = _publicOnAppInstancePaidPlanPurchasedType;
833
+ type context$3__publicOnAppInstanceRemovedType = _publicOnAppInstanceRemovedType;
749
834
  declare const context$3_getAppInstance: typeof getAppInstance;
750
835
  declare const context$3_onAppInstanceInstalled: typeof onAppInstanceInstalled;
751
836
  declare const context$3_onAppInstancePaidPlanAutoRenewalCancelled: typeof onAppInstancePaidPlanAutoRenewalCancelled;
@@ -753,7 +838,7 @@ declare const context$3_onAppInstancePaidPlanChanged: typeof onAppInstancePaidPl
753
838
  declare const context$3_onAppInstancePaidPlanPurchased: typeof onAppInstancePaidPlanPurchased;
754
839
  declare const context$3_onAppInstanceRemoved: typeof onAppInstanceRemoved;
755
840
  declare namespace context$3 {
756
- export { type context$3_AppInstalled as AppInstalled, type context$3_AppInstance as AppInstance, type context$3_AppInstanceInstalledEnvelope as AppInstanceInstalledEnvelope, type context$3_AppInstancePaidPlanAutoRenewalCancelledEnvelope as AppInstancePaidPlanAutoRenewalCancelledEnvelope, type context$3_AppInstancePaidPlanChangedEnvelope as AppInstancePaidPlanChangedEnvelope, type context$3_AppInstancePaidPlanPurchasedEnvelope as AppInstancePaidPlanPurchasedEnvelope, type context$3_AppInstanceRemovedEnvelope as AppInstanceRemovedEnvelope, type context$3_AppRemoved as AppRemoved, type context$3_AvailablePlan as AvailablePlan, type context$3_BaseEventMetadata as BaseEventMetadata, type context$3_BillingInfo as BillingInfo, type context$3_FreeTrialInfo as FreeTrialInfo, context$3_FreeTrialStatus as FreeTrialStatus, type context$3_GetAppInstanceByInstanceIdRequest as GetAppInstanceByInstanceIdRequest, type context$3_GetAppInstanceRequest as GetAppInstanceRequest, type context$3_GetAppInstanceResponse as GetAppInstanceResponse, type context$3_GetAppInstanceResponseNonNullableFields as GetAppInstanceResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type context$3_Locale as Locale, type MessageEnvelope$1 as MessageEnvelope, type context$3_Multilingual as Multilingual, type context$3_OwnerInfo as OwnerInfo, type context$3_PaidPlanAutoRenewalCancelled as PaidPlanAutoRenewalCancelled, type context$3_PaidPlanChanged as PaidPlanChanged, type context$3_PaidPlanPurchased as PaidPlanPurchased, PaymentCycle$1 as PaymentCycle, context$3_ResolutionMethod as ResolutionMethod, type context$3_SiteInfo as SiteInfo, type context$3_SupportedLanguage as SupportedLanguage, WebhookIdentityType$1 as WebhookIdentityType, context$3_getAppInstance as getAppInstance, context$3_onAppInstanceInstalled as onAppInstanceInstalled, context$3_onAppInstancePaidPlanAutoRenewalCancelled as onAppInstancePaidPlanAutoRenewalCancelled, context$3_onAppInstancePaidPlanChanged as onAppInstancePaidPlanChanged, context$3_onAppInstancePaidPlanPurchased as onAppInstancePaidPlanPurchased, context$3_onAppInstanceRemoved as onAppInstanceRemoved };
841
+ export { type context$3_AppInstalled as AppInstalled, type context$3_AppInstance as AppInstance, type context$3_AppInstanceInstalledEnvelope as AppInstanceInstalledEnvelope, type context$3_AppInstancePaidPlanAutoRenewalCancelledEnvelope as AppInstancePaidPlanAutoRenewalCancelledEnvelope, type context$3_AppInstancePaidPlanChangedEnvelope as AppInstancePaidPlanChangedEnvelope, type context$3_AppInstancePaidPlanPurchasedEnvelope as AppInstancePaidPlanPurchasedEnvelope, type context$3_AppInstanceRemovedEnvelope as AppInstanceRemovedEnvelope, type context$3_AppRemoved as AppRemoved, type context$3_AvailablePlan as AvailablePlan, type context$3_BaseEventMetadata as BaseEventMetadata, type context$3_BillingInfo as BillingInfo, type context$3_FreeTrialInfo as FreeTrialInfo, context$3_FreeTrialStatus as FreeTrialStatus, type context$3_GetAppInstanceByInstanceIdRequest as GetAppInstanceByInstanceIdRequest, type context$3_GetAppInstanceRequest as GetAppInstanceRequest, type context$3_GetAppInstanceResponse as GetAppInstanceResponse, type context$3_GetAppInstanceResponseNonNullableFields as GetAppInstanceResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type context$3_Locale as Locale, type MessageEnvelope$1 as MessageEnvelope, type context$3_Multilingual as Multilingual, type context$3_OwnerInfo as OwnerInfo, type context$3_PaidPlanAutoRenewalCancelled as PaidPlanAutoRenewalCancelled, type context$3_PaidPlanChanged as PaidPlanChanged, type context$3_PaidPlanPurchased as PaidPlanPurchased, PaymentCycle$1 as PaymentCycle, context$3_ResolutionMethod as ResolutionMethod, type context$3_SiteInfo as SiteInfo, type context$3_SupportedLanguage as SupportedLanguage, WebhookIdentityType$1 as WebhookIdentityType, type context$3__publicGetAppInstanceType as _publicGetAppInstanceType, type context$3__publicOnAppInstanceInstalledType as _publicOnAppInstanceInstalledType, type context$3__publicOnAppInstancePaidPlanAutoRenewalCancelledType as _publicOnAppInstancePaidPlanAutoRenewalCancelledType, type context$3__publicOnAppInstancePaidPlanChangedType as _publicOnAppInstancePaidPlanChangedType, type context$3__publicOnAppInstancePaidPlanPurchasedType as _publicOnAppInstancePaidPlanPurchasedType, type context$3__publicOnAppInstanceRemovedType as _publicOnAppInstanceRemovedType, context$3_getAppInstance as getAppInstance, context$3_onAppInstanceInstalled as onAppInstanceInstalled, context$3_onAppInstancePaidPlanAutoRenewalCancelled as onAppInstancePaidPlanAutoRenewalCancelled, context$3_onAppInstancePaidPlanChanged as onAppInstancePaidPlanChanged, context$3_onAppInstancePaidPlanPurchased as onAppInstancePaidPlanPurchased, context$3_onAppInstanceRemoved as onAppInstanceRemoved, onAppInstanceInstalled$1 as publicOnAppInstanceInstalled, onAppInstancePaidPlanAutoRenewalCancelled$1 as publicOnAppInstancePaidPlanAutoRenewalCancelled, onAppInstancePaidPlanChanged$1 as publicOnAppInstancePaidPlanChanged, onAppInstancePaidPlanPurchased$1 as publicOnAppInstancePaidPlanPurchased, onAppInstanceRemoved$1 as publicOnAppInstanceRemoved };
757
842
  }
758
843
 
759
844
  interface SendBIEventResponse {
@@ -844,18 +929,28 @@ interface SendBiEventOptions {
844
929
  eventData?: Record<string, string>;
845
930
  }
846
931
 
932
+ declare function sendBiEvent$1(httpClient: HttpClient): SendBiEventSignature;
933
+ interface SendBiEventSignature {
934
+ /**
935
+ * Submit a BI event to Wix.
936
+ */
937
+ (options?: SendBiEventOptions | undefined): Promise<void>;
938
+ }
939
+
847
940
  declare function createRESTModule$2<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
848
941
 
849
- declare const sendBiEvent: ReturnType<typeof createRESTModule$2<typeof publicSendBiEvent>>;
942
+ type _publicSendBiEventType = typeof sendBiEvent$1;
943
+ declare const sendBiEvent: ReturnType<typeof createRESTModule$2<_publicSendBiEventType>>;
850
944
 
851
945
  type context$2_EventName = EventName;
852
946
  declare const context$2_EventName: typeof EventName;
853
947
  type context$2_SendBIEventRequest = SendBIEventRequest;
854
948
  type context$2_SendBIEventResponse = SendBIEventResponse;
855
949
  type context$2_SendBiEventOptions = SendBiEventOptions;
950
+ type context$2__publicSendBiEventType = _publicSendBiEventType;
856
951
  declare const context$2_sendBiEvent: typeof sendBiEvent;
857
952
  declare namespace context$2 {
858
- export { context$2_EventName as EventName, type context$2_SendBIEventRequest as SendBIEventRequest, type context$2_SendBIEventResponse as SendBIEventResponse, type context$2_SendBiEventOptions as SendBiEventOptions, context$2_sendBiEvent as sendBiEvent };
953
+ export { context$2_EventName as EventName, type context$2_SendBIEventRequest as SendBIEventRequest, type context$2_SendBIEventResponse as SendBIEventResponse, type context$2_SendBiEventOptions as SendBiEventOptions, type context$2__publicSendBiEventType as _publicSendBiEventType, context$2_sendBiEvent as sendBiEvent };
859
954
  }
860
955
 
861
956
  interface PurchasedItem {
@@ -1111,10 +1206,44 @@ interface GetUrlOptions {
1111
1206
  couponCode?: string | null;
1112
1207
  }
1113
1208
 
1209
+ declare function getUrl$1(httpClient: HttpClient): GetUrlSignature;
1210
+ interface GetUrlSignature {
1211
+ /**
1212
+ * Retrieves the URL for a Wix checkout page for the specified paid plan of your app.
1213
+ *
1214
+ *
1215
+ * This call succeeds only in case you have previously
1216
+ * [set up an external pricing page in the Wix Developers Center](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-an-external-pricing-page).
1217
+ *
1218
+ * The returned checkout URL is valid for 48 hours.
1219
+ *
1220
+ * This API allows your app to manage your pricing page outside of Wix while
1221
+ * still using the standard Wix checkout flow.
1222
+ * @param - ID of your app's paid plan to retrieve the Wix checkout URL for. Check the
1223
+ * Wix Developers Center for a list of your app's supported product IDs.
1224
+ */
1225
+ (productId: string, options?: GetUrlOptions | undefined): Promise<GetUrlResponse & GetUrlResponseNonNullableFields>;
1226
+ }
1227
+ declare function getPurchaseHistory$1(httpClient: HttpClient): GetPurchaseHistorySignature;
1228
+ interface GetPurchaseHistorySignature {
1229
+ /**
1230
+ * Retrieves a list of the site owner's past purchases for your app.
1231
+ *
1232
+ *
1233
+ * You don't have to explicitly pass an identifier for the Wix site as part of
1234
+ * the request, since this information is taken automatically from the context.
1235
+ *
1236
+ * The response doesn't include any details about cancellations.
1237
+ */
1238
+ (): Promise<GetPurchaseHistoryResponse & GetPurchaseHistoryResponseNonNullableFields>;
1239
+ }
1240
+
1114
1241
  declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
1115
1242
 
1116
- declare const getUrl: ReturnType<typeof createRESTModule$1<typeof publicGetUrl>>;
1117
- declare const getPurchaseHistory: ReturnType<typeof createRESTModule$1<typeof publicGetPurchaseHistory>>;
1243
+ type _publicGetUrlType = typeof getUrl$1;
1244
+ declare const getUrl: ReturnType<typeof createRESTModule$1<_publicGetUrlType>>;
1245
+ type _publicGetPurchaseHistoryType = typeof getPurchaseHistory$1;
1246
+ declare const getPurchaseHistory: ReturnType<typeof createRESTModule$1<_publicGetPurchaseHistoryType>>;
1118
1247
 
1119
1248
  type context$1_Charge = Charge;
1120
1249
  type context$1_ChargeOverride = ChargeOverride;
@@ -1140,10 +1269,12 @@ declare const context$1_PaymentCycle: typeof PaymentCycle;
1140
1269
  type context$1_PurchasedItem = PurchasedItem;
1141
1270
  type context$1_WebhookIdentityType = WebhookIdentityType;
1142
1271
  declare const context$1_WebhookIdentityType: typeof WebhookIdentityType;
1272
+ type context$1__publicGetPurchaseHistoryType = _publicGetPurchaseHistoryType;
1273
+ type context$1__publicGetUrlType = _publicGetUrlType;
1143
1274
  declare const context$1_getPurchaseHistory: typeof getPurchaseHistory;
1144
1275
  declare const context$1_getUrl: typeof getUrl;
1145
1276
  declare namespace context$1 {
1146
- export { type context$1_Charge as Charge, type context$1_ChargeOverride as ChargeOverride, type context$1_GetMeteredBillingChargesRequest as GetMeteredBillingChargesRequest, type context$1_GetMeteredBillingChargesResponse as GetMeteredBillingChargesResponse, type context$1_GetPurchaseHistoryRequest as GetPurchaseHistoryRequest, type context$1_GetPurchaseHistoryResponse as GetPurchaseHistoryResponse, type context$1_GetPurchaseHistoryResponseNonNullableFields as GetPurchaseHistoryResponseNonNullableFields, type context$1_GetSitePaymentMethodsStatusRequest as GetSitePaymentMethodsStatusRequest, type context$1_GetSitePaymentMethodsStatusResponse as GetSitePaymentMethodsStatusResponse, type context$1_GetUrlOptions as GetUrlOptions, type context$1_GetUrlRequest as GetUrlRequest, type context$1_GetUrlResponse as GetUrlResponse, type context$1_GetUrlResponseNonNullableFields as GetUrlResponseNonNullableFields, type context$1_IdentificationData as IdentificationData, type context$1_IdentificationDataIdOneOf as IdentificationDataIdOneOf, context$1_InvoiceStatus as InvoiceStatus, type context$1_InvoiceStatusUpdate as InvoiceStatusUpdate, type context$1_MessageEnvelope as MessageEnvelope, context$1_PaymentCycle as PaymentCycle, type context$1_PurchasedItem as PurchasedItem, context$1_WebhookIdentityType as WebhookIdentityType, context$1_getPurchaseHistory as getPurchaseHistory, context$1_getUrl as getUrl };
1277
+ export { type context$1_Charge as Charge, type context$1_ChargeOverride as ChargeOverride, type context$1_GetMeteredBillingChargesRequest as GetMeteredBillingChargesRequest, type context$1_GetMeteredBillingChargesResponse as GetMeteredBillingChargesResponse, type context$1_GetPurchaseHistoryRequest as GetPurchaseHistoryRequest, type context$1_GetPurchaseHistoryResponse as GetPurchaseHistoryResponse, type context$1_GetPurchaseHistoryResponseNonNullableFields as GetPurchaseHistoryResponseNonNullableFields, type context$1_GetSitePaymentMethodsStatusRequest as GetSitePaymentMethodsStatusRequest, type context$1_GetSitePaymentMethodsStatusResponse as GetSitePaymentMethodsStatusResponse, type context$1_GetUrlOptions as GetUrlOptions, type context$1_GetUrlRequest as GetUrlRequest, type context$1_GetUrlResponse as GetUrlResponse, type context$1_GetUrlResponseNonNullableFields as GetUrlResponseNonNullableFields, type context$1_IdentificationData as IdentificationData, type context$1_IdentificationDataIdOneOf as IdentificationDataIdOneOf, context$1_InvoiceStatus as InvoiceStatus, type context$1_InvoiceStatusUpdate as InvoiceStatusUpdate, type context$1_MessageEnvelope as MessageEnvelope, context$1_PaymentCycle as PaymentCycle, type context$1_PurchasedItem as PurchasedItem, context$1_WebhookIdentityType as WebhookIdentityType, type context$1__publicGetPurchaseHistoryType as _publicGetPurchaseHistoryType, type context$1__publicGetUrlType as _publicGetUrlType, context$1_getPurchaseHistory as getPurchaseHistory, context$1_getUrl as getUrl };
1147
1278
  }
1148
1279
 
1149
1280
  /** Embedded script data */
@@ -1199,10 +1330,38 @@ interface GetEmbeddedScriptOptions {
1199
1330
  componentId?: string | null;
1200
1331
  }
1201
1332
 
1333
+ declare function embedScript$1(httpClient: HttpClient): EmbedScriptSignature;
1334
+ interface EmbedScriptSignature {
1335
+ /**
1336
+ * Inserts custom script tags into a site.
1337
+ *
1338
+ *
1339
+ * Your app must have an existing
1340
+ * [embedded script component](https://dev.wix.com/docs/build-apps/developer-tools/extensions/embedded-scripts),
1341
+ * with exactly matching parameter names.
1342
+ * @param - Details of the script to embed.
1343
+ */
1344
+ (properties: ScriptProperties, options?: EmbedScriptOptions | undefined): Promise<EmbedScriptResponse & EmbedScriptResponseNonNullableFields>;
1345
+ }
1346
+ declare function getEmbeddedScript$1(httpClient: HttpClient): GetEmbeddedScriptSignature;
1347
+ interface GetEmbeddedScriptSignature {
1348
+ /**
1349
+ * Retrieves information about your app's existing embedded script.
1350
+ *
1351
+ *
1352
+ * The call fails with `404` error in case your app doesn't include an
1353
+ * embedded script on the site.
1354
+ * @returns Details of the retrieved embedded script.
1355
+ */
1356
+ (options?: GetEmbeddedScriptOptions | undefined): Promise<ScriptProperties & ScriptPropertiesNonNullableFields>;
1357
+ }
1358
+
1202
1359
  declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
1203
1360
 
1204
- declare const embedScript: ReturnType<typeof createRESTModule<typeof publicEmbedScript>>;
1205
- declare const getEmbeddedScript: ReturnType<typeof createRESTModule<typeof publicGetEmbeddedScript>>;
1361
+ type _publicEmbedScriptType = typeof embedScript$1;
1362
+ declare const embedScript: ReturnType<typeof createRESTModule<_publicEmbedScriptType>>;
1363
+ type _publicGetEmbeddedScriptType = typeof getEmbeddedScript$1;
1364
+ declare const getEmbeddedScript: ReturnType<typeof createRESTModule<_publicGetEmbeddedScriptType>>;
1206
1365
 
1207
1366
  type context_EmbedScriptByInstanceIdRequest = EmbedScriptByInstanceIdRequest;
1208
1367
  type context_EmbedScriptOptions = EmbedScriptOptions;
@@ -1216,10 +1375,12 @@ type context_GetEmbeddedScriptResponse = GetEmbeddedScriptResponse;
1216
1375
  type context_GetEmbeddedScriptResponseNonNullableFields = GetEmbeddedScriptResponseNonNullableFields;
1217
1376
  type context_ScriptProperties = ScriptProperties;
1218
1377
  type context_ScriptPropertiesNonNullableFields = ScriptPropertiesNonNullableFields;
1378
+ type context__publicEmbedScriptType = _publicEmbedScriptType;
1379
+ type context__publicGetEmbeddedScriptType = _publicGetEmbeddedScriptType;
1219
1380
  declare const context_embedScript: typeof embedScript;
1220
1381
  declare const context_getEmbeddedScript: typeof getEmbeddedScript;
1221
1382
  declare namespace context {
1222
- export { type context_EmbedScriptByInstanceIdRequest as EmbedScriptByInstanceIdRequest, type context_EmbedScriptOptions as EmbedScriptOptions, type context_EmbedScriptRequest as EmbedScriptRequest, type context_EmbedScriptResponse as EmbedScriptResponse, type context_EmbedScriptResponseNonNullableFields as EmbedScriptResponseNonNullableFields, type context_GetEmbeddedScriptByInstanceIdRequest as GetEmbeddedScriptByInstanceIdRequest, type context_GetEmbeddedScriptOptions as GetEmbeddedScriptOptions, type context_GetEmbeddedScriptRequest as GetEmbeddedScriptRequest, type context_GetEmbeddedScriptResponse as GetEmbeddedScriptResponse, type context_GetEmbeddedScriptResponseNonNullableFields as GetEmbeddedScriptResponseNonNullableFields, type context_ScriptProperties as ScriptProperties, type context_ScriptPropertiesNonNullableFields as ScriptPropertiesNonNullableFields, context_embedScript as embedScript, context_getEmbeddedScript as getEmbeddedScript };
1383
+ export { type context_EmbedScriptByInstanceIdRequest as EmbedScriptByInstanceIdRequest, type context_EmbedScriptOptions as EmbedScriptOptions, type context_EmbedScriptRequest as EmbedScriptRequest, type context_EmbedScriptResponse as EmbedScriptResponse, type context_EmbedScriptResponseNonNullableFields as EmbedScriptResponseNonNullableFields, type context_GetEmbeddedScriptByInstanceIdRequest as GetEmbeddedScriptByInstanceIdRequest, type context_GetEmbeddedScriptOptions as GetEmbeddedScriptOptions, type context_GetEmbeddedScriptRequest as GetEmbeddedScriptRequest, type context_GetEmbeddedScriptResponse as GetEmbeddedScriptResponse, type context_GetEmbeddedScriptResponseNonNullableFields as GetEmbeddedScriptResponseNonNullableFields, type context_ScriptProperties as ScriptProperties, type context_ScriptPropertiesNonNullableFields as ScriptPropertiesNonNullableFields, type context__publicEmbedScriptType as _publicEmbedScriptType, type context__publicGetEmbeddedScriptType as _publicGetEmbeddedScriptType, context_embedScript as embedScript, context_getEmbeddedScript as getEmbeddedScript };
1223
1384
  }
1224
1385
 
1225
1386
  export { context$3 as appInstances, context$4 as appPlans, context$2 as biEvents, context$1 as billing, context as embeddedScripts };
@@ -1,10 +1,47 @@
1
- /**
2
- * An `appPlans` object describes how you charge users for using your app.
3
- * You can set up multiple plans for a single app, with different plans giving access to
4
- * different tiers of functionality. For example, you can offer a free plan and
5
- * 3 paid plans with an increasing number of benefits. Learn more about
6
- * [setting up your app pricing](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-your-app-pricing).
7
- */
1
+ type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
2
+ interface HttpClient {
3
+ request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
4
+ fetchWithAuth: typeof fetch;
5
+ wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
6
+ }
7
+ type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
8
+ type HttpResponse<T = any> = {
9
+ data: T;
10
+ status: number;
11
+ statusText: string;
12
+ headers: any;
13
+ request?: any;
14
+ };
15
+ type RequestOptions<_TResponse = any, Data = any> = {
16
+ method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
17
+ url: string;
18
+ data?: Data;
19
+ params?: URLSearchParams;
20
+ } & APIMetadata;
21
+ type APIMetadata = {
22
+ methodFqn?: string;
23
+ entityFqdn?: string;
24
+ packageName?: string;
25
+ };
26
+ type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
27
+ type EventDefinition<Payload = unknown, Type extends string = string> = {
28
+ __type: 'event-definition';
29
+ type: Type;
30
+ isDomainEvent?: boolean;
31
+ transformations?: (envelope: unknown) => Payload;
32
+ __payload: Payload;
33
+ };
34
+ declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
35
+ type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
36
+ type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
37
+
38
+ declare global {
39
+ // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
40
+ interface SymbolConstructor {
41
+ readonly observable: symbol;
42
+ }
43
+ }
44
+
8
45
  interface AppPlans {
9
46
  /** App ID, as defined in the [Wix Dev Center](https://dev.wix.com/). */
10
47
  _id?: string;
@@ -234,53 +271,44 @@ interface ListAppPlansByAppIdResponseNonNullableFields {
234
271
  appPlans: AppPlansNonNullableFields[];
235
272
  }
236
273
 
237
- type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
238
- interface HttpClient {
239
- request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
240
- fetchWithAuth: typeof fetch;
241
- wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
242
- }
243
- type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
244
- type HttpResponse<T = any> = {
245
- data: T;
246
- status: number;
247
- statusText: string;
248
- headers: any;
249
- request?: any;
250
- };
251
- type RequestOptions<_TResponse = any, Data = any> = {
252
- method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
253
- url: string;
254
- data?: Data;
255
- params?: URLSearchParams;
256
- } & APIMetadata;
257
- type APIMetadata = {
258
- methodFqn?: string;
259
- entityFqdn?: string;
260
- packageName?: string;
261
- };
262
- type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
263
- type EventDefinition<Payload = unknown, Type extends string = string> = {
264
- __type: 'event-definition';
265
- type: Type;
266
- isDomainEvent?: boolean;
267
- transformations?: (envelope: unknown) => Payload;
268
- __payload: Payload;
269
- };
270
- declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
271
- type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
272
- type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
273
-
274
- declare global {
275
- // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
276
- interface SymbolConstructor {
277
- readonly observable: symbol;
278
- }
274
+ declare function listAppPlansByAppId$1(httpClient: HttpClient): ListAppPlansByAppIdSignature;
275
+ interface ListAppPlansByAppIdSignature {
276
+ /**
277
+ * Retrieves plans for the given apps.
278
+ *
279
+ *
280
+ * Also returns tax settings and currency details. Wix calculates this information
281
+ * based on the 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
282
+ * format that you pass in the call's header. If you don't pass a country code in
283
+ * the header, Wix calculates the tax settings and currency details based on the
284
+ * call's IP address. Note that the tax settings and currency details may not resolve
285
+ * properly if you call through a VPN.
286
+ *
287
+ * Prices for plans that are managed outside of Wix aren't returned.
288
+ *
289
+ * Consumers must pay for yearly and multi-yearly plans of your app every month.
290
+ * For these plans this endpoint returns the price that the consumer must pay every
291
+ * month and not the total price for the entire year.
292
+ *
293
+ * <blockquote class="important">
294
+ *
295
+ * __Important:__
296
+ * The App Plans API doesn't follow any tenancy model. You don't need any
297
+ * permissions to call `List App Plans by App ID`.
298
+ *
299
+ * </blockquote>
300
+ * @param - List of app IDs to retrieve plans for.
301
+ *
302
+ * Min: 1 app ID
303
+ * Max: 100 app IDs
304
+ */
305
+ (appIds: string[]): Promise<ListAppPlansByAppIdResponse & ListAppPlansByAppIdResponseNonNullableFields>;
279
306
  }
280
307
 
281
308
  declare function createRESTModule$4<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
282
309
 
283
- declare const listAppPlansByAppId: ReturnType<typeof createRESTModule$4<typeof publicListAppPlansByAppId>>;
310
+ type _publicListAppPlansByAppIdType = typeof listAppPlansByAppId$1;
311
+ declare const listAppPlansByAppId: ReturnType<typeof createRESTModule$4<_publicListAppPlansByAppIdType>>;
284
312
 
285
313
  type index_d$4_AppPlans = AppPlans;
286
314
  type index_d$4_Cycle = Cycle;
@@ -298,9 +326,10 @@ type index_d$4_TaxSettings = TaxSettings;
298
326
  type index_d$4_TaxType = TaxType;
299
327
  declare const index_d$4_TaxType: typeof TaxType;
300
328
  type index_d$4_UsageBasedDetails = UsageBasedDetails;
329
+ type index_d$4__publicListAppPlansByAppIdType = _publicListAppPlansByAppIdType;
301
330
  declare const index_d$4_listAppPlansByAppId: typeof listAppPlansByAppId;
302
331
  declare namespace index_d$4 {
303
- export { type index_d$4_AppPlans as AppPlans, type index_d$4_Cycle as Cycle, index_d$4_CycleType as CycleType, type index_d$4_Duration as Duration, index_d$4_DurationUnit as DurationUnit, type index_d$4_ListAppPlansByAppIdRequest as ListAppPlansByAppIdRequest, type index_d$4_ListAppPlansByAppIdResponse as ListAppPlansByAppIdResponse, type index_d$4_ListAppPlansByAppIdResponseNonNullableFields as ListAppPlansByAppIdResponseNonNullableFields, type index_d$4_Plan as Plan, type index_d$4_Price as Price, type index_d$4_TaxSettings as TaxSettings, index_d$4_TaxType as TaxType, type index_d$4_UsageBasedDetails as UsageBasedDetails, index_d$4_listAppPlansByAppId as listAppPlansByAppId };
332
+ export { type index_d$4_AppPlans as AppPlans, type index_d$4_Cycle as Cycle, index_d$4_CycleType as CycleType, type index_d$4_Duration as Duration, index_d$4_DurationUnit as DurationUnit, type index_d$4_ListAppPlansByAppIdRequest as ListAppPlansByAppIdRequest, type index_d$4_ListAppPlansByAppIdResponse as ListAppPlansByAppIdResponse, type index_d$4_ListAppPlansByAppIdResponseNonNullableFields as ListAppPlansByAppIdResponseNonNullableFields, type index_d$4_Plan as Plan, type index_d$4_Price as Price, type index_d$4_TaxSettings as TaxSettings, index_d$4_TaxType as TaxType, type index_d$4_UsageBasedDetails as UsageBasedDetails, type index_d$4__publicListAppPlansByAppIdType as _publicListAppPlansByAppIdType, index_d$4_listAppPlansByAppId as listAppPlansByAppId };
304
333
  }
305
334
 
306
335
  /**
@@ -707,16 +736,66 @@ interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
707
736
  metadata: BaseEventMetadata;
708
737
  }
709
738
 
739
+ declare function getAppInstance$1(httpClient: HttpClient): GetAppInstanceSignature;
740
+ interface GetAppInstanceSignature {
741
+ /**
742
+ * Retrieves data about the instance of your app that's installed on the Wix
743
+ * site and the site itself.
744
+ *
745
+ *
746
+ * You don't have to explicitly pass an identifier for the Wix site as part of
747
+ * the request, since this information is taken automatically from the context.
748
+ *
749
+ * In case you want `site.ownerInfo` to be included in the response, you must
750
+ * have the __Read Site Owner Email__ permission scope in addition to
751
+ * __WIX_DEVELOPERS.MANAGE_APP_INSTANCE__.
752
+ */
753
+ (): Promise<GetAppInstanceResponse & GetAppInstanceResponseNonNullableFields>;
754
+ }
755
+ declare const onAppInstanceInstalled$1: EventDefinition<AppInstanceInstalledEnvelope, "AppInstalled">;
756
+ declare const onAppInstanceRemoved$1: EventDefinition<AppInstanceRemovedEnvelope, "AppRemoved">;
757
+ declare const onAppInstancePaidPlanPurchased$1: EventDefinition<AppInstancePaidPlanPurchasedEnvelope, "PaidPlanPurchased">;
758
+ declare const onAppInstancePaidPlanChanged$1: EventDefinition<AppInstancePaidPlanChangedEnvelope, "PaidPlanChanged">;
759
+ declare const onAppInstancePaidPlanAutoRenewalCancelled$1: EventDefinition<AppInstancePaidPlanAutoRenewalCancelledEnvelope, "PaidPlanAutoRenewalCancelled">;
760
+
710
761
  declare function createRESTModule$3<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
711
762
 
712
763
  declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
713
764
 
714
- declare const getAppInstance: ReturnType<typeof createRESTModule$3<typeof publicGetAppInstance>>;
715
- declare const onAppInstanceInstalled: ReturnType<typeof createEventModule<typeof publicOnAppInstanceInstalled>>;
716
- declare const onAppInstanceRemoved: ReturnType<typeof createEventModule<typeof publicOnAppInstanceRemoved>>;
717
- declare const onAppInstancePaidPlanPurchased: ReturnType<typeof createEventModule<typeof publicOnAppInstancePaidPlanPurchased>>;
718
- declare const onAppInstancePaidPlanChanged: ReturnType<typeof createEventModule<typeof publicOnAppInstancePaidPlanChanged>>;
719
- declare const onAppInstancePaidPlanAutoRenewalCancelled: ReturnType<typeof createEventModule<typeof publicOnAppInstancePaidPlanAutoRenewalCancelled>>;
765
+ type _publicGetAppInstanceType = typeof getAppInstance$1;
766
+ declare const getAppInstance: ReturnType<typeof createRESTModule$3<_publicGetAppInstanceType>>;
767
+
768
+ type _publicOnAppInstanceInstalledType = typeof onAppInstanceInstalled$1;
769
+ /**
770
+ * Triggered when an instance of your app is installed on a Wix site.
771
+ */
772
+ declare const onAppInstanceInstalled: ReturnType<typeof createEventModule<_publicOnAppInstanceInstalledType>>;
773
+
774
+ type _publicOnAppInstanceRemovedType = typeof onAppInstanceRemoved$1;
775
+ /**
776
+ * Triggered when an instance of your app is uninstalled from a Wix site.
777
+ */
778
+ declare const onAppInstanceRemoved: ReturnType<typeof createEventModule<_publicOnAppInstanceRemovedType>>;
779
+
780
+ type _publicOnAppInstancePaidPlanPurchasedType = typeof onAppInstancePaidPlanPurchased$1;
781
+ /**
782
+ * Triggered when a site owner purchases a paid plan for your app.
783
+ */
784
+ declare const onAppInstancePaidPlanPurchased: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanPurchasedType>>;
785
+
786
+ type _publicOnAppInstancePaidPlanChangedType = typeof onAppInstancePaidPlanChanged$1;
787
+ /**
788
+ * Triggered when a site owner upgrades or downgrades their plan for your app.
789
+ */
790
+ declare const onAppInstancePaidPlanChanged: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanChangedType>>;
791
+
792
+ type _publicOnAppInstancePaidPlanAutoRenewalCancelledType = typeof onAppInstancePaidPlanAutoRenewalCancelled$1;
793
+ /**
794
+ * Triggered when a site owner cancels a paid plan for your app. The
795
+ * site owner can continue to use your app until the end of the current billing
796
+ * cycle.
797
+ */
798
+ declare const onAppInstancePaidPlanAutoRenewalCancelled: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanAutoRenewalCancelledType>>;
720
799
 
721
800
  type index_d$3_AppInstalled = AppInstalled;
722
801
  type index_d$3_AppInstance = AppInstance;
@@ -746,6 +825,12 @@ type index_d$3_ResolutionMethod = ResolutionMethod;
746
825
  declare const index_d$3_ResolutionMethod: typeof ResolutionMethod;
747
826
  type index_d$3_SiteInfo = SiteInfo;
748
827
  type index_d$3_SupportedLanguage = SupportedLanguage;
828
+ type index_d$3__publicGetAppInstanceType = _publicGetAppInstanceType;
829
+ type index_d$3__publicOnAppInstanceInstalledType = _publicOnAppInstanceInstalledType;
830
+ type index_d$3__publicOnAppInstancePaidPlanAutoRenewalCancelledType = _publicOnAppInstancePaidPlanAutoRenewalCancelledType;
831
+ type index_d$3__publicOnAppInstancePaidPlanChangedType = _publicOnAppInstancePaidPlanChangedType;
832
+ type index_d$3__publicOnAppInstancePaidPlanPurchasedType = _publicOnAppInstancePaidPlanPurchasedType;
833
+ type index_d$3__publicOnAppInstanceRemovedType = _publicOnAppInstanceRemovedType;
749
834
  declare const index_d$3_getAppInstance: typeof getAppInstance;
750
835
  declare const index_d$3_onAppInstanceInstalled: typeof onAppInstanceInstalled;
751
836
  declare const index_d$3_onAppInstancePaidPlanAutoRenewalCancelled: typeof onAppInstancePaidPlanAutoRenewalCancelled;
@@ -753,7 +838,7 @@ declare const index_d$3_onAppInstancePaidPlanChanged: typeof onAppInstancePaidPl
753
838
  declare const index_d$3_onAppInstancePaidPlanPurchased: typeof onAppInstancePaidPlanPurchased;
754
839
  declare const index_d$3_onAppInstanceRemoved: typeof onAppInstanceRemoved;
755
840
  declare namespace index_d$3 {
756
- export { type index_d$3_AppInstalled as AppInstalled, type index_d$3_AppInstance as AppInstance, type index_d$3_AppInstanceInstalledEnvelope as AppInstanceInstalledEnvelope, type index_d$3_AppInstancePaidPlanAutoRenewalCancelledEnvelope as AppInstancePaidPlanAutoRenewalCancelledEnvelope, type index_d$3_AppInstancePaidPlanChangedEnvelope as AppInstancePaidPlanChangedEnvelope, type index_d$3_AppInstancePaidPlanPurchasedEnvelope as AppInstancePaidPlanPurchasedEnvelope, type index_d$3_AppInstanceRemovedEnvelope as AppInstanceRemovedEnvelope, type index_d$3_AppRemoved as AppRemoved, type index_d$3_AvailablePlan as AvailablePlan, type index_d$3_BaseEventMetadata as BaseEventMetadata, type index_d$3_BillingInfo as BillingInfo, type index_d$3_FreeTrialInfo as FreeTrialInfo, index_d$3_FreeTrialStatus as FreeTrialStatus, type index_d$3_GetAppInstanceByInstanceIdRequest as GetAppInstanceByInstanceIdRequest, type index_d$3_GetAppInstanceRequest as GetAppInstanceRequest, type index_d$3_GetAppInstanceResponse as GetAppInstanceResponse, type index_d$3_GetAppInstanceResponseNonNullableFields as GetAppInstanceResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type index_d$3_Locale as Locale, type MessageEnvelope$1 as MessageEnvelope, type index_d$3_Multilingual as Multilingual, type index_d$3_OwnerInfo as OwnerInfo, type index_d$3_PaidPlanAutoRenewalCancelled as PaidPlanAutoRenewalCancelled, type index_d$3_PaidPlanChanged as PaidPlanChanged, type index_d$3_PaidPlanPurchased as PaidPlanPurchased, PaymentCycle$1 as PaymentCycle, index_d$3_ResolutionMethod as ResolutionMethod, type index_d$3_SiteInfo as SiteInfo, type index_d$3_SupportedLanguage as SupportedLanguage, WebhookIdentityType$1 as WebhookIdentityType, index_d$3_getAppInstance as getAppInstance, index_d$3_onAppInstanceInstalled as onAppInstanceInstalled, index_d$3_onAppInstancePaidPlanAutoRenewalCancelled as onAppInstancePaidPlanAutoRenewalCancelled, index_d$3_onAppInstancePaidPlanChanged as onAppInstancePaidPlanChanged, index_d$3_onAppInstancePaidPlanPurchased as onAppInstancePaidPlanPurchased, index_d$3_onAppInstanceRemoved as onAppInstanceRemoved };
841
+ export { type index_d$3_AppInstalled as AppInstalled, type index_d$3_AppInstance as AppInstance, type index_d$3_AppInstanceInstalledEnvelope as AppInstanceInstalledEnvelope, type index_d$3_AppInstancePaidPlanAutoRenewalCancelledEnvelope as AppInstancePaidPlanAutoRenewalCancelledEnvelope, type index_d$3_AppInstancePaidPlanChangedEnvelope as AppInstancePaidPlanChangedEnvelope, type index_d$3_AppInstancePaidPlanPurchasedEnvelope as AppInstancePaidPlanPurchasedEnvelope, type index_d$3_AppInstanceRemovedEnvelope as AppInstanceRemovedEnvelope, type index_d$3_AppRemoved as AppRemoved, type index_d$3_AvailablePlan as AvailablePlan, type index_d$3_BaseEventMetadata as BaseEventMetadata, type index_d$3_BillingInfo as BillingInfo, type index_d$3_FreeTrialInfo as FreeTrialInfo, index_d$3_FreeTrialStatus as FreeTrialStatus, type index_d$3_GetAppInstanceByInstanceIdRequest as GetAppInstanceByInstanceIdRequest, type index_d$3_GetAppInstanceRequest as GetAppInstanceRequest, type index_d$3_GetAppInstanceResponse as GetAppInstanceResponse, type index_d$3_GetAppInstanceResponseNonNullableFields as GetAppInstanceResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type index_d$3_Locale as Locale, type MessageEnvelope$1 as MessageEnvelope, type index_d$3_Multilingual as Multilingual, type index_d$3_OwnerInfo as OwnerInfo, type index_d$3_PaidPlanAutoRenewalCancelled as PaidPlanAutoRenewalCancelled, type index_d$3_PaidPlanChanged as PaidPlanChanged, type index_d$3_PaidPlanPurchased as PaidPlanPurchased, PaymentCycle$1 as PaymentCycle, index_d$3_ResolutionMethod as ResolutionMethod, type index_d$3_SiteInfo as SiteInfo, type index_d$3_SupportedLanguage as SupportedLanguage, WebhookIdentityType$1 as WebhookIdentityType, type index_d$3__publicGetAppInstanceType as _publicGetAppInstanceType, type index_d$3__publicOnAppInstanceInstalledType as _publicOnAppInstanceInstalledType, type index_d$3__publicOnAppInstancePaidPlanAutoRenewalCancelledType as _publicOnAppInstancePaidPlanAutoRenewalCancelledType, type index_d$3__publicOnAppInstancePaidPlanChangedType as _publicOnAppInstancePaidPlanChangedType, type index_d$3__publicOnAppInstancePaidPlanPurchasedType as _publicOnAppInstancePaidPlanPurchasedType, type index_d$3__publicOnAppInstanceRemovedType as _publicOnAppInstanceRemovedType, index_d$3_getAppInstance as getAppInstance, index_d$3_onAppInstanceInstalled as onAppInstanceInstalled, index_d$3_onAppInstancePaidPlanAutoRenewalCancelled as onAppInstancePaidPlanAutoRenewalCancelled, index_d$3_onAppInstancePaidPlanChanged as onAppInstancePaidPlanChanged, index_d$3_onAppInstancePaidPlanPurchased as onAppInstancePaidPlanPurchased, index_d$3_onAppInstanceRemoved as onAppInstanceRemoved, onAppInstanceInstalled$1 as publicOnAppInstanceInstalled, onAppInstancePaidPlanAutoRenewalCancelled$1 as publicOnAppInstancePaidPlanAutoRenewalCancelled, onAppInstancePaidPlanChanged$1 as publicOnAppInstancePaidPlanChanged, onAppInstancePaidPlanPurchased$1 as publicOnAppInstancePaidPlanPurchased, onAppInstanceRemoved$1 as publicOnAppInstanceRemoved };
757
842
  }
758
843
 
759
844
  interface SendBIEventResponse {
@@ -844,18 +929,28 @@ interface SendBiEventOptions {
844
929
  eventData?: Record<string, string>;
845
930
  }
846
931
 
932
+ declare function sendBiEvent$1(httpClient: HttpClient): SendBiEventSignature;
933
+ interface SendBiEventSignature {
934
+ /**
935
+ * Submit a BI event to Wix.
936
+ */
937
+ (options?: SendBiEventOptions | undefined): Promise<void>;
938
+ }
939
+
847
940
  declare function createRESTModule$2<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
848
941
 
849
- declare const sendBiEvent: ReturnType<typeof createRESTModule$2<typeof publicSendBiEvent>>;
942
+ type _publicSendBiEventType = typeof sendBiEvent$1;
943
+ declare const sendBiEvent: ReturnType<typeof createRESTModule$2<_publicSendBiEventType>>;
850
944
 
851
945
  type index_d$2_EventName = EventName;
852
946
  declare const index_d$2_EventName: typeof EventName;
853
947
  type index_d$2_SendBIEventRequest = SendBIEventRequest;
854
948
  type index_d$2_SendBIEventResponse = SendBIEventResponse;
855
949
  type index_d$2_SendBiEventOptions = SendBiEventOptions;
950
+ type index_d$2__publicSendBiEventType = _publicSendBiEventType;
856
951
  declare const index_d$2_sendBiEvent: typeof sendBiEvent;
857
952
  declare namespace index_d$2 {
858
- export { index_d$2_EventName as EventName, type index_d$2_SendBIEventRequest as SendBIEventRequest, type index_d$2_SendBIEventResponse as SendBIEventResponse, type index_d$2_SendBiEventOptions as SendBiEventOptions, index_d$2_sendBiEvent as sendBiEvent };
953
+ export { index_d$2_EventName as EventName, type index_d$2_SendBIEventRequest as SendBIEventRequest, type index_d$2_SendBIEventResponse as SendBIEventResponse, type index_d$2_SendBiEventOptions as SendBiEventOptions, type index_d$2__publicSendBiEventType as _publicSendBiEventType, index_d$2_sendBiEvent as sendBiEvent };
859
954
  }
860
955
 
861
956
  interface PurchasedItem {
@@ -1111,10 +1206,44 @@ interface GetUrlOptions {
1111
1206
  couponCode?: string | null;
1112
1207
  }
1113
1208
 
1209
+ declare function getUrl$1(httpClient: HttpClient): GetUrlSignature;
1210
+ interface GetUrlSignature {
1211
+ /**
1212
+ * Retrieves the URL for a Wix checkout page for the specified paid plan of your app.
1213
+ *
1214
+ *
1215
+ * This call succeeds only in case you have previously
1216
+ * [set up an external pricing page in the Wix Developers Center](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-an-external-pricing-page).
1217
+ *
1218
+ * The returned checkout URL is valid for 48 hours.
1219
+ *
1220
+ * This API allows your app to manage your pricing page outside of Wix while
1221
+ * still using the standard Wix checkout flow.
1222
+ * @param - ID of your app's paid plan to retrieve the Wix checkout URL for. Check the
1223
+ * Wix Developers Center for a list of your app's supported product IDs.
1224
+ */
1225
+ (productId: string, options?: GetUrlOptions | undefined): Promise<GetUrlResponse & GetUrlResponseNonNullableFields>;
1226
+ }
1227
+ declare function getPurchaseHistory$1(httpClient: HttpClient): GetPurchaseHistorySignature;
1228
+ interface GetPurchaseHistorySignature {
1229
+ /**
1230
+ * Retrieves a list of the site owner's past purchases for your app.
1231
+ *
1232
+ *
1233
+ * You don't have to explicitly pass an identifier for the Wix site as part of
1234
+ * the request, since this information is taken automatically from the context.
1235
+ *
1236
+ * The response doesn't include any details about cancellations.
1237
+ */
1238
+ (): Promise<GetPurchaseHistoryResponse & GetPurchaseHistoryResponseNonNullableFields>;
1239
+ }
1240
+
1114
1241
  declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
1115
1242
 
1116
- declare const getUrl: ReturnType<typeof createRESTModule$1<typeof publicGetUrl>>;
1117
- declare const getPurchaseHistory: ReturnType<typeof createRESTModule$1<typeof publicGetPurchaseHistory>>;
1243
+ type _publicGetUrlType = typeof getUrl$1;
1244
+ declare const getUrl: ReturnType<typeof createRESTModule$1<_publicGetUrlType>>;
1245
+ type _publicGetPurchaseHistoryType = typeof getPurchaseHistory$1;
1246
+ declare const getPurchaseHistory: ReturnType<typeof createRESTModule$1<_publicGetPurchaseHistoryType>>;
1118
1247
 
1119
1248
  type index_d$1_Charge = Charge;
1120
1249
  type index_d$1_ChargeOverride = ChargeOverride;
@@ -1140,10 +1269,12 @@ declare const index_d$1_PaymentCycle: typeof PaymentCycle;
1140
1269
  type index_d$1_PurchasedItem = PurchasedItem;
1141
1270
  type index_d$1_WebhookIdentityType = WebhookIdentityType;
1142
1271
  declare const index_d$1_WebhookIdentityType: typeof WebhookIdentityType;
1272
+ type index_d$1__publicGetPurchaseHistoryType = _publicGetPurchaseHistoryType;
1273
+ type index_d$1__publicGetUrlType = _publicGetUrlType;
1143
1274
  declare const index_d$1_getPurchaseHistory: typeof getPurchaseHistory;
1144
1275
  declare const index_d$1_getUrl: typeof getUrl;
1145
1276
  declare namespace index_d$1 {
1146
- export { type index_d$1_Charge as Charge, type index_d$1_ChargeOverride as ChargeOverride, type index_d$1_GetMeteredBillingChargesRequest as GetMeteredBillingChargesRequest, type index_d$1_GetMeteredBillingChargesResponse as GetMeteredBillingChargesResponse, type index_d$1_GetPurchaseHistoryRequest as GetPurchaseHistoryRequest, type index_d$1_GetPurchaseHistoryResponse as GetPurchaseHistoryResponse, type index_d$1_GetPurchaseHistoryResponseNonNullableFields as GetPurchaseHistoryResponseNonNullableFields, type index_d$1_GetSitePaymentMethodsStatusRequest as GetSitePaymentMethodsStatusRequest, type index_d$1_GetSitePaymentMethodsStatusResponse as GetSitePaymentMethodsStatusResponse, type index_d$1_GetUrlOptions as GetUrlOptions, type index_d$1_GetUrlRequest as GetUrlRequest, type index_d$1_GetUrlResponse as GetUrlResponse, type index_d$1_GetUrlResponseNonNullableFields as GetUrlResponseNonNullableFields, type index_d$1_IdentificationData as IdentificationData, type index_d$1_IdentificationDataIdOneOf as IdentificationDataIdOneOf, index_d$1_InvoiceStatus as InvoiceStatus, type index_d$1_InvoiceStatusUpdate as InvoiceStatusUpdate, type index_d$1_MessageEnvelope as MessageEnvelope, index_d$1_PaymentCycle as PaymentCycle, type index_d$1_PurchasedItem as PurchasedItem, index_d$1_WebhookIdentityType as WebhookIdentityType, index_d$1_getPurchaseHistory as getPurchaseHistory, index_d$1_getUrl as getUrl };
1277
+ export { type index_d$1_Charge as Charge, type index_d$1_ChargeOverride as ChargeOverride, type index_d$1_GetMeteredBillingChargesRequest as GetMeteredBillingChargesRequest, type index_d$1_GetMeteredBillingChargesResponse as GetMeteredBillingChargesResponse, type index_d$1_GetPurchaseHistoryRequest as GetPurchaseHistoryRequest, type index_d$1_GetPurchaseHistoryResponse as GetPurchaseHistoryResponse, type index_d$1_GetPurchaseHistoryResponseNonNullableFields as GetPurchaseHistoryResponseNonNullableFields, type index_d$1_GetSitePaymentMethodsStatusRequest as GetSitePaymentMethodsStatusRequest, type index_d$1_GetSitePaymentMethodsStatusResponse as GetSitePaymentMethodsStatusResponse, type index_d$1_GetUrlOptions as GetUrlOptions, type index_d$1_GetUrlRequest as GetUrlRequest, type index_d$1_GetUrlResponse as GetUrlResponse, type index_d$1_GetUrlResponseNonNullableFields as GetUrlResponseNonNullableFields, type index_d$1_IdentificationData as IdentificationData, type index_d$1_IdentificationDataIdOneOf as IdentificationDataIdOneOf, index_d$1_InvoiceStatus as InvoiceStatus, type index_d$1_InvoiceStatusUpdate as InvoiceStatusUpdate, type index_d$1_MessageEnvelope as MessageEnvelope, index_d$1_PaymentCycle as PaymentCycle, type index_d$1_PurchasedItem as PurchasedItem, index_d$1_WebhookIdentityType as WebhookIdentityType, type index_d$1__publicGetPurchaseHistoryType as _publicGetPurchaseHistoryType, type index_d$1__publicGetUrlType as _publicGetUrlType, index_d$1_getPurchaseHistory as getPurchaseHistory, index_d$1_getUrl as getUrl };
1147
1278
  }
1148
1279
 
1149
1280
  /** Embedded script data */
@@ -1199,10 +1330,38 @@ interface GetEmbeddedScriptOptions {
1199
1330
  componentId?: string | null;
1200
1331
  }
1201
1332
 
1333
+ declare function embedScript$1(httpClient: HttpClient): EmbedScriptSignature;
1334
+ interface EmbedScriptSignature {
1335
+ /**
1336
+ * Inserts custom script tags into a site.
1337
+ *
1338
+ *
1339
+ * Your app must have an existing
1340
+ * [embedded script component](https://dev.wix.com/docs/build-apps/developer-tools/extensions/embedded-scripts),
1341
+ * with exactly matching parameter names.
1342
+ * @param - Details of the script to embed.
1343
+ */
1344
+ (properties: ScriptProperties, options?: EmbedScriptOptions | undefined): Promise<EmbedScriptResponse & EmbedScriptResponseNonNullableFields>;
1345
+ }
1346
+ declare function getEmbeddedScript$1(httpClient: HttpClient): GetEmbeddedScriptSignature;
1347
+ interface GetEmbeddedScriptSignature {
1348
+ /**
1349
+ * Retrieves information about your app's existing embedded script.
1350
+ *
1351
+ *
1352
+ * The call fails with `404` error in case your app doesn't include an
1353
+ * embedded script on the site.
1354
+ * @returns Details of the retrieved embedded script.
1355
+ */
1356
+ (options?: GetEmbeddedScriptOptions | undefined): Promise<ScriptProperties & ScriptPropertiesNonNullableFields>;
1357
+ }
1358
+
1202
1359
  declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
1203
1360
 
1204
- declare const embedScript: ReturnType<typeof createRESTModule<typeof publicEmbedScript>>;
1205
- declare const getEmbeddedScript: ReturnType<typeof createRESTModule<typeof publicGetEmbeddedScript>>;
1361
+ type _publicEmbedScriptType = typeof embedScript$1;
1362
+ declare const embedScript: ReturnType<typeof createRESTModule<_publicEmbedScriptType>>;
1363
+ type _publicGetEmbeddedScriptType = typeof getEmbeddedScript$1;
1364
+ declare const getEmbeddedScript: ReturnType<typeof createRESTModule<_publicGetEmbeddedScriptType>>;
1206
1365
 
1207
1366
  type index_d_EmbedScriptByInstanceIdRequest = EmbedScriptByInstanceIdRequest;
1208
1367
  type index_d_EmbedScriptOptions = EmbedScriptOptions;
@@ -1216,10 +1375,12 @@ type index_d_GetEmbeddedScriptResponse = GetEmbeddedScriptResponse;
1216
1375
  type index_d_GetEmbeddedScriptResponseNonNullableFields = GetEmbeddedScriptResponseNonNullableFields;
1217
1376
  type index_d_ScriptProperties = ScriptProperties;
1218
1377
  type index_d_ScriptPropertiesNonNullableFields = ScriptPropertiesNonNullableFields;
1378
+ type index_d__publicEmbedScriptType = _publicEmbedScriptType;
1379
+ type index_d__publicGetEmbeddedScriptType = _publicGetEmbeddedScriptType;
1219
1380
  declare const index_d_embedScript: typeof embedScript;
1220
1381
  declare const index_d_getEmbeddedScript: typeof getEmbeddedScript;
1221
1382
  declare namespace index_d {
1222
- export { type index_d_EmbedScriptByInstanceIdRequest as EmbedScriptByInstanceIdRequest, type index_d_EmbedScriptOptions as EmbedScriptOptions, type index_d_EmbedScriptRequest as EmbedScriptRequest, type index_d_EmbedScriptResponse as EmbedScriptResponse, type index_d_EmbedScriptResponseNonNullableFields as EmbedScriptResponseNonNullableFields, type index_d_GetEmbeddedScriptByInstanceIdRequest as GetEmbeddedScriptByInstanceIdRequest, type index_d_GetEmbeddedScriptOptions as GetEmbeddedScriptOptions, type index_d_GetEmbeddedScriptRequest as GetEmbeddedScriptRequest, type index_d_GetEmbeddedScriptResponse as GetEmbeddedScriptResponse, type index_d_GetEmbeddedScriptResponseNonNullableFields as GetEmbeddedScriptResponseNonNullableFields, type index_d_ScriptProperties as ScriptProperties, type index_d_ScriptPropertiesNonNullableFields as ScriptPropertiesNonNullableFields, index_d_embedScript as embedScript, index_d_getEmbeddedScript as getEmbeddedScript };
1383
+ export { type index_d_EmbedScriptByInstanceIdRequest as EmbedScriptByInstanceIdRequest, type index_d_EmbedScriptOptions as EmbedScriptOptions, type index_d_EmbedScriptRequest as EmbedScriptRequest, type index_d_EmbedScriptResponse as EmbedScriptResponse, type index_d_EmbedScriptResponseNonNullableFields as EmbedScriptResponseNonNullableFields, type index_d_GetEmbeddedScriptByInstanceIdRequest as GetEmbeddedScriptByInstanceIdRequest, type index_d_GetEmbeddedScriptOptions as GetEmbeddedScriptOptions, type index_d_GetEmbeddedScriptRequest as GetEmbeddedScriptRequest, type index_d_GetEmbeddedScriptResponse as GetEmbeddedScriptResponse, type index_d_GetEmbeddedScriptResponseNonNullableFields as GetEmbeddedScriptResponseNonNullableFields, type index_d_ScriptProperties as ScriptProperties, type index_d_ScriptPropertiesNonNullableFields as ScriptPropertiesNonNullableFields, type index_d__publicEmbedScriptType as _publicEmbedScriptType, type index_d__publicGetEmbeddedScriptType as _publicGetEmbeddedScriptType, index_d_embedScript as embedScript, index_d_getEmbeddedScript as getEmbeddedScript };
1223
1384
  }
1224
1385
 
1225
1386
  export { index_d$3 as appInstances, index_d$4 as appPlans, index_d$2 as biEvents, index_d$1 as billing, index_d as embeddedScripts };
@@ -1,10 +1,3 @@
1
- /**
2
- * An `appPlans` object describes how you charge users for using your app.
3
- * You can set up multiple plans for a single app, with different plans giving access to
4
- * different tiers of functionality. For example, you can offer a free plan and
5
- * 3 paid plans with an increasing number of benefits. Learn more about
6
- * [setting up your app pricing](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-your-app-pricing).
7
- */
8
1
  interface AppPlans$1 {
9
2
  /** App ID, as defined in the [Wix Dev Center](https://dev.wix.com/). */
10
3
  id?: string;
@@ -234,13 +227,6 @@ interface ListAppPlansByAppIdResponseNonNullableFields$1 {
234
227
  appPlans: AppPlansNonNullableFields$1[];
235
228
  }
236
229
 
237
- /**
238
- * An `appPlans` object describes how you charge users for using your app.
239
- * You can set up multiple plans for a single app, with different plans giving access to
240
- * different tiers of functionality. For example, you can offer a free plan and
241
- * 3 paid plans with an increasing number of benefits. Learn more about
242
- * [setting up your app pricing](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-your-app-pricing).
243
- */
244
230
  interface AppPlans {
245
231
  /** App ID, as defined in the [Wix Dev Center](https://dev.wix.com/). */
246
232
  _id?: string;
@@ -298,9 +298,38 @@ declare global {
298
298
  }
299
299
  }
300
300
 
301
+ interface GetChargeLimitEnvelope {
302
+ request: GetChargeLimitRequest;
303
+ metadata: Context;
304
+ }
305
+ interface ListChargesEnvelope {
306
+ request: ListChargesRequest;
307
+ metadata: Context;
308
+ }
309
+ interface ChargesRejectedEventEnvelope {
310
+ request: ChargesRejectedRequest;
311
+ metadata: Context;
312
+ }
313
+ interface InvoiceCreatedEventEnvelope {
314
+ request: InvoiceCreatedRequest;
315
+ metadata: Context;
316
+ }
317
+ interface ChargeLimitUpdatedEventEnvelope {
318
+ request: ChargeLimitUpdatedRequest;
319
+ metadata: Context;
320
+ }
321
+ declare const provideHandlers$1: ServicePluginDefinition<{
322
+ getChargeLimit(payload: GetChargeLimitEnvelope): GetChargeLimitResponse | Promise<GetChargeLimitResponse>;
323
+ listCharges(payload: ListChargesEnvelope): ListChargesResponse | Promise<ListChargesResponse>;
324
+ chargesRejectedEvent(payload: ChargesRejectedEventEnvelope): ChargesRejectedResponse | Promise<ChargesRejectedResponse>;
325
+ invoiceCreatedEvent(payload: InvoiceCreatedEventEnvelope): InvoiceCreatedResponse | Promise<InvoiceCreatedResponse>;
326
+ chargeLimitUpdatedEvent(payload: ChargeLimitUpdatedEventEnvelope): ChargeLimitUpdatedResponse | Promise<ChargeLimitUpdatedResponse>;
327
+ }>;
328
+
301
329
  declare function createServicePluginModule<T extends ServicePluginDefinition<any>>(servicePluginDefinition: T): BuildServicePluginDefinition<T> & T;
302
330
 
303
- declare const provideHandlers: ReturnType<typeof createServicePluginModule<typeof publicProvideHandlers>>;
331
+ type _publicProvideHandlersType = typeof provideHandlers$1;
332
+ declare const provideHandlers: ReturnType<typeof createServicePluginModule<_publicProvideHandlersType>>;
304
333
 
305
334
  type context_AlternativeUri = AlternativeUri;
306
335
  type context_ChargeLimitUpdatedRequest = ChargeLimitUpdatedRequest;
@@ -326,9 +355,10 @@ type context_InvoiceLineItem = InvoiceLineItem;
326
355
  type context_ListChargesRequest = ListChargesRequest;
327
356
  type context_ListChargesResponse = ListChargesResponse;
328
357
  type context_SpiBaseUri = SpiBaseUri;
358
+ type context__publicProvideHandlersType = _publicProvideHandlersType;
329
359
  declare const context_provideHandlers: typeof provideHandlers;
330
360
  declare namespace context {
331
- export { type context_AlternativeUri as AlternativeUri, type context_ChargeLimitUpdatedRequest as ChargeLimitUpdatedRequest, type context_ChargeLimitUpdatedResponse as ChargeLimitUpdatedResponse, type context_ChargeLineItem as ChargeLineItem, context_ChargesRejectedReason as ChargesRejectedReason, type context_ChargesRejectedRequest as ChargesRejectedRequest, type context_ChargesRejectedResponse as ChargesRejectedResponse, type context_Context as Context, type context_CustomChargesConfig as CustomChargesConfig, type context_GetChargeLimitRequest as GetChargeLimitRequest, type context_GetChargeLimitResponse as GetChargeLimitResponse, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, context_IdentityType as IdentityType, context_Intent as Intent, type context_InvoiceCreatedRequest as InvoiceCreatedRequest, type context_InvoiceCreatedResponse as InvoiceCreatedResponse, type context_InvoiceLineItem as InvoiceLineItem, type context_ListChargesRequest as ListChargesRequest, type context_ListChargesResponse as ListChargesResponse, type context_SpiBaseUri as SpiBaseUri, context_provideHandlers as provideHandlers };
361
+ export { type context_AlternativeUri as AlternativeUri, type context_ChargeLimitUpdatedRequest as ChargeLimitUpdatedRequest, type context_ChargeLimitUpdatedResponse as ChargeLimitUpdatedResponse, type context_ChargeLineItem as ChargeLineItem, context_ChargesRejectedReason as ChargesRejectedReason, type context_ChargesRejectedRequest as ChargesRejectedRequest, type context_ChargesRejectedResponse as ChargesRejectedResponse, type context_Context as Context, type context_CustomChargesConfig as CustomChargesConfig, type context_GetChargeLimitRequest as GetChargeLimitRequest, type context_GetChargeLimitResponse as GetChargeLimitResponse, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, context_IdentityType as IdentityType, context_Intent as Intent, type context_InvoiceCreatedRequest as InvoiceCreatedRequest, type context_InvoiceCreatedResponse as InvoiceCreatedResponse, type context_InvoiceLineItem as InvoiceLineItem, type context_ListChargesRequest as ListChargesRequest, type context_ListChargesResponse as ListChargesResponse, type context_SpiBaseUri as SpiBaseUri, type context__publicProvideHandlersType as _publicProvideHandlersType, context_provideHandlers as provideHandlers, provideHandlers$1 as publicProvideHandlers };
332
362
  }
333
363
 
334
364
  export { context as customCharges };