@wix/app-management 1.0.30 → 1.0.31

package/build/cjs/index.d.ts

@@ -1,5 +1,6 @@
-export * as appPlans from '@wix/app-management_app-plans';
-export * as appInstances from '@wix/app-management_app-instances';
-export * as biEvents from '@wix/app-management_bi-events';
-export * as billing from '@wix/app-management_billing';
-export * as embeddedScripts from '@wix/app-management_embedded-scripts';
+import * as appPlans from '@wix/app-management_app-plans';
+import * as appInstances from '@wix/app-management_app-instances';
+import * as biEvents from '@wix/app-management_bi-events';
+import * as billing from '@wix/app-management_billing';
+import * as embeddedScripts from '@wix/app-management_embedded-scripts';
+export { appPlans, appInstances, biEvents, billing, embeddedScripts };

package/build/cjs/index.js

@@ -24,9 +24,14 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.embeddedScripts = exports.billing = exports.biEvents = exports.appInstances = exports.appPlans = void 0;
-exports.appPlans = __importStar(require("@wix/app-management_app-plans"));
-exports.appInstances = __importStar(require("@wix/app-management_app-instances"));
-exports.biEvents = __importStar(require("@wix/app-management_bi-events"));
-exports.billing = __importStar(require("@wix/app-management_billing"));
-exports.embeddedScripts = __importStar(require("@wix/app-management_embedded-scripts"));
+const appPlans = __importStar(require("@wix/app-management_app-plans"));
+exports.appPlans = appPlans;
+const appInstances = __importStar(require("@wix/app-management_app-instances"));
+exports.appInstances = appInstances;
+const biEvents = __importStar(require("@wix/app-management_bi-events"));
+exports.biEvents = biEvents;
+const billing = __importStar(require("@wix/app-management_billing"));
+exports.billing = billing;
+const embeddedScripts = __importStar(require("@wix/app-management_embedded-scripts"));
+exports.embeddedScripts = embeddedScripts;
 //# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0EAA0D;AAC1D,kFAAkE;AAClE,0EAA0D;AAC1D,uEAAuD;AACvD,wFAAwE"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,wEAA0D;AAMjD,4BAAQ;AALjB,gFAAkE;AAK/C,oCAAY;AAJ/B,wEAA0D;AAIzB,4BAAQ;AAHzC,qEAAuD;AAGZ,0BAAO;AAFlD,sFAAwE;AAEpB,0CAAe"}

package/build/es/index.d.ts

@@ -1,5 +1,6 @@
-export * as appPlans from '@wix/app-management_app-plans';
-export * as appInstances from '@wix/app-management_app-instances';
-export * as biEvents from '@wix/app-management_bi-events';
-export * as billing from '@wix/app-management_billing';
-export * as embeddedScripts from '@wix/app-management_embedded-scripts';
+import * as appPlans from '@wix/app-management_app-plans';
+import * as appInstances from '@wix/app-management_app-instances';
+import * as biEvents from '@wix/app-management_bi-events';
+import * as billing from '@wix/app-management_billing';
+import * as embeddedScripts from '@wix/app-management_embedded-scripts';
+export { appPlans, appInstances, biEvents, billing, embeddedScripts };

package/build/es/index.js

@@ -1,6 +1,7 @@
-export * as appPlans from '@wix/app-management_app-plans';
-export * as appInstances from '@wix/app-management_app-instances';
-export * as biEvents from '@wix/app-management_bi-events';
-export * as billing from '@wix/app-management_billing';
-export * as embeddedScripts from '@wix/app-management_embedded-scripts';
+import * as appPlans from '@wix/app-management_app-plans';
+import * as appInstances from '@wix/app-management_app-instances';
+import * as biEvents from '@wix/app-management_bi-events';
+import * as billing from '@wix/app-management_billing';
+import * as embeddedScripts from '@wix/app-management_embedded-scripts';
+export { appPlans, appInstances, biEvents, billing, embeddedScripts };
 //# sourceMappingURL=index.js.map

package/build/es/index.js.map

@@ -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"}
+{"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

@@ -1,6 +1,6 @@
 {
   "name": "@wix/app-management",
-  "version": "1.0.30",
+  "version": "1.0.31",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -19,12 +19,12 @@
     "service-plugins"
   ],
   "dependencies": {
-    "@wix/app-management_app-instances": "1.0.16",
-    "@wix/app-management_app-plans": "1.0.16",
-    "@wix/app-management_bi-events": "1.0.15",
-    "@wix/app-management_billing": "1.0.16",
+    "@wix/app-management_app-instances": "1.0.17",
+    "@wix/app-management_app-plans": "1.0.17",
+    "@wix/app-management_bi-events": "1.0.16",
+    "@wix/app-management_billing": "1.0.17",
     "@wix/app-management_custom-charges": "1.0.14",
-    "@wix/app-management_embedded-scripts": "1.0.13"
+    "@wix/app-management_embedded-scripts": "1.0.14"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -49,5 +49,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "c4c0e29043bcbcef96d15a9644c4df19956fcb419059a6b6d0c43af3"
+  "falconPackageHash": "2706f85ff49e879a3fdb9c6f6bb9361bd5ca377d95fdc9389c4caa57"
 }

package/type-bundles/context.bundle.d.ts

@@ -1,10 +1,47 @@
-/**
- * An `appPlans` object describes how you charge users for using your app.
- * You can set up multiple plans for a single app, with different plans giving access to
- * different tiers of functionality. For example, you can offer a free plan and
- * 3 paid plans with an increasing number of benefits. Learn more about
- * [setting up your app pricing](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-your-app-pricing).
- */
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+    fetchWithAuth: typeof fetch;
+    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: (envelope: unknown) => Payload;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
 interface AppPlans {
     /** App ID, as defined in the [Wix Dev Center](https://dev.wix.com/). */
     _id?: string;
@@ -234,52 +271,40 @@ interface ListAppPlansByAppIdResponseNonNullableFields {
     appPlans: AppPlansNonNullableFields[];
 }
 
-type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
-interface HttpClient {
-    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
-    fetchWithAuth: typeof fetch;
-    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
-}
-type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
-type HttpResponse<T = any> = {
-    data: T;
-    status: number;
-    statusText: string;
-    headers: any;
-    request?: any;
-};
-type RequestOptions<_TResponse = any, Data = any> = {
-    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
-    url: string;
-    data?: Data;
-    params?: URLSearchParams;
-} & APIMetadata;
-type APIMetadata = {
-    methodFqn?: string;
-    entityFqdn?: string;
-    packageName?: string;
-};
-type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
-type EventDefinition<Payload = unknown, Type extends string = string> = {
-    __type: 'event-definition';
-    type: Type;
-    isDomainEvent?: boolean;
-    transformations?: (envelope: unknown) => Payload;
-    __payload: Payload;
-};
-declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
-type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
-type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
-
-declare global {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
+declare function listAppPlansByAppId$1(httpClient: HttpClient): ListAppPlansByAppIdSignature;
+interface ListAppPlansByAppIdSignature {
+    /**
+     * Retrieves plans for the given apps.
+     *
+     *
+     * Also returns tax settings and currency details. Wix calculates this information
+     * 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)
+     * format that you pass in the call's header. If you don't pass a country code in
+     * the header, Wix calculates the tax settings and currency details based on the
+     * call's IP address. Note that the tax settings and currency details may not resolve
+     * properly if you call through a VPN.
+     *
+     * Prices for plans that are managed outside of Wix aren't returned.
+     *
+     * Consumers must pay for yearly and multi-yearly plans of your app every month.
+     * For these plans this endpoint returns the price that the consumer must pay every
+     * month and not the total price for the entire year.
+     *
+     * <blockquote class="important">
+     *
+     * __Important:__
+     * The App Plans API doesn't follow any tenancy model. You don't need any
+     * permissions to call `List App Plans by App ID`.
+     *
+     * </blockquote>
+     * @param - List of app IDs to retrieve plans for.
+     *
+     * Min: 1 app ID
+     * Max: 100 app IDs
+     */
+    (appIds: string[]): Promise<ListAppPlansByAppIdResponse & ListAppPlansByAppIdResponseNonNullableFields>;
 }
 
-declare function listAppPlansByAppId$1(httpClient: HttpClient): (appIds: string[]) => Promise<ListAppPlansByAppIdResponse & ListAppPlansByAppIdResponseNonNullableFields>;
-
 declare function createRESTModule$4<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
 type _publicListAppPlansByAppIdType = typeof listAppPlansByAppId$1;
@@ -711,7 +736,22 @@ interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
     metadata: BaseEventMetadata;
 }
 
-declare function getAppInstance$1(httpClient: HttpClient): () => Promise<GetAppInstanceResponse & GetAppInstanceResponseNonNullableFields>;
+declare function getAppInstance$1(httpClient: HttpClient): GetAppInstanceSignature;
+interface GetAppInstanceSignature {
+    /**
+     * Retrieves data about the instance of your app that's installed on the Wix
+     * site and the site itself.
+     *
+     *
+     * You don't have to explicitly pass an identifier for the Wix site as part of
+     * the request, since this information is taken automatically from the context.
+     *
+     * In case you want `site.ownerInfo` to be included in the response, you must
+     * have the __Read Site Owner Email__ permission scope in addition to
+     * __WIX_DEVELOPERS.MANAGE_APP_INSTANCE__.
+     */
+    (): Promise<GetAppInstanceResponse & GetAppInstanceResponseNonNullableFields>;
+}
 declare const onAppInstanceInstalled$1: EventDefinition<AppInstanceInstalledEnvelope, "AppInstalled">;
 declare const onAppInstanceRemoved$1: EventDefinition<AppInstanceRemovedEnvelope, "AppRemoved">;
 declare const onAppInstancePaidPlanPurchased$1: EventDefinition<AppInstancePaidPlanPurchasedEnvelope, "PaidPlanPurchased">;
@@ -726,18 +766,35 @@ type _publicGetAppInstanceType = typeof getAppInstance$1;
 declare const getAppInstance: ReturnType<typeof createRESTModule$3<_publicGetAppInstanceType>>;
 
 type _publicOnAppInstanceInstalledType = typeof onAppInstanceInstalled$1;
+/**
+ * Triggered when an instance of your app is installed on a Wix site.
+ */
 declare const onAppInstanceInstalled: ReturnType<typeof createEventModule<_publicOnAppInstanceInstalledType>>;
 
 type _publicOnAppInstanceRemovedType = typeof onAppInstanceRemoved$1;
+/**
+ * Triggered when an instance of your app is uninstalled from a Wix site.
+ */
 declare const onAppInstanceRemoved: ReturnType<typeof createEventModule<_publicOnAppInstanceRemovedType>>;
 
 type _publicOnAppInstancePaidPlanPurchasedType = typeof onAppInstancePaidPlanPurchased$1;
+/**
+ * Triggered when a site owner purchases a paid plan for your app.
+ */
 declare const onAppInstancePaidPlanPurchased: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanPurchasedType>>;
 
 type _publicOnAppInstancePaidPlanChangedType = typeof onAppInstancePaidPlanChanged$1;
+/**
+ * Triggered when a site owner upgrades or downgrades their plan for your app.
+ */
 declare const onAppInstancePaidPlanChanged: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanChangedType>>;
 
 type _publicOnAppInstancePaidPlanAutoRenewalCancelledType = typeof onAppInstancePaidPlanAutoRenewalCancelled$1;
+/**
+ * Triggered when a site owner cancels a paid plan for your app. The
+ * site owner can continue to use your app until the end of the current billing
+ * cycle.
+ */
 declare const onAppInstancePaidPlanAutoRenewalCancelled: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanAutoRenewalCancelledType>>;
 
 type context$3_AppInstalled = AppInstalled;
@@ -872,7 +929,13 @@ interface SendBiEventOptions {
     eventData?: Record<string, string>;
 }
 
-declare function sendBiEvent$1(httpClient: HttpClient): (options?: SendBiEventOptions) => Promise<void>;
+declare function sendBiEvent$1(httpClient: HttpClient): SendBiEventSignature;
+interface SendBiEventSignature {
+    /**
+     * Submit a BI event to Wix.
+     */
+    (options?: SendBiEventOptions | undefined): Promise<void>;
+}
 
 declare function createRESTModule$2<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
@@ -1143,8 +1206,37 @@ interface GetUrlOptions {
     couponCode?: string | null;
 }
 
-declare function getUrl$1(httpClient: HttpClient): (productId: string, options?: GetUrlOptions) => Promise<GetUrlResponse & GetUrlResponseNonNullableFields>;
-declare function getPurchaseHistory$1(httpClient: HttpClient): () => Promise<GetPurchaseHistoryResponse & GetPurchaseHistoryResponseNonNullableFields>;
+declare function getUrl$1(httpClient: HttpClient): GetUrlSignature;
+interface GetUrlSignature {
+    /**
+     * Retrieves the URL for a Wix checkout page for the specified paid plan of your app.
+     *
+     *
+     * This call succeeds only in case you have previously
+     * [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).
+     *
+     * The returned checkout URL is valid for 48 hours.
+     *
+     * This API allows your app to manage your pricing page outside of Wix while
+     * still using the standard Wix checkout flow.
+     * @param - ID of your app's paid plan to retrieve the Wix checkout URL for. Check the
+     * Wix Developers Center for a list of your app's supported product IDs.
+     */
+    (productId: string, options?: GetUrlOptions | undefined): Promise<GetUrlResponse & GetUrlResponseNonNullableFields>;
+}
+declare function getPurchaseHistory$1(httpClient: HttpClient): GetPurchaseHistorySignature;
+interface GetPurchaseHistorySignature {
+    /**
+     * Retrieves a list of the site owner's past purchases for your app.
+     *
+     *
+     * You don't have to explicitly pass an identifier for the Wix site as part of
+     * the request, since this information is taken automatically from the context.
+     *
+     * The response doesn't include any details about cancellations.
+     */
+    (): Promise<GetPurchaseHistoryResponse & GetPurchaseHistoryResponseNonNullableFields>;
+}
 
 declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
@@ -1238,8 +1330,31 @@ interface GetEmbeddedScriptOptions {
     componentId?: string | null;
 }
 
-declare function embedScript$1(httpClient: HttpClient): (properties: ScriptProperties, options?: EmbedScriptOptions) => Promise<EmbedScriptResponse & EmbedScriptResponseNonNullableFields>;
-declare function getEmbeddedScript$1(httpClient: HttpClient): (options?: GetEmbeddedScriptOptions) => Promise<ScriptProperties & ScriptPropertiesNonNullableFields>;
+declare function embedScript$1(httpClient: HttpClient): EmbedScriptSignature;
+interface EmbedScriptSignature {
+    /**
+     * Inserts custom script tags into a site.
+     *
+     *
+     * Your app must have an existing
+     * [embedded script component](https://dev.wix.com/docs/build-apps/developer-tools/extensions/embedded-scripts),
+     * with exactly matching parameter names.
+     * @param - Details of the script to embed.
+     */
+    (properties: ScriptProperties, options?: EmbedScriptOptions | undefined): Promise<EmbedScriptResponse & EmbedScriptResponseNonNullableFields>;
+}
+declare function getEmbeddedScript$1(httpClient: HttpClient): GetEmbeddedScriptSignature;
+interface GetEmbeddedScriptSignature {
+    /**
+     * Retrieves information about your app's existing embedded script.
+     *
+     *
+     * The call fails with `404` error in case your app doesn't include an
+     * embedded script on the site.
+     * @returns Details of the retrieved embedded script.
+     */
+    (options?: GetEmbeddedScriptOptions | undefined): Promise<ScriptProperties & ScriptPropertiesNonNullableFields>;
+}
 
 declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 

package/type-bundles/index.bundle.d.ts

@@ -1,10 +1,47 @@
-/**
- * An `appPlans` object describes how you charge users for using your app.
- * You can set up multiple plans for a single app, with different plans giving access to
- * different tiers of functionality. For example, you can offer a free plan and
- * 3 paid plans with an increasing number of benefits. Learn more about
- * [setting up your app pricing](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-your-app-pricing).
- */
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+    fetchWithAuth: typeof fetch;
+    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: (envelope: unknown) => Payload;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
 interface AppPlans {
     /** App ID, as defined in the [Wix Dev Center](https://dev.wix.com/). */
     _id?: string;
@@ -234,52 +271,40 @@ interface ListAppPlansByAppIdResponseNonNullableFields {
     appPlans: AppPlansNonNullableFields[];
 }
 
-type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
-interface HttpClient {
-    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
-    fetchWithAuth: typeof fetch;
-    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
-}
-type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
-type HttpResponse<T = any> = {
-    data: T;
-    status: number;
-    statusText: string;
-    headers: any;
-    request?: any;
-};
-type RequestOptions<_TResponse = any, Data = any> = {
-    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
-    url: string;
-    data?: Data;
-    params?: URLSearchParams;
-} & APIMetadata;
-type APIMetadata = {
-    methodFqn?: string;
-    entityFqdn?: string;
-    packageName?: string;
-};
-type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
-type EventDefinition<Payload = unknown, Type extends string = string> = {
-    __type: 'event-definition';
-    type: Type;
-    isDomainEvent?: boolean;
-    transformations?: (envelope: unknown) => Payload;
-    __payload: Payload;
-};
-declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
-type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
-type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
-
-declare global {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
+declare function listAppPlansByAppId$1(httpClient: HttpClient): ListAppPlansByAppIdSignature;
+interface ListAppPlansByAppIdSignature {
+    /**
+     * Retrieves plans for the given apps.
+     *
+     *
+     * Also returns tax settings and currency details. Wix calculates this information
+     * 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)
+     * format that you pass in the call's header. If you don't pass a country code in
+     * the header, Wix calculates the tax settings and currency details based on the
+     * call's IP address. Note that the tax settings and currency details may not resolve
+     * properly if you call through a VPN.
+     *
+     * Prices for plans that are managed outside of Wix aren't returned.
+     *
+     * Consumers must pay for yearly and multi-yearly plans of your app every month.
+     * For these plans this endpoint returns the price that the consumer must pay every
+     * month and not the total price for the entire year.
+     *
+     * <blockquote class="important">
+     *
+     * __Important:__
+     * The App Plans API doesn't follow any tenancy model. You don't need any
+     * permissions to call `List App Plans by App ID`.
+     *
+     * </blockquote>
+     * @param - List of app IDs to retrieve plans for.
+     *
+     * Min: 1 app ID
+     * Max: 100 app IDs
+     */
+    (appIds: string[]): Promise<ListAppPlansByAppIdResponse & ListAppPlansByAppIdResponseNonNullableFields>;
 }
 
-declare function listAppPlansByAppId$1(httpClient: HttpClient): (appIds: string[]) => Promise<ListAppPlansByAppIdResponse & ListAppPlansByAppIdResponseNonNullableFields>;
-
 declare function createRESTModule$4<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
 type _publicListAppPlansByAppIdType = typeof listAppPlansByAppId$1;
@@ -711,7 +736,22 @@ interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
     metadata: BaseEventMetadata;
 }
 
-declare function getAppInstance$1(httpClient: HttpClient): () => Promise<GetAppInstanceResponse & GetAppInstanceResponseNonNullableFields>;
+declare function getAppInstance$1(httpClient: HttpClient): GetAppInstanceSignature;
+interface GetAppInstanceSignature {
+    /**
+     * Retrieves data about the instance of your app that's installed on the Wix
+     * site and the site itself.
+     *
+     *
+     * You don't have to explicitly pass an identifier for the Wix site as part of
+     * the request, since this information is taken automatically from the context.
+     *
+     * In case you want `site.ownerInfo` to be included in the response, you must
+     * have the __Read Site Owner Email__ permission scope in addition to
+     * __WIX_DEVELOPERS.MANAGE_APP_INSTANCE__.
+     */
+    (): Promise<GetAppInstanceResponse & GetAppInstanceResponseNonNullableFields>;
+}
 declare const onAppInstanceInstalled$1: EventDefinition<AppInstanceInstalledEnvelope, "AppInstalled">;
 declare const onAppInstanceRemoved$1: EventDefinition<AppInstanceRemovedEnvelope, "AppRemoved">;
 declare const onAppInstancePaidPlanPurchased$1: EventDefinition<AppInstancePaidPlanPurchasedEnvelope, "PaidPlanPurchased">;
@@ -726,18 +766,35 @@ type _publicGetAppInstanceType = typeof getAppInstance$1;
 declare const getAppInstance: ReturnType<typeof createRESTModule$3<_publicGetAppInstanceType>>;
 
 type _publicOnAppInstanceInstalledType = typeof onAppInstanceInstalled$1;
+/**
+ * Triggered when an instance of your app is installed on a Wix site.
+ */
 declare const onAppInstanceInstalled: ReturnType<typeof createEventModule<_publicOnAppInstanceInstalledType>>;
 
 type _publicOnAppInstanceRemovedType = typeof onAppInstanceRemoved$1;
+/**
+ * Triggered when an instance of your app is uninstalled from a Wix site.
+ */
 declare const onAppInstanceRemoved: ReturnType<typeof createEventModule<_publicOnAppInstanceRemovedType>>;
 
 type _publicOnAppInstancePaidPlanPurchasedType = typeof onAppInstancePaidPlanPurchased$1;
+/**
+ * Triggered when a site owner purchases a paid plan for your app.
+ */
 declare const onAppInstancePaidPlanPurchased: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanPurchasedType>>;
 
 type _publicOnAppInstancePaidPlanChangedType = typeof onAppInstancePaidPlanChanged$1;
+/**
+ * Triggered when a site owner upgrades or downgrades their plan for your app.
+ */
 declare const onAppInstancePaidPlanChanged: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanChangedType>>;
 
 type _publicOnAppInstancePaidPlanAutoRenewalCancelledType = typeof onAppInstancePaidPlanAutoRenewalCancelled$1;
+/**
+ * Triggered when a site owner cancels a paid plan for your app. The
+ * site owner can continue to use your app until the end of the current billing
+ * cycle.
+ */
 declare const onAppInstancePaidPlanAutoRenewalCancelled: ReturnType<typeof createEventModule<_publicOnAppInstancePaidPlanAutoRenewalCancelledType>>;
 
 type index_d$3_AppInstalled = AppInstalled;
@@ -872,7 +929,13 @@ interface SendBiEventOptions {
     eventData?: Record<string, string>;
 }
 
-declare function sendBiEvent$1(httpClient: HttpClient): (options?: SendBiEventOptions) => Promise<void>;
+declare function sendBiEvent$1(httpClient: HttpClient): SendBiEventSignature;
+interface SendBiEventSignature {
+    /**
+     * Submit a BI event to Wix.
+     */
+    (options?: SendBiEventOptions | undefined): Promise<void>;
+}
 
 declare function createRESTModule$2<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
@@ -1143,8 +1206,37 @@ interface GetUrlOptions {
     couponCode?: string | null;
 }
 
-declare function getUrl$1(httpClient: HttpClient): (productId: string, options?: GetUrlOptions) => Promise<GetUrlResponse & GetUrlResponseNonNullableFields>;
-declare function getPurchaseHistory$1(httpClient: HttpClient): () => Promise<GetPurchaseHistoryResponse & GetPurchaseHistoryResponseNonNullableFields>;
+declare function getUrl$1(httpClient: HttpClient): GetUrlSignature;
+interface GetUrlSignature {
+    /**
+     * Retrieves the URL for a Wix checkout page for the specified paid plan of your app.
+     *
+     *
+     * This call succeeds only in case you have previously
+     * [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).
+     *
+     * The returned checkout URL is valid for 48 hours.
+     *
+     * This API allows your app to manage your pricing page outside of Wix while
+     * still using the standard Wix checkout flow.
+     * @param - ID of your app's paid plan to retrieve the Wix checkout URL for. Check the
+     * Wix Developers Center for a list of your app's supported product IDs.
+     */
+    (productId: string, options?: GetUrlOptions | undefined): Promise<GetUrlResponse & GetUrlResponseNonNullableFields>;
+}
+declare function getPurchaseHistory$1(httpClient: HttpClient): GetPurchaseHistorySignature;
+interface GetPurchaseHistorySignature {
+    /**
+     * Retrieves a list of the site owner's past purchases for your app.
+     *
+     *
+     * You don't have to explicitly pass an identifier for the Wix site as part of
+     * the request, since this information is taken automatically from the context.
+     *
+     * The response doesn't include any details about cancellations.
+     */
+    (): Promise<GetPurchaseHistoryResponse & GetPurchaseHistoryResponseNonNullableFields>;
+}
 
 declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
@@ -1238,8 +1330,31 @@ interface GetEmbeddedScriptOptions {
     componentId?: string | null;
 }
 
-declare function embedScript$1(httpClient: HttpClient): (properties: ScriptProperties, options?: EmbedScriptOptions) => Promise<EmbedScriptResponse & EmbedScriptResponseNonNullableFields>;
-declare function getEmbeddedScript$1(httpClient: HttpClient): (options?: GetEmbeddedScriptOptions) => Promise<ScriptProperties & ScriptPropertiesNonNullableFields>;
+declare function embedScript$1(httpClient: HttpClient): EmbedScriptSignature;
+interface EmbedScriptSignature {
+    /**
+     * Inserts custom script tags into a site.
+     *
+     *
+     * Your app must have an existing
+     * [embedded script component](https://dev.wix.com/docs/build-apps/developer-tools/extensions/embedded-scripts),
+     * with exactly matching parameter names.
+     * @param - Details of the script to embed.
+     */
+    (properties: ScriptProperties, options?: EmbedScriptOptions | undefined): Promise<EmbedScriptResponse & EmbedScriptResponseNonNullableFields>;
+}
+declare function getEmbeddedScript$1(httpClient: HttpClient): GetEmbeddedScriptSignature;
+interface GetEmbeddedScriptSignature {
+    /**
+     * Retrieves information about your app's existing embedded script.
+     *
+     *
+     * The call fails with `404` error in case your app doesn't include an
+     * embedded script on the site.
+     * @returns Details of the retrieved embedded script.
+     */
+    (options?: GetEmbeddedScriptOptions | undefined): Promise<ScriptProperties & ScriptPropertiesNonNullableFields>;
+}
 
 declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 

package/type-bundles/meta.bundle.d.ts

@@ -1,10 +1,3 @@
-/**
- * An `appPlans` object describes how you charge users for using your app.
- * You can set up multiple plans for a single app, with different plans giving access to
- * different tiers of functionality. For example, you can offer a free plan and
- * 3 paid plans with an increasing number of benefits. Learn more about
- * [setting up your app pricing](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-your-app-pricing).
- */
 interface AppPlans$1 {
     /** App ID, as defined in the [Wix Dev Center](https://dev.wix.com/). */
     id?: string;
@@ -234,13 +227,6 @@ interface ListAppPlansByAppIdResponseNonNullableFields$1 {
     appPlans: AppPlansNonNullableFields$1[];
 }
 
-/**
- * An `appPlans` object describes how you charge users for using your app.
- * You can set up multiple plans for a single app, with different plans giving access to
- * different tiers of functionality. For example, you can offer a free plan and
- * 3 paid plans with an increasing number of benefits. Learn more about
- * [setting up your app pricing](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-your-app-pricing).
- */
 interface AppPlans {
     /** App ID, as defined in the [Wix Dev Center](https://dev.wix.com/). */
     _id?: string;