@wix/app-management 1.0.19 → 1.0.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/app-management",
-  "version": "1.0.19",
+  "version": "1.0.21",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -19,12 +19,12 @@
     "service-plugins"
   ],
   "dependencies": {
-    "@wix/app-management_app-instances": "1.0.10",
-    "@wix/app-management_app-plans": "1.0.10",
-    "@wix/app-management_bi-events": "1.0.9",
-    "@wix/app-management_billing": "1.0.10",
-    "@wix/app-management_custom-charges": "1.0.5",
-    "@wix/app-management_embedded-scripts": "1.0.7"
+    "@wix/app-management_app-instances": "1.0.11",
+    "@wix/app-management_app-plans": "1.0.11",
+    "@wix/app-management_bi-events": "1.0.10",
+    "@wix/app-management_billing": "1.0.11",
+    "@wix/app-management_custom-charges": "1.0.6",
+    "@wix/app-management_embedded-scripts": "1.0.8"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -48,5 +48,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "e21d5d1a848dbeeb5ad5bc688ab353b7a68ee4f413a33c9c7ea9f9b4"
+  "falconPackageHash": "92d82785d051537964c94876233fcc6ab069b7f94e686627793308e0"
 }

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

@@ -1,228 +1,8 @@
-/**
- * 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;
-    /**
-     * List of the app's pricing plans.
-     *
-     * Min: `0` plans
-     * Max: `50` plans
-     */
-    plans?: Plan[];
-}
-interface Cycle {
-    /**
-     * Type of the billing cycle.
-     *
-     * + `"UNKNOWN_UNIT"`:  There is no information about the billing cycle.
-     * + `"ONE_TIME"`:  The customer pays for unlimited usage of the app with a single payment.
-     * + `"RECURRING"`: The customer pays for a subscription to the app on a recurring schedule.
-     */
-    cycleType?: CycleType;
-    /** Duration of the billing cycle. Available only for `{"cycleType": "RECURRING"}`. */
-    cycleDuration?: Duration;
-}
-declare enum DurationUnit {
-    /** unknown interval unit */
-    UNKNOWN_UNIT = "UNKNOWN_UNIT",
-    /** month */
-    MONTH = "MONTH",
-    /** year */
-    YEAR = "YEAR"
-}
-declare enum CycleType {
-    UNKNOWN_TYPE = "UNKNOWN_TYPE",
-    ONE_TIME = "ONE_TIME",
-    RECURRING = "RECURRING"
-}
-interface Duration {
-    /** Unit of the billing cycle. */
-    unit?: DurationUnit;
-    /** Count of units that make up the billing cycle. */
-    count?: number;
-}
-interface UsageBasedDetails {
-    /**
-     * Smallest possible amount that your app charges customers in usage-based
-     * pricing. For example, the price of a single SMS message if your
-     * app charges customers for sending text messages. Always in
-     * [USD](https://en.wikipedia.org/wiki/United_States_dollar).
-     *
-     * Min: `0.00`
-     * Max: 1024 characters
-     */
-    minimumChargeIncrement?: string | null;
-    /**
-     * Recurring, monthly base fee in usaged-based pricing that your app
-     * charges customers regardless of how much they use your app.
-     *
-     * Min: `0.00`
-     * Max: 1024 characters
-     */
-    monthlyBaseFee?: string | null;
-    /**
-     * Description of the usaged-based pricing plan, as defined in the
-     * [Dev Center](https://dev.wix.com/).
-     *
-     * Max: 1024 characters
-     */
-    customChargeDescription?: string | null;
-}
-interface Price {
-    /**
-     * Price without taxes. For yearly plans, Wix calculates and returns the
-     * average price per month. You can get thefull price by multiplying the
-     * returned price with 12.
-     *
-     * Min: `0.00`
-     * Max: 1024 characters
-     */
-    priceBeforeTax?: string;
-    /**
-     * Total price including taxes.
-     *
-     * Min: `0.00`
-     * Max: 1024 characters
-     */
-    totalPrice?: string;
-    /** Information about the plan's recurring billing cycle or single payment. */
-    billingCycle?: Cycle;
-    /**
-     * Details about the plan's usage-based pricing.
-     * Available only for plans with
-     * [usage-based pricing](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/usage-based-pricing).
-     */
-    usageBaseOptions?: UsageBasedDetails;
-}
-interface Plan {
-    /**
-     * ID of the app plan.
-     * @readonly
-     */
-    _id?: string;
-    /**
-     * ID of your app's pricing plan, as displayed in the [Dev Center](https://dev.wix.com/).
-     * Identical to `vendorProductId` in the
-     * [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
-     */
-    vendorId?: string;
-    /** Name of your app's pricing plan, as defined by you in the [Dev Center](https://dev.wix.com/). */
-    name?: string;
-    /**
-     * List of your plan's benefits, as defined by you in the [Dev Center](https://dev.wix.com/).
-     * Currently, the benefits are available only in English.
-     *
-     * Min: `0` benefits
-     * Max: `4` benefits
-     * Max per benefit: 1024 characters
-     */
-    benefits?: string[];
-    /**
-     * List of the plan's prices. Available only when the plan's prices are managed
-     * by Wix and not externally.
-     *
-     * Min: `0` prices
-     * Max: `10` prices
-     */
-    prices?: Price[];
-}
-interface ListAppPlansByAppIdResponse {
-    /**
-     * Tax settings. Wix calculates the tax settings based on the country code that
-     * you pass in the call's header. If you don't pass a country code in the header,
-     * Wix calculates the tax settings based on the caller's IP address. Note that the
-     * tax settings may not resolve properly if you call through a VPN.
-     */
-    taxSettings?: TaxSettings;
-    /**
-     * 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)
-     * format. Wix calculates the currency based on the country code that
-     * you pass in the call's header. If you don't pass a country code in the header,
-     * Wix calculates the currency based on the caller's IP address. Note that the
-     * currency may not resolve properly if you call through a VPN.
-     */
-    currency?: string;
-    /**
-     * Currency symbol in decimal HTML entity format. For example, `$` for $
-     * (United States Dollar). Wix calculates the currency symbol based on the
-     * country code that you pass in the call's header. If you don't pass a country
-     * code in the header, Wix calculates the tax settings based on the caller's IP
-     * address. Note that the currency symbol may not resolve properly if you call
-     * through a VPN.
-     */
-    currencySymbol?: string;
-    /**
-     * Retrieved app plans.
-     *
-     * Min: 0 plans
-     * Max: 50 plans
-     */
-    appPlans?: AppPlans[];
-}
-interface TaxSettings {
-    /**
-     * Whether you must display the total price including taxes in the given
-     * country.
-     */
-    showPriceWithTax?: boolean;
-    /**
-     * Tax rate for the given country as percentage. Returned as `0` when
-     * `{"showPriceWithTax": false}`.
-     */
-    percentage?: string | null;
-    /**
-     * Type of tax required in the given country.
-     *
-     * + `"NOT_APPLICABLE"`: The country doesn't require that you display the total price including taxes, or Wix failed to calculate the country based on the call's IP address.
-     * + `"VAT"`: The given country requires that you display the total price including [value-added tax (VAT)](https://en.wikipedia.org/wiki/Value-added_tax).
-     * + `"GST"`: The given country requires that you display the total price including [generation-skipping transfer tax (GST)](https://en.wikipedia.org/wiki/Generation-skipping_transfer_tax).
-     */
-    taxType?: TaxType;
-}
-declare enum TaxType {
-    NOT_APPLICABLE = "NOT_APPLICABLE",
-    VAT = "VAT",
-    GST = "GST"
-}
-interface ListAppPlansByAppIdResponseNonNullableFields {
-    taxSettings?: {
-        showPriceWithTax: boolean;
-        taxType: TaxType;
-    };
-    currency: string;
-    currencySymbol: string;
-    appPlans: {
-        _id: string;
-        plans: {
-            _id: string;
-            vendorId: string;
-            name: string;
-            benefits: string[];
-            prices: {
-                priceBeforeTax: string;
-                totalPrice: string;
-                billingCycle?: {
-                    cycleType: CycleType;
-                    cycleDuration?: {
-                        unit: DurationUnit;
-                        count: number;
-                    };
-                };
-            }[];
-        }[];
-    }[];
-}
-
 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: (url: string | URL, init?: RequestInit) => Promise<Response>;
+    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> = {
@@ -262,407 +42,25 @@ declare global {
 	}
 }
 
-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;
 
-declare const listAppPlansByAppId: BuildRESTFunction<typeof listAppPlansByAppId$1>;
+declare const listAppPlansByAppId: ReturnType<typeof createRESTModule$4<typeof publicListAppPlansByAppId>>;
 
 declare const context$4_listAppPlansByAppId: typeof listAppPlansByAppId;
 declare namespace context$4 {
   export { context$4_listAppPlansByAppId as listAppPlansByAppId };
 }
 
-/**
- * An app instance is a specific occurrence of your app on a particular Wix site.
- * When a site owner installs your app, a unique instance is generated for that
- * specific site. Use the `instanceId` to keep track of the individual data
- * associated with each app instance.
- */
-interface AppInstance {
-    /**
-     * ID of the app instance. You can use it to keep track of the individual
-     * data that's associated with the specific occurence of your app that's
-     * installed on a Wix site.
-     */
-    instanceId?: string;
-    /**
-     * App name, as set by you in the Wix Developers Center during the app creation
-     * process.
-     */
-    appName?: string;
-    /**
-     * Version of your app that's installed on the Wix site, as set by you in the
-     * Wix Developers Center during the app creation process.
-     */
-    appVersion?: string | null;
-    /**
-     * Whether the site owners have installed a free or paid version of your app
-     * on their site.
-     */
-    isFree?: boolean;
-    /**
-     * Billing information for the app instance. Available only in case
-     * `{"isFree": false}`.
-     */
-    billing?: BillingInfo;
-    /**
-     * List of [permissions](https://dev.wix.com/docs/build-apps/developer-tools/developers-center/example-app-walkthrough/build-an-app#4-add-permissions)
-     * that the site owners have granted your app. You set the list of permissions that
-     * your app requires from the site owners in the Wix Developers Center during the
-     * app creation process.
-     */
-    permissions?: string[];
-    /** Plans available to this app instance. */
-    availablePlans?: AvailablePlan[];
-    /**
-     * ID of the Wix site from which the instance of your app has been cloned.
-     * Available only in case `{"copiedFromTemplate": true}`.
-     * All visual settings of the Wix site and app data are duplicated during the
-     * cloning process. Wix also notifies you in case there is any additional
-     * external functionality for the original site.
-     */
-    originInstanceId?: string | null;
-    /**
-     * __Deprecated__. This parameter will be removed on March 30, 2023. Use
-     * `copiedFromTemplate` instead.
-     * @deprecated
-     */
-    isOriginSiteTemplate?: boolean;
-    /** Whether the app instance was created when another Wix site was cloned. */
-    copiedFromTemplate?: boolean;
-    /** Whether the app instance includes a free trial that hasn't started yet. */
-    freeTrialAvailable?: boolean;
-}
-interface BillingInfo {
-    /** Name of the package that the site owner has paid for. */
-    packageName?: string;
-    /**
-     * Interval of the billing cycle. `"ONE_TIME"` means that site owners have
-     * purchased unlimited access to the app with a single, upfront payment.
-     */
-    billingCycle?: PaymentCycle$1;
-    /**
-     * Date and time the site owners have purchased the app's paid plan in
-     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
-     */
-    timeStamp?: string;
-    /**
-     * Date and time the app's current billing cycle ends in
-     * `YYYY-MM-DDThh:mm:ss.sssZ` format. Available only for yearly and
-     * multi-yearly plans.
-     */
-    expirationDate?: string | null;
-    /**
-     * Whether the app's subscription automatically renews at the end of the
-     * current billing cycle.
-     */
-    autoRenewing?: boolean | null;
-    /** ID of the invoice for the current billing cycle. */
-    invoiceId?: string | null;
-    /**
-     * Information about any discounts applied to the app instance's current billing cycle.
-     * If the site owners applied a developer coupon or Wix Voucher
-     * when installing the paid version of your app, this field holds the coupon's
-     * name or `“Wix discount coupon”`. Site owners may receive a Wix Voucher when
-     * upgrading their Wix subscription. If there is no discount for the
-     * current billing cycle, the field is an empty string.
-     */
-    source?: string | null;
-    /** Information about the free trial applied, if relevant. */
-    freeTrialInfo?: FreeTrialInfo;
-}
-declare enum PaymentCycle$1 {
-    NO_CYCLE = "NO_CYCLE",
-    MONTHLY = "MONTHLY",
-    YEARLY = "YEARLY",
-    ONE_TIME = "ONE_TIME",
-    TWO_YEARS = "TWO_YEARS",
-    THREE_YEARS = "THREE_YEARS",
-    FOUR_YEARS = "FOUR_YEARS",
-    FIVE_YEARS = "FIVE_YEARS"
-}
-interface FreeTrialInfo {
-    /**
-     * Current free trial status.
-     *
-     * Supported values:
-     *
-     * - `IN_PROGRESS`: The free trial is currently in progress.
-     * - `ENDED`: The free trial has ended.
-     * - `NOT_AVAILABLE`: No free trial was applied, as none was available.
-     * @readonly
-     */
-    status?: FreeTrialStatus;
-    /**
-     * When the free trial has ended. Populated only once the free trial is over.
-     * @readonly
-     */
-    endDate?: Date;
-}
-declare enum FreeTrialStatus {
-    UNKNOWN_STATUS = "UNKNOWN_STATUS",
-    IN_PROGRESS = "IN_PROGRESS",
-    ENDED = "ENDED",
-    NOT_AVAILABLE = "NOT_AVAILABLE"
-}
-interface AvailablePlan {
-    /** Package name of the available plan. */
-    packageName?: string;
-    /** Source of the available plan. Can be a bundle or 3rd-party app. */
-    source?: string;
-}
-interface AppInstalled {
-    /** Unique identifier of the app within the website. */
-    appId?: string;
-    /** Instance ID of the app in the original website (relevant only when this site was [duplicated from another site](https://support.wix.com/en/article/duplicating-your-site-1472847)). */
-    originInstanceId?: string | null;
-}
-interface AppRemoved {
-    /** Unique identifier of the app within the website. */
-    appId?: string;
-}
-interface PaidPlanPurchased {
-    /** Date and time of purchase. */
-    operationTimeStamp?: Date;
-    /** Purchased app plan. */
-    vendorProductId?: string;
-    /** Selected payment cycle. */
-    cycle?: PaymentCycle$1;
-    /** Plan expiration date. */
-    expiresOn?: Date;
-    /** Coupon applied to purchase (if relevant). */
-    couponName?: string | null;
-    /** Invoice ID. */
-    invoiceId?: string | null;
-}
-interface PaidPlanChanged {
-    /** Date and time of change. */
-    operationTimeStamp?: Date;
-    /** Newly purchased app plan. */
-    vendorProductId?: string;
-    /** Newly selected payment cycle. */
-    cycle?: PaymentCycle$1;
-    /** Previous app plan. */
-    previousVendorProductId?: string | null;
-    /** Previous payment cycle. */
-    previousCycle?: PaymentCycle$1;
-    /** Coupon applied to purchase (if relevant). */
-    couponName?: string | null;
-    /** Invoice ID. */
-    invoiceId?: string | null;
-}
-interface PaidPlanAutoRenewalCancelled {
-    /** Date and time of auto-renewal cancellation. */
-    operationTimeStamp?: Date;
-    /** Current app plan. */
-    vendorProductId?: string;
-    /** Current payment cycle. */
-    cycle?: PaymentCycle$1;
-    /** Supported values: `UNKNOWN_CANCELLATION_TYPE_ERROR_STATE`, `USER_CANCEL`, `FAILED_PAYMENT`, `TRANSFER_CANCELLATION_REASON`. Reason provided by app for cancellation (if relevant). */
-    cancelReason?: string | null;
-    /** Reason provided by site owner for cancellation (if relevant). */
-    userReason?: string | null;
-    /** Cancellation type. */
-    subscriptionCancellationType?: string | null;
-}
-interface GetAppInstanceResponse {
-    /** Retrieved app instance. */
-    instance?: AppInstance;
-    /** Information about the corresponding Wix site. */
-    site?: SiteInfo;
-}
-interface SiteInfo {
-    /** Display name of the site. */
-    siteDisplayName?: string | null;
-    /**
-     * 2-letter language code of the site's locale in
-     * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
-     */
-    locale?: string;
-    /**
-     * 3-letter currency code for the site's billing in
-     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
-     */
-    paymentCurrency?: string;
-    /** Information about the site's supported languages. */
-    multilingual?: Multilingual;
-    /** URL of the site. Available only in case the site has been published. */
-    url?: string | null;
-    /** Description of the site. */
-    description?: string | null;
-    /** Wix apps that are installed on the site. */
-    installedWixApps?: string[];
-    /**
-     * > **Deprecation Notice:** This parameter will be removed on June 30, 2022. Use `ownerInfo` instead.
-     * @deprecated
-     */
-    ownerEmail?: string | null;
-    /**
-     * Information about the site owner. Available only when calling
-     * _Get App Instance_ with the __Read Site Owner Email__ permission scope.
-     */
-    ownerInfo?: OwnerInfo;
-    /** Site ID. */
-    siteId?: string;
-}
-interface Multilingual {
-    /** Whether the site supports more than a single language. */
-    isMultiLingual?: boolean;
-    /** List of supported languages. Returned only when `{"isMultiLingual": true}`. */
-    supportedLanguages?: SupportedLanguage[];
-}
-interface SupportedLanguage {
-    /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
-    languageCode?: string;
-    /** Locale. */
-    locale?: Locale;
-    /** Whether the supported language is the primary language for the site. */
-    isPrimary?: boolean;
-    /** Language icon. */
-    countryCode?: string;
-    /** How the language will be resolved. For internal use. */
-    resolutionMethod?: ResolutionMethod;
-}
-interface Locale {
-    /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
-    languageCode?: string;
-    /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
-    country?: string;
-}
-declare enum ResolutionMethod {
-    QUERY_PARAM = "QUERY_PARAM",
-    SUBDOMAIN = "SUBDOMAIN",
-    SUBDIRECTORY = "SUBDIRECTORY"
-}
-interface OwnerInfo {
-    /** Site owner's email address. Identical to the site owner's login email. */
-    email?: string;
-    /**
-     * Supported values: `VERIFIED_OPT_IN`, `VERIFIED_OPT_OUT`,
-     * `NOT_VERIFIED_OPT_IN`, `NOT_VERIFIED_OPT_OUT`.
-     *
-     * Whether the site owner has verified their email and whether they have chosen
-     * to receive email notifications from Wix.
-     */
-    emailStatus?: string;
-}
-interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
-    anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
-    memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
-    wixUserId?: string;
-    /** ID of an app. */
-    appId?: string;
-    /** @readonly */
-    identityType?: WebhookIdentityType;
-}
-/** @oneof */
-interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
-    anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
-    memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
-    wixUserId?: string;
-    /** ID of an app. */
-    appId?: string;
-}
-declare enum WebhookIdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
-}
-interface GetAppInstanceResponseNonNullableFields {
-    instance?: {
-        instanceId: string;
-        appName: string;
-        isFree: boolean;
-        billing?: {
-            packageName: string;
-            billingCycle: PaymentCycle$1;
-            timeStamp: string;
-            freeTrialInfo?: {
-                status: FreeTrialStatus;
-            };
-        };
-        permissions: string[];
-        availablePlans: {
-            packageName: string;
-            source: string;
-        }[];
-        isOriginSiteTemplate: boolean;
-        copiedFromTemplate: boolean;
-        freeTrialAvailable: boolean;
-    };
-    site?: {
-        locale: string;
-        paymentCurrency: string;
-        multilingual?: {
-            isMultiLingual: boolean;
-            supportedLanguages: {
-                languageCode: string;
-                locale?: {
-                    languageCode: string;
-                    country: string;
-                };
-                isPrimary: boolean;
-                countryCode: string;
-                resolutionMethod: ResolutionMethod;
-            }[];
-        };
-        installedWixApps: string[];
-        ownerInfo?: {
-            email: string;
-            emailStatus: string;
-        };
-        siteId: string;
-    };
-}
-interface BaseEventMetadata {
-    /** App instance ID. */
-    instanceId?: string | null;
-    /** Event type. */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-}
-interface AppInstanceInstalledEnvelope {
-    data: AppInstalled;
-    metadata: BaseEventMetadata;
-}
-interface AppInstanceRemovedEnvelope {
-    data: AppRemoved;
-    metadata: BaseEventMetadata;
-}
-interface AppInstancePaidPlanPurchasedEnvelope {
-    data: PaidPlanPurchased;
-    metadata: BaseEventMetadata;
-}
-interface AppInstancePaidPlanChangedEnvelope {
-    data: PaidPlanChanged;
-    metadata: BaseEventMetadata;
-}
-interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
-    data: PaidPlanAutoRenewalCancelled;
-    metadata: BaseEventMetadata;
-}
+declare function createRESTModule$3<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
-declare function getAppInstance$1(httpClient: HttpClient): () => 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 createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
 
-declare const getAppInstance: BuildRESTFunction<typeof getAppInstance$1>;
-declare const onAppInstanceInstalled: BuildEventDefinition<typeof onAppInstanceInstalled$1>;
-declare const onAppInstanceRemoved: BuildEventDefinition<typeof onAppInstanceRemoved$1>;
-declare const onAppInstancePaidPlanPurchased: BuildEventDefinition<typeof onAppInstancePaidPlanPurchased$1>;
-declare const onAppInstancePaidPlanChanged: BuildEventDefinition<typeof onAppInstancePaidPlanChanged$1>;
-declare const onAppInstancePaidPlanAutoRenewalCancelled: BuildEventDefinition<typeof onAppInstancePaidPlanAutoRenewalCancelled$1>;
+declare const getAppInstance: ReturnType<typeof createRESTModule$3<typeof publicGetAppInstance>>;
+declare const onAppInstanceInstalled: ReturnType<typeof createEventModule<typeof publicOnAppInstanceInstalled>>;
+declare const onAppInstanceRemoved: ReturnType<typeof createEventModule<typeof publicOnAppInstanceRemoved>>;
+declare const onAppInstancePaidPlanPurchased: ReturnType<typeof createEventModule<typeof publicOnAppInstancePaidPlanPurchased>>;
+declare const onAppInstancePaidPlanChanged: ReturnType<typeof createEventModule<typeof publicOnAppInstancePaidPlanChanged>>;
+declare const onAppInstancePaidPlanAutoRenewalCancelled: ReturnType<typeof createEventModule<typeof publicOnAppInstancePaidPlanAutoRenewalCancelled>>;
 
 declare const context$3_getAppInstance: typeof getAppInstance;
 declare const context$3_onAppInstanceInstalled: typeof onAppInstanceInstalled;
@@ -674,156 +72,19 @@ declare namespace context$3 {
   export { 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 };
 }
 
-declare enum EventName {
-    UNKNOWN = "UNKNOWN",
-    APP_DASHBOARD_LOADED = "APP_DASHBOARD_LOADED",
-    APP_FINISHED_CONFIGURATION = "APP_FINISHED_CONFIGURATION",
-    APP_UPGRADED = "APP_UPGRADED",
-    PRIMARY_ACTION_PERFORMED = "PRIMARY_ACTION_PERFORMED",
-    CUSTOM = "CUSTOM",
-    CHARGE = "CHARGE",
-    FUNDS_RETURNED = "FUNDS_RETURNED",
-    APP_FINISH_BUSINESS_SETUP = "APP_FINISH_BUSINESS_SETUP",
-    APP_DEPLOYED = "APP_DEPLOYED",
-    APP_SETUP_FINISHED = "APP_SETUP_FINISHED"
-}
-interface SendBiEventOptions {
-    /**
-     * Name of the event that's triggered in your app.
-     *
-     * + `"APP_DASHBOARD_LOADED"`: A site onwer or contributor loads your app's dashboard.
-     * + `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in the Wix Developers Center.
-     * + `"APP_UPGRADED"`: The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side.
-     * + `"PRIMARY_ACTION_PERFORMED"`: A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app.
-     * + `"CHARGE"`: You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`.
-     * + `"FUNDS_RETURNED"`: Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`.
-     * + `"CUSTOM"`: Any event that's not listed here. Make sure to also send `customEventName`.
-     * + `"APP_DEPLOYED"`: Your app’s internal code implementation is changed and might affect user flows or cause a regression.
-     * + `"APP_FINISH_BUSINESS_SETUP"`: __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead.
-     * + `"APP_SETUP_FINISHED"`: The site owner completes your app's required business setup.
-     */
-    eventName?: EventName;
-    /**
-     * Name of your app's custom event that was triggered. Required when `{"eventName": "CUSTOM"}`.
-     *
-     * Min: 2 characters
-     */
-    customEventName?: string | null;
-    /**
-     * Supported values include: `"cycle_name"`, `"currency"`, `"sum"`, `"reason"`, `"app_plan_id"`.
-     * You may also submit data with keys that aren't listed here.
-     *
-     * Additional data about your app's event.
-     *
-     * + `"cycle_name"`: Supported values: `"monthly"`, `"yearly"`, `"2 years"`, `"one time"`.
-     * + `"currency"`: 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
-     * + `"sum"`: Amount of money. Required for `{"eventName": "CHARGE"}` and `{"eventName": "FUNDS_RETURNED"}`.
-     * + `"reason"`: Information about why the event was triggered in your app.
-     * + `"app_plan_id"`: ID of the your app's plan as displayed in the Developers Center. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
-     */
-    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 const sendBiEvent: BuildRESTFunction<typeof sendBiEvent$1>;
+declare const sendBiEvent: ReturnType<typeof createRESTModule$2<typeof publicSendBiEvent>>;
 
 declare const context$2_sendBiEvent: typeof sendBiEvent;
 declare namespace context$2 {
   export { context$2_sendBiEvent as sendBiEvent };
 }
 
-interface PurchasedItem {
-    /** ID of your app's paid plan. */
-    productId?: string;
-    /** Price of your app's paid plan. For example, `9.95`. */
-    price?: string;
-    /**
-     * 3-letter currency code in
-     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
-     */
-    currency?: string;
-    /** Information about the billing cycle for your app's paid plan. */
-    billingCycle?: PaymentCycle;
-    /**
-     * Date and time the site onwers have purchased your app's paid plan in
-     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
-     */
-    dateCreated?: Date;
-}
-declare enum PaymentCycle {
-    NO_CYCLE = "NO_CYCLE",
-    MONTHLY = "MONTHLY",
-    YEARLY = "YEARLY",
-    ONE_TIME = "ONE_TIME",
-    TWO_YEARS = "TWO_YEARS",
-    THREE_YEARS = "THREE_YEARS",
-    FOUR_YEARS = "FOUR_YEARS",
-    FIVE_YEARS = "FIVE_YEARS"
-}
-interface GetUrlResponse {
-    /** URL for the Wix checkout page. */
-    checkoutUrl?: string;
-    /**
-     * Token for the Wix checkout page. The token holds all data about the order
-     * you're creating a checkout for.  It is [signed](),
-     * so you can verify that it comes from Wix.
-     */
-    token?: string | null;
-}
-interface GetPurchaseHistoryResponse {
-    /** Retrieved purchases the site owners have completed for you app. */
-    purchases?: PurchasedItem[];
-}
-interface GetUrlResponseNonNullableFields {
-    checkoutUrl: string;
-}
-interface GetPurchaseHistoryResponseNonNullableFields {
-    purchases: {
-        productId: string;
-        price: string;
-        currency: string;
-        billingCycle: PaymentCycle;
-    }[];
-}
-interface GetUrlOptions {
-    /**
-     * URL for the Wix checkout page. Redirect site owners to this URL after
-     * they've successfully purchased a paid plan for your app.
-     */
-    successUrl?: string | null;
-    /**
-     * Whether the checkout is for testing purposes only. Testing is mainly
-     * relevant for in-app purchase flows. When `true`, Wix charges the site
-     * owners an amount of `0.00`.
-     */
-    testCheckout?: boolean;
-    /** Information about the paid plan's billing cycle. */
-    billingCycle?: PaymentCycle;
-    /**
-     * 2-letter country code in
-     * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
-     * format.
-     *
-     * Default: `"US"`
-     */
-    countryCode?: string | null;
-    /**
-     * 2-letter language code in
-     * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
-     *
-     * Default: `"EN"`
-     */
-    languageCode?: string | null;
-    /** Coupon code for the paid plan. Available only in case there is a discount. */
-    couponCode?: string | null;
-}
+declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
-declare function getUrl$1(httpClient: HttpClient): (productId: string, options?: GetUrlOptions) => Promise<GetUrlResponse & GetUrlResponseNonNullableFields>;
-declare function getPurchaseHistory$1(httpClient: HttpClient): () => Promise<GetPurchaseHistoryResponse & GetPurchaseHistoryResponseNonNullableFields>;
-
-declare const getUrl: BuildRESTFunction<typeof getUrl$1>;
-declare const getPurchaseHistory: BuildRESTFunction<typeof getPurchaseHistory$1>;
+declare const getUrl: ReturnType<typeof createRESTModule$1<typeof publicGetUrl>>;
+declare const getPurchaseHistory: ReturnType<typeof createRESTModule$1<typeof publicGetPurchaseHistory>>;
 
 declare const context$1_getPurchaseHistory: typeof getPurchaseHistory;
 declare const context$1_getUrl: typeof getUrl;
@@ -831,38 +92,10 @@ declare namespace context$1 {
   export { context$1_getPurchaseHistory as getPurchaseHistory, context$1_getUrl as getUrl };
 }
 
-/** Embedded script data */
-interface ScriptProperties {
-    /** Script parameters */
-    parameters?: Record<string, string>;
-    /** Whether script is disabled or not, defaults to false (not disabled) */
-    disabled?: boolean;
-}
-interface EmbedScriptResponse {
-    /** Details of the embedded script. */
-    properties?: ScriptProperties;
-}
-interface EmbedScriptResponseNonNullableFields {
-    properties?: {
-        disabled: boolean;
-    };
-}
-interface EmbedScriptOptions {
-    /** ID of the corresponding embedded script component. */
-    componentId?: string | null;
-}
-interface GetEmbeddedScriptOptions {
-    /** Component ID of the embedded script to retrieve. */
-    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 & {
-    disabled: boolean;
-}>;
+declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
-declare const embedScript: BuildRESTFunction<typeof embedScript$1>;
-declare const getEmbeddedScript: BuildRESTFunction<typeof getEmbeddedScript$1>;
+declare const embedScript: ReturnType<typeof createRESTModule<typeof publicEmbedScript>>;
+declare const getEmbeddedScript: ReturnType<typeof createRESTModule<typeof publicGetEmbeddedScript>>;
 
 declare const context_embedScript: typeof embedScript;
 declare const context_getEmbeddedScript: typeof getEmbeddedScript;

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

@@ -230,7 +230,8 @@ interface ListAppPlansByAppIdResponseNonNullableFields {
 
 interface HttpClient {
     request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
-    fetchWithAuth: (url: string | URL, init?: RequestInit) => Promise<Response>;
+    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> = {

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

@@ -298,35 +298,9 @@ declare global {
 	}
 }
 
-interface GetChargeLimitEnvelope {
-    request: GetChargeLimitRequest;
-    metadata: Context;
-}
-interface ListChargesEnvelope {
-    request: ListChargesRequest;
-    metadata: Context;
-}
-interface ChargesRejectedEventEnvelope {
-    request: ChargesRejectedRequest;
-    metadata: Context;
-}
-interface InvoiceCreatedEventEnvelope {
-    request: InvoiceCreatedRequest;
-    metadata: Context;
-}
-interface ChargeLimitUpdatedEventEnvelope {
-    request: ChargeLimitUpdatedRequest;
-    metadata: Context;
-}
-declare const provideHandlers$1: ServicePluginDefinition<{
-    getChargeLimit(payload: GetChargeLimitEnvelope): GetChargeLimitResponse | Promise<GetChargeLimitResponse>;
-    listCharges(payload: ListChargesEnvelope): ListChargesResponse | Promise<ListChargesResponse>;
-    chargesRejectedEvent(payload: ChargesRejectedEventEnvelope): ChargesRejectedResponse | Promise<ChargesRejectedResponse>;
-    invoiceCreatedEvent(payload: InvoiceCreatedEventEnvelope): InvoiceCreatedResponse | Promise<InvoiceCreatedResponse>;
-    chargeLimitUpdatedEvent(payload: ChargeLimitUpdatedEventEnvelope): ChargeLimitUpdatedResponse | Promise<ChargeLimitUpdatedResponse>;
-}>;
+declare function createServicePluginModule<T extends ServicePluginDefinition<any>>(servicePluginDefinition: T): BuildServicePluginDefinition<T> & T;
 
-declare const provideHandlers: BuildServicePluginDefinition<typeof provideHandlers$1>;
+declare const provideHandlers: ReturnType<typeof createServicePluginModule<typeof publicProvideHandlers>>;
 
 type context_AlternativeUri = AlternativeUri;
 type context_ChargeLimitUpdatedRequest = ChargeLimitUpdatedRequest;