@wix/app-management 1.0.30 → 1.0.32

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.32",
   "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_custom-charges": "1.0.14",
-    "@wix/app-management_embedded-scripts": "1.0.13"
+    "@wix/app-management_app-instances": "1.0.18",
+    "@wix/app-management_app-plans": "1.0.18",
+    "@wix/app-management_bi-events": "1.0.17",
+    "@wix/app-management_billing": "1.0.18",
+    "@wix/app-management_custom-charges": "1.0.15",
+    "@wix/app-management_embedded-scripts": "1.0.15"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -49,5 +49,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "c4c0e29043bcbcef96d15a9644c4df19956fcb419059a6b6d0c43af3"
+  "falconPackageHash": "257ad2e4bdf9f0df54e2729996c8128fc27f70e5a59af94d94e459fc"
 }

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,56 +271,41 @@ 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;
-declare const listAppPlansByAppId: ReturnType<typeof createRESTModule$4<_publicListAppPlansByAppIdType>>;
+declare const listAppPlansByAppId: BuildRESTFunction<typeof listAppPlansByAppId$1> & typeof listAppPlansByAppId$1;
 
 type context$4_AppPlans = AppPlans;
 type context$4_Cycle = Cycle;
@@ -301,10 +323,9 @@ type context$4_TaxSettings = TaxSettings;
 type context$4_TaxType = TaxType;
 declare const context$4_TaxType: typeof TaxType;
 type context$4_UsageBasedDetails = UsageBasedDetails;
-type context$4__publicListAppPlansByAppIdType = _publicListAppPlansByAppIdType;
 declare const context$4_listAppPlansByAppId: typeof listAppPlansByAppId;
 declare namespace context$4 {
-  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 };
+  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 };
 }
 
 /**
@@ -711,33 +732,62 @@ 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">;
 declare const onAppInstancePaidPlanChanged$1: EventDefinition<AppInstancePaidPlanChangedEnvelope, "PaidPlanChanged">;
 declare const onAppInstancePaidPlanAutoRenewalCancelled$1: EventDefinition<AppInstancePaidPlanAutoRenewalCancelledEnvelope, "PaidPlanAutoRenewalCancelled">;
 
-declare function createRESTModule$3<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
-
 declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
 
-type _publicGetAppInstanceType = typeof getAppInstance$1;
-declare const getAppInstance: ReturnType<typeof createRESTModule$3<_publicGetAppInstanceType>>;
+declare const getAppInstance: BuildRESTFunction<typeof getAppInstance$1> & typeof getAppInstance$1;
 
 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;
@@ -768,7 +818,6 @@ type context$3_ResolutionMethod = ResolutionMethod;
 declare const context$3_ResolutionMethod: typeof ResolutionMethod;
 type context$3_SiteInfo = SiteInfo;
 type context$3_SupportedLanguage = SupportedLanguage;
-type context$3__publicGetAppInstanceType = _publicGetAppInstanceType;
 type context$3__publicOnAppInstanceInstalledType = _publicOnAppInstanceInstalledType;
 type context$3__publicOnAppInstancePaidPlanAutoRenewalCancelledType = _publicOnAppInstancePaidPlanAutoRenewalCancelledType;
 type context$3__publicOnAppInstancePaidPlanChangedType = _publicOnAppInstancePaidPlanChangedType;
@@ -781,7 +830,7 @@ declare const context$3_onAppInstancePaidPlanChanged: typeof onAppInstancePaidPl
 declare const context$3_onAppInstancePaidPlanPurchased: typeof onAppInstancePaidPlanPurchased;
 declare const context$3_onAppInstanceRemoved: typeof onAppInstanceRemoved;
 declare namespace context$3 {
-  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 };
+  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__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 };
 }
 
 interface SendBIEventResponse {
@@ -872,22 +921,24 @@ interface SendBiEventOptions {
     eventData?: Record<string, string>;
 }
 
-declare function sendBiEvent$1(httpClient: HttpClient): (options?: SendBiEventOptions) => Promise<void>;
-
-declare function createRESTModule$2<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
+declare function sendBiEvent$1(httpClient: HttpClient): SendBiEventSignature;
+interface SendBiEventSignature {
+    /**
+     * Submit a BI event to Wix.
+     */
+    (options?: SendBiEventOptions | undefined): Promise<void>;
+}
 
-type _publicSendBiEventType = typeof sendBiEvent$1;
-declare const sendBiEvent: ReturnType<typeof createRESTModule$2<_publicSendBiEventType>>;
+declare const sendBiEvent: BuildRESTFunction<typeof sendBiEvent$1> & typeof sendBiEvent$1;
 
 type context$2_EventName = EventName;
 declare const context$2_EventName: typeof EventName;
 type context$2_SendBIEventRequest = SendBIEventRequest;
 type context$2_SendBIEventResponse = SendBIEventResponse;
 type context$2_SendBiEventOptions = SendBiEventOptions;
-type context$2__publicSendBiEventType = _publicSendBiEventType;
 declare const context$2_sendBiEvent: typeof sendBiEvent;
 declare namespace context$2 {
-  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 };
+  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 };
 }
 
 interface PurchasedItem {
@@ -1143,15 +1194,40 @@ 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 createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
+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>;
+}
 
-type _publicGetUrlType = typeof getUrl$1;
-declare const getUrl: ReturnType<typeof createRESTModule$1<_publicGetUrlType>>;
-type _publicGetPurchaseHistoryType = typeof getPurchaseHistory$1;
-declare const getPurchaseHistory: ReturnType<typeof createRESTModule$1<_publicGetPurchaseHistoryType>>;
+declare const getUrl: BuildRESTFunction<typeof getUrl$1> & typeof getUrl$1;
+declare const getPurchaseHistory: BuildRESTFunction<typeof getPurchaseHistory$1> & typeof getPurchaseHistory$1;
 
 type context$1_Charge = Charge;
 type context$1_ChargeOverride = ChargeOverride;
@@ -1177,12 +1253,10 @@ declare const context$1_PaymentCycle: typeof PaymentCycle;
 type context$1_PurchasedItem = PurchasedItem;
 type context$1_WebhookIdentityType = WebhookIdentityType;
 declare const context$1_WebhookIdentityType: typeof WebhookIdentityType;
-type context$1__publicGetPurchaseHistoryType = _publicGetPurchaseHistoryType;
-type context$1__publicGetUrlType = _publicGetUrlType;
 declare const context$1_getPurchaseHistory: typeof getPurchaseHistory;
 declare const context$1_getUrl: typeof getUrl;
 declare namespace context$1 {
-  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 };
+  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 };
 }
 
 /** Embedded script data */
@@ -1238,15 +1312,34 @@ 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 createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
+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>;
+}
 
-type _publicEmbedScriptType = typeof embedScript$1;
-declare const embedScript: ReturnType<typeof createRESTModule<_publicEmbedScriptType>>;
-type _publicGetEmbeddedScriptType = typeof getEmbeddedScript$1;
-declare const getEmbeddedScript: ReturnType<typeof createRESTModule<_publicGetEmbeddedScriptType>>;
+declare const embedScript: BuildRESTFunction<typeof embedScript$1> & typeof embedScript$1;
+declare const getEmbeddedScript: BuildRESTFunction<typeof getEmbeddedScript$1> & typeof getEmbeddedScript$1;
 
 type context_EmbedScriptByInstanceIdRequest = EmbedScriptByInstanceIdRequest;
 type context_EmbedScriptOptions = EmbedScriptOptions;
@@ -1260,12 +1353,10 @@ type context_GetEmbeddedScriptResponse = GetEmbeddedScriptResponse;
 type context_GetEmbeddedScriptResponseNonNullableFields = GetEmbeddedScriptResponseNonNullableFields;
 type context_ScriptProperties = ScriptProperties;
 type context_ScriptPropertiesNonNullableFields = ScriptPropertiesNonNullableFields;
-type context__publicEmbedScriptType = _publicEmbedScriptType;
-type context__publicGetEmbeddedScriptType = _publicGetEmbeddedScriptType;
 declare const context_embedScript: typeof embedScript;
 declare const context_getEmbeddedScript: typeof getEmbeddedScript;
 declare namespace context {
-  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 };
+  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 };
 }
 
 export { context$3 as appInstances, context$4 as appPlans, context$2 as biEvents, context$1 as billing, context as embeddedScripts };

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,56 +271,41 @@ 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;
-declare const listAppPlansByAppId: ReturnType<typeof createRESTModule$4<_publicListAppPlansByAppIdType>>;
+declare const listAppPlansByAppId: BuildRESTFunction<typeof listAppPlansByAppId$1> & typeof listAppPlansByAppId$1;
 
 type index_d$4_AppPlans = AppPlans;
 type index_d$4_Cycle = Cycle;
@@ -301,10 +323,9 @@ type index_d$4_TaxSettings = TaxSettings;
 type index_d$4_TaxType = TaxType;
 declare const index_d$4_TaxType: typeof TaxType;
 type index_d$4_UsageBasedDetails = UsageBasedDetails;
-type index_d$4__publicListAppPlansByAppIdType = _publicListAppPlansByAppIdType;
 declare const index_d$4_listAppPlansByAppId: typeof listAppPlansByAppId;
 declare namespace index_d$4 {
-  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 };
+  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 };
 }
 
 /**
@@ -711,33 +732,62 @@ 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">;
 declare const onAppInstancePaidPlanChanged$1: EventDefinition<AppInstancePaidPlanChangedEnvelope, "PaidPlanChanged">;
 declare const onAppInstancePaidPlanAutoRenewalCancelled$1: EventDefinition<AppInstancePaidPlanAutoRenewalCancelledEnvelope, "PaidPlanAutoRenewalCancelled">;
 
-declare function createRESTModule$3<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
-
 declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
 
-type _publicGetAppInstanceType = typeof getAppInstance$1;
-declare const getAppInstance: ReturnType<typeof createRESTModule$3<_publicGetAppInstanceType>>;
+declare const getAppInstance: BuildRESTFunction<typeof getAppInstance$1> & typeof getAppInstance$1;
 
 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;
@@ -768,7 +818,6 @@ type index_d$3_ResolutionMethod = ResolutionMethod;
 declare const index_d$3_ResolutionMethod: typeof ResolutionMethod;
 type index_d$3_SiteInfo = SiteInfo;
 type index_d$3_SupportedLanguage = SupportedLanguage;
-type index_d$3__publicGetAppInstanceType = _publicGetAppInstanceType;
 type index_d$3__publicOnAppInstanceInstalledType = _publicOnAppInstanceInstalledType;
 type index_d$3__publicOnAppInstancePaidPlanAutoRenewalCancelledType = _publicOnAppInstancePaidPlanAutoRenewalCancelledType;
 type index_d$3__publicOnAppInstancePaidPlanChangedType = _publicOnAppInstancePaidPlanChangedType;
@@ -781,7 +830,7 @@ declare const index_d$3_onAppInstancePaidPlanChanged: typeof onAppInstancePaidPl
 declare const index_d$3_onAppInstancePaidPlanPurchased: typeof onAppInstancePaidPlanPurchased;
 declare const index_d$3_onAppInstanceRemoved: typeof onAppInstanceRemoved;
 declare namespace index_d$3 {
-  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 };
+  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__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 };
 }
 
 interface SendBIEventResponse {
@@ -872,22 +921,24 @@ interface SendBiEventOptions {
     eventData?: Record<string, string>;
 }
 
-declare function sendBiEvent$1(httpClient: HttpClient): (options?: SendBiEventOptions) => Promise<void>;
-
-declare function createRESTModule$2<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
+declare function sendBiEvent$1(httpClient: HttpClient): SendBiEventSignature;
+interface SendBiEventSignature {
+    /**
+     * Submit a BI event to Wix.
+     */
+    (options?: SendBiEventOptions | undefined): Promise<void>;
+}
 
-type _publicSendBiEventType = typeof sendBiEvent$1;
-declare const sendBiEvent: ReturnType<typeof createRESTModule$2<_publicSendBiEventType>>;
+declare const sendBiEvent: BuildRESTFunction<typeof sendBiEvent$1> & typeof sendBiEvent$1;
 
 type index_d$2_EventName = EventName;
 declare const index_d$2_EventName: typeof EventName;
 type index_d$2_SendBIEventRequest = SendBIEventRequest;
 type index_d$2_SendBIEventResponse = SendBIEventResponse;
 type index_d$2_SendBiEventOptions = SendBiEventOptions;
-type index_d$2__publicSendBiEventType = _publicSendBiEventType;
 declare const index_d$2_sendBiEvent: typeof sendBiEvent;
 declare namespace index_d$2 {
-  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 };
+  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 };
 }
 
 interface PurchasedItem {
@@ -1143,15 +1194,40 @@ 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 createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
+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>;
+}
 
-type _publicGetUrlType = typeof getUrl$1;
-declare const getUrl: ReturnType<typeof createRESTModule$1<_publicGetUrlType>>;
-type _publicGetPurchaseHistoryType = typeof getPurchaseHistory$1;
-declare const getPurchaseHistory: ReturnType<typeof createRESTModule$1<_publicGetPurchaseHistoryType>>;
+declare const getUrl: BuildRESTFunction<typeof getUrl$1> & typeof getUrl$1;
+declare const getPurchaseHistory: BuildRESTFunction<typeof getPurchaseHistory$1> & typeof getPurchaseHistory$1;
 
 type index_d$1_Charge = Charge;
 type index_d$1_ChargeOverride = ChargeOverride;
@@ -1177,12 +1253,10 @@ declare const index_d$1_PaymentCycle: typeof PaymentCycle;
 type index_d$1_PurchasedItem = PurchasedItem;
 type index_d$1_WebhookIdentityType = WebhookIdentityType;
 declare const index_d$1_WebhookIdentityType: typeof WebhookIdentityType;
-type index_d$1__publicGetPurchaseHistoryType = _publicGetPurchaseHistoryType;
-type index_d$1__publicGetUrlType = _publicGetUrlType;
 declare const index_d$1_getPurchaseHistory: typeof getPurchaseHistory;
 declare const index_d$1_getUrl: typeof getUrl;
 declare namespace index_d$1 {
-  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 };
+  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 };
 }
 
 /** Embedded script data */
@@ -1238,15 +1312,34 @@ 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 createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
+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>;
+}
 
-type _publicEmbedScriptType = typeof embedScript$1;
-declare const embedScript: ReturnType<typeof createRESTModule<_publicEmbedScriptType>>;
-type _publicGetEmbeddedScriptType = typeof getEmbeddedScript$1;
-declare const getEmbeddedScript: ReturnType<typeof createRESTModule<_publicGetEmbeddedScriptType>>;
+declare const embedScript: BuildRESTFunction<typeof embedScript$1> & typeof embedScript$1;
+declare const getEmbeddedScript: BuildRESTFunction<typeof getEmbeddedScript$1> & typeof getEmbeddedScript$1;
 
 type index_d_EmbedScriptByInstanceIdRequest = EmbedScriptByInstanceIdRequest;
 type index_d_EmbedScriptOptions = EmbedScriptOptions;
@@ -1260,12 +1353,10 @@ type index_d_GetEmbeddedScriptResponse = GetEmbeddedScriptResponse;
 type index_d_GetEmbeddedScriptResponseNonNullableFields = GetEmbeddedScriptResponseNonNullableFields;
 type index_d_ScriptProperties = ScriptProperties;
 type index_d_ScriptPropertiesNonNullableFields = ScriptPropertiesNonNullableFields;
-type index_d__publicEmbedScriptType = _publicEmbedScriptType;
-type index_d__publicGetEmbeddedScriptType = _publicGetEmbeddedScriptType;
 declare const index_d_embedScript: typeof embedScript;
 declare const index_d_getEmbeddedScript: typeof getEmbeddedScript;
 declare namespace index_d {
-  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 };
+  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 };
 }
 
 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 };

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;

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

@@ -319,10 +319,60 @@ interface ChargeLimitUpdatedEventEnvelope {
     metadata: Context;
 }
 declare const provideHandlers$1: ServicePluginDefinition<{
+    /**
+     *
+     * Wix calls this method to retrieve the initial charge limit for a paid instance
+     * of your app. This happens every time a customer is upgrading to a paid version of
+     * your app.
+     *
+     * You can't update the charge limit after you've set an initial
+     * value. Customers can increase the limit in their site's dashboard, currently they
+     * aren't allowed to decrease it. */
     getChargeLimit(payload: GetChargeLimitEnvelope): GetChargeLimitResponse | Promise<GetChargeLimitResponse>;
+    /**
+     *
+     * Wix calls this method to retrieve a list of charges for a paid instance
+     * of your app. This happens when Wix creates an invoice or in case the customer
+     * wants to preview how much your app would charge them at the moment.
+     *
+     * You must return the charges in the currency that's specified in the request,
+     * you aren't allowed to return more than 5 charges, and their sum must be lower
+     * than the charge limit.
+     *
+     * You may not bill customers for any usage that didn’t occur during the period
+     * Wix specifies when retrieving the charges. If Wix discovers that your app has
+     * charged customers for usage outside of an invoice's specified period, we may
+     * take action such as blocking your app from charging the customer, removing
+     * your app from the Wix App Market, revoking your access to the Wix developer
+     * program, or pursuing legal action to recover damages caused by overcharging.
+     * We understand that mistakes can happen and encourage you to contact
+     * [the Wix App Market team](https://devforum.wix.com/kb/en/contact) immediately if you
+     * become aware of any overcharging issues so that we can work together to
+     * resolve the situation. */
     listCharges(payload: ListChargesEnvelope): ListChargesResponse | Promise<ListChargesResponse>;
+    /**
+     *
+     * Triggered in case Wix doesn't accept the charges you've returned in the
+     * List Charges method.
+     *
+     *
+     * You aren't allowed to charge a site owner more than the charge limit. Wix
+     * call List Charges in regular intervals until the sum of all charges is lower than the
+     * charge limit. Wix doesn't create an invoice in case the charges aren't accepted. */
     chargesRejectedEvent(payload: ChargesRejectedEventEnvelope): ChargesRejectedResponse | Promise<ChargesRejectedResponse>;
+    /**
+     *
+     * Triggered in case Wix creates an invoice that includes charges for an instance
+     * of your app. */
     invoiceCreatedEvent(payload: InvoiceCreatedEventEnvelope): InvoiceCreatedResponse | Promise<InvoiceCreatedResponse>;
+    /**
+     *
+     * Triggered in case the charge limit for an instance of your app is updated.
+     *
+     *
+     * You can't update the charge limit after you've set an initial
+     * value. Site owners can increase the limit in their site's dashboard,
+     * currently they aren't allowed to decrease it. */
     chargeLimitUpdatedEvent(payload: ChargeLimitUpdatedEventEnvelope): ChargeLimitUpdatedResponse | Promise<ChargeLimitUpdatedResponse>;
 }>;
 

package/type-bundles/service-plugins.bundle.d.ts

@@ -289,6 +289,7 @@ type ServicePluginDefinition<Contract extends ServicePluginContract> = {
     __contract: Contract;
 };
 declare function ServicePluginDefinition<Contract extends ServicePluginContract>(componentType: string, methods: ServicePluginMethodMetadata[]): ServicePluginDefinition<Contract>;
+type BuildServicePluginDefinition<T extends ServicePluginDefinition<any>> = (implementation: T['__contract']) => void;
 
 declare global {
 	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
@@ -317,27 +318,79 @@ interface ChargeLimitUpdatedEventEnvelope {
     request: ChargeLimitUpdatedRequest;
     metadata: Context;
 }
-declare const provideHandlers: ServicePluginDefinition<{
+declare const provideHandlers$1: ServicePluginDefinition<{
+    /**
+     *
+     * Wix calls this method to retrieve the initial charge limit for a paid instance
+     * of your app. This happens every time a customer is upgrading to a paid version of
+     * your app.
+     *
+     * You can't update the charge limit after you've set an initial
+     * value. Customers can increase the limit in their site's dashboard, currently they
+     * aren't allowed to decrease it. */
     getChargeLimit(payload: GetChargeLimitEnvelope): GetChargeLimitResponse | Promise<GetChargeLimitResponse>;
+    /**
+     *
+     * Wix calls this method to retrieve a list of charges for a paid instance
+     * of your app. This happens when Wix creates an invoice or in case the customer
+     * wants to preview how much your app would charge them at the moment.
+     *
+     * You must return the charges in the currency that's specified in the request,
+     * you aren't allowed to return more than 5 charges, and their sum must be lower
+     * than the charge limit.
+     *
+     * You may not bill customers for any usage that didn’t occur during the period
+     * Wix specifies when retrieving the charges. If Wix discovers that your app has
+     * charged customers for usage outside of an invoice's specified period, we may
+     * take action such as blocking your app from charging the customer, removing
+     * your app from the Wix App Market, revoking your access to the Wix developer
+     * program, or pursuing legal action to recover damages caused by overcharging.
+     * We understand that mistakes can happen and encourage you to contact
+     * [the Wix App Market team](https://devforum.wix.com/kb/en/contact) immediately if you
+     * become aware of any overcharging issues so that we can work together to
+     * resolve the situation. */
     listCharges(payload: ListChargesEnvelope): ListChargesResponse | Promise<ListChargesResponse>;
+    /**
+     *
+     * Triggered in case Wix doesn't accept the charges you've returned in the
+     * List Charges method.
+     *
+     *
+     * You aren't allowed to charge a site owner more than the charge limit. Wix
+     * call List Charges in regular intervals until the sum of all charges is lower than the
+     * charge limit. Wix doesn't create an invoice in case the charges aren't accepted. */
     chargesRejectedEvent(payload: ChargesRejectedEventEnvelope): ChargesRejectedResponse | Promise<ChargesRejectedResponse>;
+    /**
+     *
+     * Triggered in case Wix creates an invoice that includes charges for an instance
+     * of your app. */
     invoiceCreatedEvent(payload: InvoiceCreatedEventEnvelope): InvoiceCreatedResponse | Promise<InvoiceCreatedResponse>;
+    /**
+     *
+     * Triggered in case the charge limit for an instance of your app is updated.
+     *
+     *
+     * You can't update the charge limit after you've set an initial
+     * value. Site owners can increase the limit in their site's dashboard,
+     * currently they aren't allowed to decrease it. */
     chargeLimitUpdatedEvent(payload: ChargeLimitUpdatedEventEnvelope): ChargeLimitUpdatedResponse | Promise<ChargeLimitUpdatedResponse>;
 }>;
 
+declare function createServicePluginModule<T extends ServicePluginDefinition<any>>(servicePluginDefinition: T): BuildServicePluginDefinition<T> & T;
+
+type _publicProvideHandlersType = typeof provideHandlers$1;
+declare const provideHandlers: ReturnType<typeof createServicePluginModule<_publicProvideHandlersType>>;
+
 type index_d_AlternativeUri = AlternativeUri;
-type index_d_ChargeLimitUpdatedEventEnvelope = ChargeLimitUpdatedEventEnvelope;
 type index_d_ChargeLimitUpdatedRequest = ChargeLimitUpdatedRequest;
 type index_d_ChargeLimitUpdatedResponse = ChargeLimitUpdatedResponse;
 type index_d_ChargeLineItem = ChargeLineItem;
-type index_d_ChargesRejectedEventEnvelope = ChargesRejectedEventEnvelope;
 type index_d_ChargesRejectedReason = ChargesRejectedReason;
 declare const index_d_ChargesRejectedReason: typeof ChargesRejectedReason;
 type index_d_ChargesRejectedRequest = ChargesRejectedRequest;
 type index_d_ChargesRejectedResponse = ChargesRejectedResponse;
 type index_d_Context = Context;
 type index_d_CustomChargesConfig = CustomChargesConfig;
-type index_d_GetChargeLimitEnvelope = GetChargeLimitEnvelope;
 type index_d_GetChargeLimitRequest = GetChargeLimitRequest;
 type index_d_GetChargeLimitResponse = GetChargeLimitResponse;
 type index_d_IdentificationData = IdentificationData;
@@ -346,17 +399,16 @@ type index_d_IdentityType = IdentityType;
 declare const index_d_IdentityType: typeof IdentityType;
 type index_d_Intent = Intent;
 declare const index_d_Intent: typeof Intent;
-type index_d_InvoiceCreatedEventEnvelope = InvoiceCreatedEventEnvelope;
 type index_d_InvoiceCreatedRequest = InvoiceCreatedRequest;
 type index_d_InvoiceCreatedResponse = InvoiceCreatedResponse;
 type index_d_InvoiceLineItem = InvoiceLineItem;
-type index_d_ListChargesEnvelope = ListChargesEnvelope;
 type index_d_ListChargesRequest = ListChargesRequest;
 type index_d_ListChargesResponse = ListChargesResponse;
 type index_d_SpiBaseUri = SpiBaseUri;
+type index_d__publicProvideHandlersType = _publicProvideHandlersType;
 declare const index_d_provideHandlers: typeof provideHandlers;
 declare namespace index_d {
-  export { type index_d_AlternativeUri as AlternativeUri, type index_d_ChargeLimitUpdatedEventEnvelope as ChargeLimitUpdatedEventEnvelope, type index_d_ChargeLimitUpdatedRequest as ChargeLimitUpdatedRequest, type index_d_ChargeLimitUpdatedResponse as ChargeLimitUpdatedResponse, type index_d_ChargeLineItem as ChargeLineItem, type index_d_ChargesRejectedEventEnvelope as ChargesRejectedEventEnvelope, index_d_ChargesRejectedReason as ChargesRejectedReason, type index_d_ChargesRejectedRequest as ChargesRejectedRequest, type index_d_ChargesRejectedResponse as ChargesRejectedResponse, type index_d_Context as Context, type index_d_CustomChargesConfig as CustomChargesConfig, type index_d_GetChargeLimitEnvelope as GetChargeLimitEnvelope, type index_d_GetChargeLimitRequest as GetChargeLimitRequest, type index_d_GetChargeLimitResponse as GetChargeLimitResponse, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, index_d_IdentityType as IdentityType, index_d_Intent as Intent, type index_d_InvoiceCreatedEventEnvelope as InvoiceCreatedEventEnvelope, type index_d_InvoiceCreatedRequest as InvoiceCreatedRequest, type index_d_InvoiceCreatedResponse as InvoiceCreatedResponse, type index_d_InvoiceLineItem as InvoiceLineItem, type index_d_ListChargesEnvelope as ListChargesEnvelope, type index_d_ListChargesRequest as ListChargesRequest, type index_d_ListChargesResponse as ListChargesResponse, type index_d_SpiBaseUri as SpiBaseUri, index_d_provideHandlers as provideHandlers };
+  export { type index_d_AlternativeUri as AlternativeUri, type index_d_ChargeLimitUpdatedRequest as ChargeLimitUpdatedRequest, type index_d_ChargeLimitUpdatedResponse as ChargeLimitUpdatedResponse, type index_d_ChargeLineItem as ChargeLineItem, index_d_ChargesRejectedReason as ChargesRejectedReason, type index_d_ChargesRejectedRequest as ChargesRejectedRequest, type index_d_ChargesRejectedResponse as ChargesRejectedResponse, type index_d_Context as Context, type index_d_CustomChargesConfig as CustomChargesConfig, type index_d_GetChargeLimitRequest as GetChargeLimitRequest, type index_d_GetChargeLimitResponse as GetChargeLimitResponse, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, index_d_IdentityType as IdentityType, index_d_Intent as Intent, type index_d_InvoiceCreatedRequest as InvoiceCreatedRequest, type index_d_InvoiceCreatedResponse as InvoiceCreatedResponse, type index_d_InvoiceLineItem as InvoiceLineItem, type index_d_ListChargesRequest as ListChargesRequest, type index_d_ListChargesResponse as ListChargesResponse, type index_d_SpiBaseUri as SpiBaseUri, type index_d__publicProvideHandlersType as _publicProvideHandlersType, index_d_provideHandlers as provideHandlers, provideHandlers$1 as publicProvideHandlers };
 }
 
 export { index_d as customCharges };