@wix/auto_sdk_apps-installer_apps-installer 1.0.0

package/build/internal/es/index.typings.d.mts

@@ -0,0 +1,837 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
+interface AppInstance {
+    /**
+     * App instance ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * ID of the app to install.
+     * @format GUID
+     */
+    appDefId?: string;
+    /**
+     * Version of the app to install.
+     *
+     * If you don't specify a version, the latest version of the app will be installed. Don't specify a version unless you want to install an older version of the app.
+     */
+    version?: string | null;
+    /** Whether the app instance is enabled. */
+    enabled?: boolean;
+    /**
+     * A signed access token of the Wix user and the app instance.
+     * @readonly
+     */
+    appToken?: string | null;
+    /**
+     * Date and time the app instance was installed.
+     * @readonly
+     */
+    installedDate?: Date | null;
+    /**
+     * Date and time the app instance was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+}
+declare enum Status {
+    /** Installation status is unknown. */
+    UNKNOWN = "UNKNOWN",
+    /** Waiting for OAUTH authentication to complete installation. */
+    WAITING_FOR_OAUTH = "WAITING_FOR_OAUTH",
+    /** App instance authenticated successfully. */
+    AUTHENTICATED = "AUTHENTICATED",
+    /** Payment hasn't been completed and is required for access to the app. */
+    DIDNT_COMPLETE_PAYMENT = "DIDNT_COMPLETE_PAYMENT"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'UNKNOWN' | 'WAITING_FOR_OAUTH' | 'AUTHENTICATED' | 'DIDNT_COMPLETE_PAYMENT';
+interface LegacyParams {
+    /** Legacy int id */
+    intId?: number | null;
+    /**
+     * Legacy source template id
+     * @format GUID
+     */
+    sourceTemplateId?: string | null;
+}
+interface DevVersionInstallation {
+    /**
+     * ID of the override to assign to the development version.
+     * @maxLength 50
+     */
+    overrideId?: string;
+}
+interface ListAppInstancesRequest {
+    /** Tenant to fetch app instances for */
+    tenant?: Tenant;
+}
+interface Tenant {
+    /** Tenant ID. For a site, this is the [site ID](https://dev.wix.com/docs/rest/account-level/sites/sites/introduction). For an account this is the [account ID](https://dev.wix.com/docs/rest/account-level/user-management/accounts/accounts/about-accounts). */
+    _id?: string;
+    /** Tenant type. This can be a Wix site or account. */
+    tenantType?: TenantTypeWithLiterals;
+}
+declare enum TenantType {
+    SITE = "SITE",
+    ACCOUNT = "ACCOUNT"
+}
+/** @enumType */
+type TenantTypeWithLiterals = TenantType | 'SITE' | 'ACCOUNT';
+interface ListAppInstancesResponse {
+    /** List of installed app instances list for the specified tenant */
+    appInstances?: AppInstance[];
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface InstallDefaultAppsEvent {
+    tenant?: Tenant;
+}
+interface Empty {
+}
+interface InstallAppRequest {
+    /** Tenant details. */
+    tenant: Tenant;
+    /** Details of the app instance to create when the app is installed. */
+    appInstance: AppInstance;
+}
+interface InstallAppResponse {
+    /** The app instance created when the app was installed. */
+    appInstance?: AppInstance;
+}
+interface AppInstalledOnTenant {
+    /** Tenant details. */
+    tenant?: Tenant;
+    /** App instance details. */
+    appInstance?: AppInstance;
+}
+interface BulkInstallAppRequest {
+    /** Tenant details. */
+    tenant?: Tenant;
+    /**
+     * Details of the app instances to create when the apps are installed.
+     * @maxSize 20
+     */
+    appInstances?: AppInstance[];
+}
+/** A list of possible additional fields to be included in the response. */
+declare enum RequestedFields {
+    /** The requested field is unknown. */
+    UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
+    /** The client spec map. */
+    CLIENT_SPEC_MAP = "CLIENT_SPEC_MAP"
+}
+/** @enumType */
+type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'CLIENT_SPEC_MAP';
+interface BulkInstallAppResponse {
+    /** Information and metadata about the app installations. */
+    results?: BulkInstallAppResult[];
+    /** Metadata about the bulk installation. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkInstallAppResult {
+    /** Metadata about the app installation. */
+    itemMetadata?: ItemMetadata;
+    /** Details of the created app instance. */
+    appInstance?: AppInstance;
+}
+interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface ClientSpecMap {
+    /** The Client Spec Map data. */
+    data?: Record<number, ClientSpec>;
+}
+/**
+ * ClientSpec is a merge of meta site and dev center data about application.
+ *
+ * This API is very old, but used a lot in editor and viewer.
+ *
+ * It represents a flatten hierarchy of subclasses of [com.wixpress.apps.dto.ClientSpec](https://github.com/wix-private/meta-site/blob/master/wix-meta-site-server/app-store-service/client-spec-map-api/src/main/scala/com/wixpress/apps/dto/ClientSpec.java).
+ */
+interface ClientSpec {
+    /** Possible values: editor, public, wixapps, appbuilder, sitemembers, siteextension, mobileapp, onboarding, metasite or ignored. */
+    type?: string;
+    /**
+     * Deprecated. Represents so-called intId -- a "position" of the application in Site Pages (previously editor saved intId
+     * instead of appDefId in pages to correlate with applications).
+     */
+    applicationId?: number;
+    appDefinitionId?: string | null;
+    instanceId?: string | null;
+    state?: string | null;
+    expirationDate?: string | null;
+    /** This field will be deprecated in the future. It currently contains either the access token or the data token. */
+    instance?: string | null;
+    /** A OAuth access token for the application - provides API access. */
+    accessToken?: string | null;
+    /** A data token for the application - provides data about the application user. */
+    dataToken?: string | null;
+    /** MetaSiteClientSpec */
+    metaSiteId?: string | null;
+    /** deprecated */
+    appDefId?: string | null;
+    /** BaseTPAClientSpec */
+    versionFailure?: string | null;
+    appWorkerUrl?: string | null;
+    appDefinitionName?: string | null;
+    sectionDefaultPage?: string | null;
+    sectionUrl?: string | null;
+    widgets?: Record<string, Widget>;
+    gluedWidgets?: Record<string, GluedWidget>;
+    pixelUrl?: string | null;
+    embeddedScriptUrl?: string | null;
+    appRequirements?: TPAAppRequirements;
+    sectionRefreshOnWidthChange?: boolean | null;
+    sectionMobileUrl?: string | null;
+    sectionPublished?: boolean | null;
+    sectionMobilePublished?: boolean | null;
+    sectionSeoEnabled?: boolean | null;
+    /** TODO check serialization */
+    isWixTPA?: boolean | null;
+    installedAtDashboard?: boolean | null;
+    permissions?: TPAPermissions;
+    appFields?: any;
+    version?: string | null;
+    requiresEditorComponent?: boolean | null;
+    editorPartDismissed?: boolean | null;
+    openPremiumPage?: boolean | null;
+    /** TPAEditorClientSpec */
+    settingsUrl?: string | null;
+    onboardingSettingsUrl?: string | null;
+    dashboardUrl?: string | null;
+    dashboardDefaultHeight?: number | null;
+    settingsDialogBanner?: string | null;
+    settingsCompanyName?: string | null;
+    settingsWidth?: number | null;
+    settingsHeight?: number | null;
+    demoMode?: boolean | null;
+    sectionSettings?: TPASettingsClientSpec;
+    vendorProductId?: string | null;
+    vendorProducts?: string[];
+    preInstalled?: boolean | null;
+    appType?: string | null;
+    provisionOnSaveSite?: boolean | null;
+    components?: any;
+    /** WLAClientSpec */
+    datastoreId?: string | null;
+    originDatastoreId?: string | null;
+    packageName?: string | null;
+    /** SiteMembersClientSpec */
+    smcollectionId?: string | null;
+    collectionType?: string | null;
+    collectionFormFace?: string | null;
+    collectionExposure?: string | null;
+    smtoken?: string | null;
+    /** MobileAppClientSpec */
+    name?: string | null;
+    iconUrl?: string | null;
+    /** OnboardingClientSpec */
+    storyId?: string | null;
+    inUse?: boolean | null;
+}
+interface Widget {
+    /** BaseTPAClientWidget */
+    widgetId?: string | null;
+    widgetUrl?: string | null;
+    tpaWidgetId?: string | null;
+    refreshOnWidthChange?: boolean | null;
+    mobileUrl?: string | null;
+    appPage?: TPAAppPage;
+    published?: boolean | null;
+    mobilePublished?: boolean | null;
+    seoEnabled?: boolean | null;
+    preFetch?: boolean | null;
+    shouldBeStretchedByDefault?: boolean | null;
+    shouldBeStretchedByDefaultMobile?: boolean | null;
+    gluedOptions?: GluedOptions;
+    componentFields?: any;
+    default?: boolean | null;
+    /** TPAEditorClientWidget */
+    defaultWidth?: number | null;
+    defaultHeight?: number | null;
+    defaultShowOnAllPages?: boolean | null;
+    settings?: TPASettingsClientSpec;
+    autoAddToSite?: boolean | null;
+    defaultPosition?: TPAWidgetPosition;
+    canBeStretched?: boolean | null;
+    santaEditorPublished?: boolean | null;
+    addOnlyOnce?: boolean | null;
+}
+interface TPAAppPage {
+    _id?: string;
+    name?: string;
+    defaultPage?: string;
+    hidden?: boolean;
+    multiInstanceEnabled?: boolean | null;
+    order?: number | null;
+    indexable?: boolean | null;
+    fullPage?: boolean | null;
+    landingPageInMobile?: boolean | null;
+    hideFromMenu?: boolean | null;
+}
+interface GluedOptions {
+    placement?: string | null;
+    verticalMargin?: number | null;
+    horizontalMargin?: number | null;
+}
+interface TPASettingsClientSpec {
+    height?: number;
+    width?: number;
+    url?: string | null;
+    urlV2?: string | null;
+    onboardingUrl?: string | null;
+    abTest?: boolean | null;
+    version?: number | null;
+}
+interface TPAWidgetPosition {
+    region?: string;
+    placement?: string;
+}
+interface GluedWidget {
+    widgetId?: string | null;
+    widgetUrl?: string | null;
+}
+interface TPAAppRequirements {
+    requireSiteMembers?: boolean;
+}
+interface TPAPermissions {
+    revoked?: boolean;
+}
+interface UninstallAppRequest {
+    /** Tenant details. */
+    tenant?: Tenant;
+    /**
+     * The ID of the app to install.
+     * @format GUID
+     */
+    appDefId: string;
+}
+interface UninstallAppResponse {
+}
+interface BulkUninstallAppRequest {
+    /** Tenant details. */
+    tenant?: Tenant;
+    /**
+     * List of apps to be uninstalled.
+     * @format GUID
+     * @maxSize 20
+     */
+    appDefIds: string[];
+}
+interface BulkUninstallAppResponse {
+    /** Information and metadata about the uninstalled apps. */
+    results?: BulkUninstallAppResult[];
+    /** Metadata about the bulk uninstallation. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkUninstallAppResult {
+    /** Metadata about the uninstalled app instance. */
+    itemMetadata?: ItemMetadata;
+    /**
+     * @format GUID
+     * @deprecated
+     * @replacedBy app_instance
+     * @targetRemovalDate 2025-09-01
+     */
+    appDefId?: string;
+    /** Details of the uninstalled app instance. */
+    appInstance?: AppInstance;
+}
+interface InstallAppFromShareUrlRequest {
+    /** Tenant details. */
+    tenant: Tenant;
+    /**
+     * ID of the share URL to install the app from.
+     *
+     * To get the share URL of an app:
+     *
+     * 1. [Generate an install link](https://dev.wix.com/docs/build-apps/develop-your-app/app-dashboard-setup/share-your-app-with-an-install-link).
+     *
+     * 2. Click the link, which will redirect you to a page where you can install the app. The URL of this page is the share URL, and the string after `install/` in the URL is the share URL ID. For example, in the share URL `https://www.wix.com/app-market/install/8d5179a2-6d46-45b0-bcfa-64f479c6a2al`, the share URL ID is `8d5179a2-6d46-45b0-bcfa-64f479c6a2al`.
+     * @format GUID
+     */
+    shareUrlId: string;
+    /** Information about the development version of the app to install. Only relevant if the share URL refers to a development version of an app created in the Wix CLI. */
+    devVersion?: DevVersionInstallation;
+}
+interface InstallAppFromShareUrlResponse {
+    /** App instance created when the app was installed. */
+    appInstance?: AppInstance;
+}
+interface IsPermittedToInstallAppsRequest extends IsPermittedToInstallAppsRequestOptionsOneOf {
+    /** Install the app using app instance details. */
+    appsInstallOptions?: AppsInstallOptions;
+    /** Install an app using a share URL. */
+    shareUrlInstallOptions?: ShareUrlInstallOptions;
+    /** Installation type. */
+    installType: InstallTypeWithLiterals;
+}
+/** @oneof */
+interface IsPermittedToInstallAppsRequestOptionsOneOf {
+    /** Install the app using app instance details. */
+    appsInstallOptions?: AppsInstallOptions;
+    /** Install an app using a share URL. */
+    shareUrlInstallOptions?: ShareUrlInstallOptions;
+}
+declare enum InstallType {
+    /** Installation type is unknown. */
+    UNKNOWN_INSTALL_TYPE = "UNKNOWN_INSTALL_TYPE",
+    /** Installation based on app instance data provided in the request. */
+    APPS_INSTALL = "APPS_INSTALL",
+    /** Installation based on a shareable app URL. */
+    SHARE_URL_INSTALL = "SHARE_URL_INSTALL"
+}
+/** @enumType */
+type InstallTypeWithLiterals = InstallType | 'UNKNOWN_INSTALL_TYPE' | 'APPS_INSTALL' | 'SHARE_URL_INSTALL';
+interface AppsInstallOptions {
+    /** Tenant details. */
+    tenant?: Tenant;
+    /**
+     * Details of the app instances to create when the apps are installed.
+     * @minSize 1
+     * @maxSize 30
+     */
+    appInstances?: AppInstance[];
+}
+interface ShareUrlInstallOptions {
+    /**
+     * ID of the share URL to install the app from.
+     * @format GUID
+     */
+    shareUrlId?: string;
+}
+interface IsPermittedToInstallAppsResponse {
+    /** Whether the installation is permitted. */
+    permitted?: boolean;
+}
+interface GetInstalledAppsRequest {
+}
+interface GetInstalledAppsResponse {
+    /** The installed app instances */
+    appInstances?: AppInstance[];
+}
+type InstallAppApplicationErrors = {
+    code?: 'DOMAIN_ENTITY_MISSING';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'UNSUPPORTED_TENANT_TYPE';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'INVALID_DEV_VERSION';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'ACCOUNT_INVALID_DEV_VERSION';
+    description?: string;
+    data?: Record<string, any>;
+};
+type InstallAppFromShareUrlApplicationErrors = {
+    code?: 'UNSUPPORTED_TENANT_TYPE';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'SHARE_URL_IS_REVOKED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'SHARE_URL_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+};
+type IsPermittedToInstallAppsApplicationErrors = {
+    code?: 'UNSUPPORTED_TENANT_TYPE';
+    description?: string;
+    data?: Record<string, any>;
+};
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+interface AppInstanceAppInstalledOnTenantEnvelope {
+    data: AppInstalledOnTenant;
+    metadata: EventMetadata;
+}
+/** @permissionId APPS_INSTALLER.INSTALL_SITE_LEVEL
+ * @webhook
+ * @eventType wix.apps.v1.app_instance_app_installed_on_tenant
+ * @serviceIdentifier wix.devcenter.apps.installer.v1.AppsInstallerService
+ * @slug app_installed_on_tenant
+ * @documentationMaturity preview
+ */
+declare function onAppInstanceAppInstalledOnTenant(handler: (event: AppInstanceAppInstalledOnTenantEnvelope) => void | Promise<void>): void;
+type AppInstanceNonNullablePaths = `_id` | `appDefId` | `enabled`;
+/**
+ * <blockquote class="warning">
+ *
+ * __Warning:__
+ * By using this API to install 3rd-party apps, you acknowledge and agree that:
+ *
+ * - Some 3rd-party apps installed with this API may access, use, copy, change, or delete all your website's data, including your and your website visitors' and members' financial and personal information.
+ * - Wix may not have reviewed the app, and can't guarantee their operation or that it will continue to function as described by the app developers.
+ * - You may be sharing sensitive information with the app. Review the terms of use and privacy policies of any app you choose to install to understand how your data will be handled.
+ * - You agree to the Wix App Market [terms of use](https://www.wix.com/about/app-market-terms).
+ *
+ * By installing any 3rd-party app through this API, you confirm your acceptance of all the above conditions.
+ *
+ * </blockquote>
+ *
+ * Installs an app on a tenant, specifying the details of the app instance to create.
+ *
+ * The ID of this app instance is automatically generated and included in the `appInstance` object in the response.
+ * @param tenant - Tenant details.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options
+ * @requiredField options.appInstance
+ * @requiredField options.appInstance.appDefId
+ * @requiredField tenant
+ * @requiredField tenant._id
+ * @permissionId APPS_INSTALLER.INSTALL_SITE_LEVEL
+ * @permissionId APPS_INSTALLER.INSTALL_ACCOUNT_LEVEL
+ * @fqn wix.devcenter.apps.installer.v1.AppsInstallerService.InstallApp
+ */
+declare function installApp(tenant: NonNullablePaths<Tenant, `_id`>, options: NonNullablePaths<InstallAppOptions, `appInstance` | `appInstance.appDefId`>): Promise<NonNullablePaths<InstallAppResponse, {
+    [P in AppInstanceNonNullablePaths]: `appInstance.${P}`;
+}[AppInstanceNonNullablePaths]> & {
+    __applicationErrorsType?: InstallAppApplicationErrors;
+}>;
+interface InstallAppOptions {
+    /** Details of the app instance to create when the app is installed. */
+    appInstance: AppInstance;
+}
+/**
+ * Uninstalls an app from a tenant.
+ *
+ * This removes the instance of a specified app from the tenant.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.appDefId
+ * @permissionId APPS_INSTALLER.UNINSTALL_SITE_LEVEL
+ * @permissionId APPS_INSTALLER.UNINSTALL_ACCOUNT_LEVEL
+ * @fqn wix.devcenter.apps.installer.v1.AppsInstallerService.UninstallApp
+ */
+declare function uninstallApp(options?: NonNullablePaths<UninstallAppOptions, `appDefId`>): Promise<void>;
+interface UninstallAppOptions {
+    /** Tenant details. */
+    tenant?: Tenant;
+    /**
+     * The ID of the app to install.
+     * @format GUID
+     */
+    appDefId: string;
+}
+/**
+ * Uninstalls apps from a tenant.
+ *
+ * This removes the instances of the specified apps from the tenant.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.appDefIds
+ * @permissionId APPS_INSTALLER.UNINSTALL_SITE_LEVEL
+ * @permissionId APPS_INSTALLER.UNINSTALL_ACCOUNT_LEVEL
+ * @fqn wix.devcenter.apps.installer.v1.AppsInstallerService.BulkUninstallApp
+ */
+declare function bulkUninstallApp(options?: NonNullablePaths<BulkUninstallAppOptions, `appDefIds`>): Promise<NonNullablePaths<BulkUninstallAppResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.appDefId` | {
+    [P in AppInstanceNonNullablePaths]: `results.${number}.appInstance.${P}`;
+}[AppInstanceNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
+interface BulkUninstallAppOptions {
+    /** Tenant details. */
+    tenant?: Tenant;
+    /**
+     * List of apps to be uninstalled.
+     * @format GUID
+     * @maxSize 20
+     */
+    appDefIds: string[];
+}
+/**
+ * <blockquote class="warning">
+ *
+ * __Warning:__
+ * By using this API to install 3rd-party apps, you acknowledge and agree that:
+ *
+ * - Some 3rd-party apps installed with this API may access, use, copy, change, or delete all your website's data, including your and your website visitors' and members' financial and personal information.
+ * - Wix may not have reviewed the app, and cannot guarantee their operation or that it will continue to function as described by the app developers.
+ * - You may be sharing sensitive information with the app. Please review the terms of use and privacy policies of any app you choose to install to understand how your data will be handled.
+ * - By utilizing this API, you agree to the Wix App Market [terms of use](https://www.wix.com/about/app-market-terms).
+ *
+ * By installing any 3rd-party app through this API, I confirm my acceptance of all the above conditions.
+ *
+ * </blockquote>
+ *
+ * Installs an app on a site using a share URL.
+ * @param tenant - Tenant details.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.shareUrlId
+ * @requiredField tenant
+ * @requiredField tenant._id
+ * @permissionId APPS_INSTALLER.INSTALL_SITE_LEVEL
+ * @permissionId APPS_INSTALLER.INSTALL_ACCOUNT_LEVEL
+ * @fqn wix.devcenter.apps.installer.v1.AppsInstallerService.InstallAppFromShareUrl
+ */
+declare function installAppFromShareUrl(tenant: NonNullablePaths<Tenant, `_id`>, options?: NonNullablePaths<InstallAppFromShareUrlOptions, `shareUrlId`>): Promise<NonNullablePaths<InstallAppFromShareUrlResponse, {
+    [P in AppInstanceNonNullablePaths]: `appInstance.${P}`;
+}[AppInstanceNonNullablePaths]> & {
+    __applicationErrorsType?: InstallAppFromShareUrlApplicationErrors;
+}>;
+interface InstallAppFromShareUrlOptions {
+    /**
+     * ID of the share URL to install the app from.
+     *
+     * To get the share URL of an app:
+     *
+     * 1. [Generate an install link](https://dev.wix.com/docs/build-apps/develop-your-app/app-dashboard-setup/share-your-app-with-an-install-link).
+     *
+     * 2. Click the link, which will redirect you to a page where you can install the app. The URL of this page is the share URL, and the string after `install/` in the URL is the share URL ID. For example, in the share URL `https://www.wix.com/app-market/install/8d5179a2-6d46-45b0-bcfa-64f479c6a2al`, the share URL ID is `8d5179a2-6d46-45b0-bcfa-64f479c6a2al`.
+     * @format GUID
+     */
+    shareUrlId: string;
+    /** Information about the development version of the app to install. Only relevant if the share URL refers to a development version of an app created in the Wix CLI. */
+    devVersion?: DevVersionInstallation;
+}
+/**
+ * Returns whether it's possible to install an app on a tenant, either by providing app instance details or using a share URL.
+ * @param installType - Installation type.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField installType
+ * @requiredField options
+ * @requiredField options.options
+ * @requiredField options.options.appsInstallOptions.tenant
+ * @requiredField options.options.appsInstallOptions.tenant._id
+ * @requiredField options.options.shareUrlInstallOptions.shareUrlId
+ * @permissionId DEV_CENTER.WRITE_APP
+ * @permissionId APPS_INSTALLER.INSTALL_SITE_LEVEL
+ * @permissionId APPS_INSTALLER.INSTALL_ACCOUNT_LEVEL
+ * @fqn wix.devcenter.apps.installer.v1.AppsInstallerService.IsPermittedToInstallApps
+ */
+declare function isPermittedToInstallApps(installType: InstallTypeWithLiterals, options: IsPermittedToInstallAppsOptions): Promise<NonNullablePaths<IsPermittedToInstallAppsResponse, `permitted`> & {
+    __applicationErrorsType?: IsPermittedToInstallAppsApplicationErrors;
+}>;
+interface IsPermittedToInstallAppsOptions extends IsPermittedToInstallAppsOptionsOptionsOneOf {
+    /** Install the app using app instance details. */
+    appsInstallOptions?: AppsInstallOptions;
+    /** Install an app using a share URL. */
+    shareUrlInstallOptions?: ShareUrlInstallOptions;
+}
+/** @oneof */
+interface IsPermittedToInstallAppsOptionsOptionsOneOf {
+    /** Install the app using app instance details. */
+    appsInstallOptions?: AppsInstallOptions;
+    /** Install an app using a share URL. */
+    shareUrlInstallOptions?: ShareUrlInstallOptions;
+}
+/**
+ * Returns the apps that are installed on the site in context
+ * @public
+ * @documentationMaturity preview
+ * @permissionId APP-MARKET.VIEW-INSTALLED-APP
+ * @applicableIdentity APP
+ * @fqn wix.devcenter.apps.installer.v1.AppsInstallerService.GetInstalledApps
+ */
+declare function getInstalledApps(): Promise<NonNullablePaths<GetInstalledAppsResponse, {
+    [P in AppInstanceNonNullablePaths]: `appInstances.${number}.${P}`;
+}[AppInstanceNonNullablePaths]>>;
+
+export { type ActionEvent, type AppInstalledOnTenant, type AppInstance, type AppInstanceAppInstalledOnTenantEnvelope, type ApplicationError, type AppsInstallOptions, type BaseEventMetadata, type BulkActionMetadata, type BulkInstallAppRequest, type BulkInstallAppResponse, type BulkInstallAppResult, type BulkUninstallAppOptions, type BulkUninstallAppRequest, type BulkUninstallAppResponse, type BulkUninstallAppResult, type ClientSpec, type ClientSpecMap, type DevVersionInstallation, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type GetInstalledAppsRequest, type GetInstalledAppsResponse, type GluedOptions, type GluedWidget, type IdentificationData, type IdentificationDataIdOneOf, type InstallAppApplicationErrors, type InstallAppFromShareUrlApplicationErrors, type InstallAppFromShareUrlOptions, type InstallAppFromShareUrlRequest, type InstallAppFromShareUrlResponse, type InstallAppOptions, type InstallAppRequest, type InstallAppResponse, type InstallDefaultAppsEvent, InstallType, type InstallTypeWithLiterals, type IsPermittedToInstallAppsApplicationErrors, type IsPermittedToInstallAppsOptions, type IsPermittedToInstallAppsOptionsOptionsOneOf, type IsPermittedToInstallAppsRequest, type IsPermittedToInstallAppsRequestOptionsOneOf, type IsPermittedToInstallAppsResponse, type ItemMetadata, type LegacyParams, type ListAppInstancesRequest, type ListAppInstancesResponse, type MessageEnvelope, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, type ShareUrlInstallOptions, Status, type StatusWithLiterals, type TPAAppPage, type TPAAppRequirements, type TPAPermissions, type TPASettingsClientSpec, type TPAWidgetPosition, type Tenant, TenantType, type TenantTypeWithLiterals, type UninstallAppOptions, type UninstallAppRequest, type UninstallAppResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type Widget, bulkUninstallApp, getInstalledApps, installApp, installAppFromShareUrl, isPermittedToInstallApps, onAppInstanceAppInstalledOnTenant, uninstallApp };