@wix/auto_sdk_app-management_app-instances 1.0.0

package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.http.d.ts

@@ -0,0 +1,13 @@
+import { RequestOptionsFactory } from '@wix/sdk-types';
+/**
+ * Retrieves data about the instance of your app that's installed on a Wix
+ * site and data about the site itself. For example, to check whether the Wix user has installed a free or paid version of your app,
+ * or to check which apps made by Wix are installed on the site.
+ *
+ * You must authenticate this method as a Wix app ([REST](https://dev.wix.com/docs/rest/articles/getting-started/about-identities#wix-app) | [SDK](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-apps)).
+ *
+ * To retrieve `site.ownerInfo` in the response, you must
+ * have the __READ SITE OWNER EMAIL__ permission scope in addition to
+ * __MANAGE YOUR APP__.
+ */
+export declare function getAppInstance(payload: object): RequestOptionsFactory<any>;

package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.http.js

@@ -0,0 +1,108 @@
+import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';
+import { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';
+import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
+import { resolveUrl } from '@wix/sdk-runtime/rest-modules';
+function resolveComWixpressMarketAimApiAppInstanceServiceUrl(opts) {
+    const domainToMappings = {
+        'api._api_base_domain_': [
+            {
+                srcPath: '/app-instance-manager-webapp',
+                destPath: '',
+            },
+        ],
+        'www.wixapis.com': [
+            {
+                srcPath: '/apps',
+                destPath: '',
+            },
+        ],
+        'wixapis.com': [
+            {
+                srcPath: '/apps',
+                destPath: '',
+            },
+        ],
+        'dev._base_domain_': [
+            {
+                srcPath: '/_api/app-instance-manager',
+                destPath: '',
+            },
+            {
+                srcPath: '/api/v1/instance',
+                destPath: '/v1/instance',
+            },
+            {
+                srcPath: '/api/v1/scripts',
+                destPath: '/v1/scripts',
+            },
+        ],
+        'manage._base_domain_': [
+            {
+                srcPath: '/_api/app-instance-manager',
+                destPath: '',
+            },
+        ],
+        'www._base_domain_': [
+            {
+                srcPath: '/_api/app-instance-manager',
+                destPath: '',
+            },
+        ],
+        'editor._base_domain_': [
+            {
+                srcPath: '/_api/app-instance-manager',
+                destPath: '',
+            },
+        ],
+        'blocks._base_domain_': [
+            {
+                srcPath: '/_api/app-instance-manager',
+                destPath: '',
+            },
+        ],
+        'create.editorx': [
+            {
+                srcPath: '/_api/app-instance-manager',
+                destPath: '',
+            },
+        ],
+    };
+    return resolveUrl(Object.assign(opts, { domainToMappings }));
+}
+const PACKAGE_NAME = '@wix/auto_sdk_app-management_app-instances';
+/**
+ * Retrieves data about the instance of your app that's installed on a Wix
+ * site and data about the site itself. For example, to check whether the Wix user has installed a free or paid version of your app,
+ * or to check which apps made by Wix are installed on the site.
+ *
+ * You must authenticate this method as a Wix app ([REST](https://dev.wix.com/docs/rest/articles/getting-started/about-identities#wix-app) | [SDK](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-apps)).
+ *
+ * To retrieve `site.ownerInfo` in the response, you must
+ * have the __READ SITE OWNER EMAIL__ permission scope in addition to
+ * __MANAGE YOUR APP__.
+ */
+export function getAppInstance(payload) {
+    function __getAppInstance({ host }) {
+        const metadata = {
+            entityFqdn: 'wix.devcenter.app_instance.v1.app_instance',
+            method: 'GET',
+            methodFqn: 'com.wixpress.market.aim.api.AppInstanceService.GetAppInstance',
+            packageName: PACKAGE_NAME,
+            url: resolveComWixpressMarketAimApiAppInstanceServiceUrl({
+                protoPath: '/v1/instance',
+                data: payload,
+                host,
+            }),
+            params: toURLSearchParams(payload),
+            transformResponse: (payload) => transformPaths(payload, [
+                {
+                    transformFn: transformRESTTimestampToSDKTimestamp,
+                    paths: [{ path: 'instance.billing.freeTrialInfo.endDate' }],
+                },
+            ]),
+        };
+        return metadata;
+    }
+    return __getAppInstance;
+}
+//# sourceMappingURL=devcenter-app-instance-v1-app-instance-app-instances.http.js.map

package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.http.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"devcenter-app-instance-v1-app-instance-app-instances.http.js","sourceRoot":"","sources":["../../../src/devcenter-app-instance-v1-app-instance-app-instances.http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,oCAAoC,EAAE,MAAM,4CAA4C,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC;AAClF,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAI3D,SAAS,mDAAmD,CAC1D,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,OAAO;gBAChB,QAAQ,EAAE,EAAE;aACb;SACF;QACD,aAAa,EAAE;YACb;gBACE,OAAO,EAAE,OAAO;gBAChB,QAAQ,EAAE,EAAE;aACb;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,kBAAkB;gBAC3B,QAAQ,EAAE,cAAc;aACzB;YACD;gBACE,OAAO,EAAE,iBAAiB;gBAC1B,QAAQ,EAAE,aAAa;aACxB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,gBAAgB,EAAE;YAChB;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,EAAE;aACb;SACF;KACF,CAAC;IAEF,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,YAAY,GAAG,4CAA4C,CAAC;AAElE;;;;;;;;;;GAUG;AACH,MAAM,UAAU,cAAc,CAAC,OAAe;IAC5C,SAAS,gBAAgB,CAAC,EAAE,IAAI,EAAO;QACrC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4CAA4C;YACxD,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,+DAA+D;YACjE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,mDAAmD,CAAC;gBACvD,SAAS,EAAE,cAAc;gBACzB,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,iBAAiB,CAAC,OAAO,CAAC;YAClC,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,cAAc,CAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,oCAAoC;oBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,wCAAwC,EAAE,CAAC;iBAC5D;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC"}

package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.meta.d.ts

@@ -0,0 +1,13 @@
+import * as ambassadorWixDevcenterAppInstanceV1AppInstanceTypes from './devcenter-app-instance-v1-app-instance-app-instances.types.js';
+import * as ambassadorWixDevcenterAppInstanceV1AppInstanceUniversalTypes from './devcenter-app-instance-v1-app-instance-app-instances.universal.js';
+export type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+export declare function getAppInstance(): __PublicMethodMetaInfo<'GET', {}, ambassadorWixDevcenterAppInstanceV1AppInstanceUniversalTypes.GetAppInstanceRequest, ambassadorWixDevcenterAppInstanceV1AppInstanceTypes.GetAppInstanceRequest, ambassadorWixDevcenterAppInstanceV1AppInstanceUniversalTypes.GetAppInstanceResponse & ambassadorWixDevcenterAppInstanceV1AppInstanceUniversalTypes.GetAppInstanceResponseNonNullableFields, ambassadorWixDevcenterAppInstanceV1AppInstanceTypes.GetAppInstanceResponse & ambassadorWixDevcenterAppInstanceV1AppInstanceTypes.GetAppInstanceResponseNonNullableFields>;

package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.meta.js

@@ -0,0 +1,20 @@
+import * as ambassadorWixDevcenterAppInstanceV1AppInstance from './devcenter-app-instance-v1-app-instance-app-instances.http.js';
+export function getAppInstance() {
+    const payload = {};
+    const getRequestOptions = ambassadorWixDevcenterAppInstanceV1AppInstance.getAppInstance(payload);
+    const getUrl = (context) => {
+        const { url } = getRequestOptions(context);
+        return url;
+    };
+    return {
+        getUrl,
+        httpMethod: 'GET',
+        path: '/v1/instance',
+        pathParams: {},
+        __requestType: null,
+        __originalRequestType: null,
+        __responseType: null,
+        __originalResponseType: null,
+    };
+}
+//# sourceMappingURL=devcenter-app-instance-v1-app-instance-app-instances.meta.js.map

package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.meta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"devcenter-app-instance-v1-app-instance-app-instances.meta.js","sourceRoot":"","sources":["../../../src/devcenter-app-instance-v1-app-instance-app-instances.meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,8CAA8C,MAAM,gEAAgE,CAAC;AAsBjI,MAAM,UAAU,cAAc;IAU5B,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GACrB,8CAA8C,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAEzE,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,cAAc;QACpB,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC"}

package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.public.d.ts

@@ -0,0 +1,26 @@
+import { EventDefinition, HttpClient } from '@wix/sdk-types';
+import { AppInstanceInstalledEnvelope, AppInstancePaidPlanAutoRenewalCancelledEnvelope, AppInstancePaidPlanChangedEnvelope, AppInstancePaidPlanPurchasedEnvelope, AppInstanceRemovedEnvelope, GetAppInstanceResponse, GetAppInstanceResponseNonNullableFields } from './devcenter-app-instance-v1-app-instance-app-instances.universal.js';
+export declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+export declare function getAppInstance(httpClient: HttpClient): GetAppInstanceSignature;
+interface GetAppInstanceSignature {
+    /**
+     * Retrieves data about the instance of your app that's installed on a Wix
+     * site and data about the site itself. For example, to check whether the Wix user has installed a free or paid version of your app,
+     * or to check which apps made by Wix are installed on the site.
+     *
+     * You must authenticate this method as a Wix app ([REST](https://dev.wix.com/docs/rest/articles/getting-started/about-identities#wix-app) | [SDK](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-apps)).
+     *
+     * To retrieve `site.ownerInfo` in the response, you must
+     * have the __READ SITE OWNER EMAIL__ permission scope in addition to
+     * __MANAGE YOUR APP__.
+     */
+    (): Promise<GetAppInstanceResponse & GetAppInstanceResponseNonNullableFields>;
+}
+export declare const onAppInstanceInstalled: EventDefinition<AppInstanceInstalledEnvelope, "AppInstalled">;
+export declare const onAppInstanceRemoved: EventDefinition<AppInstanceRemovedEnvelope, "AppRemoved">;
+export declare const onAppInstancePaidPlanAutoRenewalCancelled: EventDefinition<AppInstancePaidPlanAutoRenewalCancelledEnvelope, "PaidPlanAutoRenewalCancelled">;
+export declare const onAppInstancePaidPlanChanged: EventDefinition<AppInstancePaidPlanChangedEnvelope, "PaidPlanChanged">;
+export declare const onAppInstancePaidPlanPurchased: EventDefinition<AppInstancePaidPlanPurchasedEnvelope, "PaidPlanPurchased">;
+export { AppInstalled, AppInstance, AppInstanceInstalledEnvelope, AppInstancePaidPlanAutoRenewalCancelledEnvelope, AppInstancePaidPlanChangedEnvelope, AppInstancePaidPlanPurchasedEnvelope, AppInstanceRemovedEnvelope, AppRemoved, AvailablePlan, BaseEventMetadata, BillingInfo, FreeTrialInfo, FreeTrialStatus, GetAppInstanceByInstanceIdRequest, GetAppInstanceRequest, GetAppInstanceResponse, GetAppInstanceResponseNonNullableFields, IdentificationData, IdentificationDataIdOneOf, Locale, MessageEnvelope, Multilingual, OwnerInfo, PaidPlanAutoRenewalCancelled, PaidPlanChanged, PaidPlanPurchased, PaymentCycle, ResolutionMethod, SiteInfo, SupportedLanguage, WebhookIdentityType, } from './devcenter-app-instance-v1-app-instance-app-instances.universal.js';

package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.public.js

@@ -0,0 +1,36 @@
+import { renameKeysFromRESTResponseToSDKResponse } from '@wix/sdk-runtime/rename-all-nested-keys';
+import { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';
+import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
+import { EventDefinition } from '@wix/sdk-types';
+import { getAppInstance as universalGetAppInstance, } from './devcenter-app-instance-v1-app-instance-app-instances.universal.js';
+export const __metadata = { PACKAGE_NAME: '@wix/app-management' };
+export function getAppInstance(httpClient) {
+    return () => universalGetAppInstance(
+    // @ts-ignore
+    { httpClient });
+}
+export const onAppInstanceInstalled = EventDefinition('AppInstalled', false, (event) => renameKeysFromRESTResponseToSDKResponse(event))();
+export const onAppInstanceRemoved = EventDefinition('AppRemoved', false, (event) => renameKeysFromRESTResponseToSDKResponse(event))();
+export const onAppInstancePaidPlanAutoRenewalCancelled = EventDefinition('PaidPlanAutoRenewalCancelled', false, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
+    {
+        transformFn: transformRESTTimestampToSDKTimestamp,
+        paths: [{ path: 'data.operationTimeStamp' }],
+    },
+])))();
+export const onAppInstancePaidPlanChanged = EventDefinition('PaidPlanChanged', false, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
+    {
+        transformFn: transformRESTTimestampToSDKTimestamp,
+        paths: [{ path: 'data.operationTimeStamp' }],
+    },
+])))();
+export const onAppInstancePaidPlanPurchased = EventDefinition('PaidPlanPurchased', false, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
+    {
+        transformFn: transformRESTTimestampToSDKTimestamp,
+        paths: [
+            { path: 'data.operationTimeStamp' },
+            { path: 'data.expiresOn' },
+        ],
+    },
+])))();
+export { FreeTrialStatus, PaymentCycle, ResolutionMethod, WebhookIdentityType, } from './devcenter-app-instance-v1-app-instance-app-instances.universal.js';
+//# sourceMappingURL=devcenter-app-instance-v1-app-instance-app-instances.public.js.map

package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"devcenter-app-instance-v1-app-instance-app-instances.public.js","sourceRoot":"","sources":["../../../src/devcenter-app-instance-v1-app-instance-app-instances.public.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uCAAuC,EAAE,MAAM,yCAAyC,CAAC;AAClG,OAAO,EAAE,oCAAoC,EAAE,MAAM,4CAA4C,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC;AAClF,OAAO,EAAE,eAAe,EAAc,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAQL,cAAc,IAAI,uBAAuB,GAC1C,MAAM,qEAAqE,CAAC;AAE7E,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,qBAAqB,EAAE,CAAC;AAElE,MAAM,UAAU,cAAc,CAC5B,UAAsB;IAEtB,OAAO,GAAG,EAAE,CACV,uBAAuB;IACrB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAiBD,MAAM,CAAC,MAAM,sBAAsB,GAAG,eAAe,CACnD,cAAc,EACd,KAAK,EACL,CAAC,KAAmC,EAAE,EAAE,CACtC,uCAAuC,CAAC,KAAK,CAAC,CACjD,EAAgC,CAAC;AAClC,MAAM,CAAC,MAAM,oBAAoB,GAAG,eAAe,CACjD,YAAY,EACZ,KAAK,EACL,CAAC,KAAiC,EAAE,EAAE,CACpC,uCAAuC,CAAC,KAAK,CAAC,CACjD,EAA8B,CAAC;AAChC,MAAM,CAAC,MAAM,yCAAyC,GAAG,eAAe,CACtE,8BAA8B,EAC9B,KAAK,EACL,CAAC,KAAsD,EAAE,EAAE,CACzD,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,yBAAyB,EAAE,CAAC;KAC7C;CACF,CAAC,CACH,CACJ,EAAmD,CAAC;AACrD,MAAM,CAAC,MAAM,4BAA4B,GAAG,eAAe,CACzD,iBAAiB,EACjB,KAAK,EACL,CAAC,KAAyC,EAAE,EAAE,CAC5C,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,yBAAyB,EAAE,CAAC;KAC7C;CACF,CAAC,CACH,CACJ,EAAsC,CAAC;AACxC,MAAM,CAAC,MAAM,8BAA8B,GAAG,eAAe,CAC3D,mBAAmB,EACnB,KAAK,EACL,CAAC,KAA2C,EAAE,EAAE,CAC9C,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,yBAAyB,EAAE;YACnC,EAAE,IAAI,EAAE,gBAAgB,EAAE;SAC3B;KACF;CACF,CAAC,CACH,CACJ,EAAwC,CAAC;AAE1C,OAAO,EAaL,eAAe,EAcf,YAAY,EACZ,gBAAgB,EAGhB,mBAAmB,GACpB,MAAM,qEAAqE,CAAC"}

package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.types.d.ts

@@ -0,0 +1,367 @@
+/**
+ * An app instance is a specific occurrence of an app on a Wix site.
+ * When a Wix user installs an 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.
+ */
+export interface AppInstance {
+    /**
+     * App instance ID. Useful to keep track of the
+     * data that's associated with the specific instance of your app
+     * installed on a Wix site.
+     */
+    instanceId?: string;
+    /** App name, as you entered it in the App Dashboard. */
+    appName?: string;
+    /** Version of your app that's installed on the Wix site. */
+    appVersion?: string | null;
+    /**
+     * Whether the Wix user has 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 Wix user has granted your app. You set the list of permissions that
+     * your app requires from the Wix user in your app's Permissions page.
+     */
+    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 when `{"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 this app instance was created when another Wix site was cloned. */
+    copiedFromTemplate?: boolean;
+    /** Whether this app instance includes a free trial that hasn't started yet. */
+    freeTrialAvailable?: boolean;
+}
+export 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;
+    /**
+     * Date and time the Wix user purchased the app's paid plan or began their free trial. 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;
+}
+export 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"
+}
+export interface FreeTrialInfo {
+    /**
+     * Current free trial status.
+     * @readonly
+     */
+    status?: FreeTrialStatus;
+    /**
+     * When the free trial has ended. Populated only once the free trial is over.
+     * @readonly
+     */
+    endDate?: Date | null;
+}
+export declare enum FreeTrialStatus {
+    /** Unknown trial status. */
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    /** The free trial is currently in progress. */
+    IN_PROGRESS = "IN_PROGRESS",
+    /** The free trial has ended. */
+    ENDED = "ENDED",
+    /** No free trial was applied, as none was available. */
+    NOT_AVAILABLE = "NOT_AVAILABLE"
+}
+export 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;
+}
+export 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;
+}
+export interface AppRemoved {
+    /** Unique identifier of the app within the website. */
+    appId?: string;
+}
+export interface PaidPlanPurchased {
+    /** Date and time of purchase. */
+    operationTimeStamp?: Date | null;
+    /** Purchased app plan. */
+    vendorProductId?: string;
+    /** Selected payment cycle. */
+    cycle?: PaymentCycle;
+    /** Plan expiration date. */
+    expiresOn?: Date | null;
+    /** Coupon applied to purchase (if relevant). */
+    couponName?: string | null;
+    /** Invoice ID. */
+    invoiceId?: string | null;
+}
+export interface PaidPlanChanged {
+    /** Date and time of change. */
+    operationTimeStamp?: Date | null;
+    /** Newly purchased app plan. */
+    vendorProductId?: string;
+    /** Newly selected payment cycle. */
+    cycle?: PaymentCycle;
+    /** Previous app plan. */
+    previousVendorProductId?: string | null;
+    /** Previous payment cycle. */
+    previousCycle?: PaymentCycle;
+    /** Coupon applied to purchase (if relevant). */
+    couponName?: string | null;
+    /** Invoice ID. */
+    invoiceId?: string | null;
+}
+export interface PaidPlanAutoRenewalCancelled {
+    /** Date and time of auto-renewal cancellation. */
+    operationTimeStamp?: Date | null;
+    /** Current app plan. */
+    vendorProductId?: string;
+    /** Current payment cycle. */
+    cycle?: PaymentCycle;
+    /** 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;
+}
+export interface GetAppInstanceRequest {
+}
+export interface GetAppInstanceResponse {
+    /** Retrieved app instance. */
+    instance?: AppInstance;
+    /** Information about the site. */
+    site?: SiteInfo;
+}
+export 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 when the site has been published. */
+    url?: string | null;
+    /** Description of the site. */
+    description?: string | null;
+    /** Apps made by Wix 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's Wix user. Available only when calling
+     * _Get App Instance_ with the __Read Site Owner Email__ permission scope.
+     */
+    ownerInfo?: OwnerInfo;
+    /** Site ID. */
+    siteId?: string;
+}
+export interface Multilingual {
+    /** Whether the site supports more than a single language. */
+    isMultiLingual?: boolean;
+    /** List of supported languages. Returned only when `{"isMultiLingual": true}`. */
+    supportedLanguages?: SupportedLanguage[];
+}
+export 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;
+}
+export 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;
+}
+export declare enum ResolutionMethod {
+    QUERY_PARAM = "QUERY_PARAM",
+    SUBDOMAIN = "SUBDOMAIN",
+    SUBDIRECTORY = "SUBDIRECTORY"
+}
+export interface OwnerInfo {
+    /** Wix user's email address. Identical to the their login email. */
+    email?: string;
+    /**
+     * Supported values: `VERIFIED_OPT_IN`, `VERIFIED_OPT_OUT`,
+     * `NOT_VERIFIED_OPT_IN`, `NOT_VERIFIED_OPT_OUT`.
+     *
+     * Whether the Wix user has verified their email and whether they have chosen
+     * to receive email notifications from Wix.
+     */
+    emailStatus?: string;
+}
+export interface GetAppInstanceByInstanceIdRequest {
+    /** ID of the app instance to retrieve. */
+    instanceId?: string;
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export 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 */
+export 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;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface FreeTrialInfoNonNullableFields {
+    status: FreeTrialStatus;
+}
+interface BillingInfoNonNullableFields {
+    packageName: string;
+    billingCycle: PaymentCycle;
+    timeStamp: string;
+    freeTrialInfo?: FreeTrialInfoNonNullableFields;
+}
+interface AvailablePlanNonNullableFields {
+    packageName: string;
+    source: string;
+}
+interface AppInstanceNonNullableFields {
+    instanceId: string;
+    appName: string;
+    isFree: boolean;
+    billing?: BillingInfoNonNullableFields;
+    permissions: string[];
+    availablePlans: AvailablePlanNonNullableFields[];
+    isOriginSiteTemplate: boolean;
+    copiedFromTemplate: boolean;
+    freeTrialAvailable: boolean;
+}
+interface LocaleNonNullableFields {
+    languageCode: string;
+    country: string;
+}
+interface SupportedLanguageNonNullableFields {
+    languageCode: string;
+    locale?: LocaleNonNullableFields;
+    isPrimary: boolean;
+    countryCode: string;
+    resolutionMethod: ResolutionMethod;
+}
+interface MultilingualNonNullableFields {
+    isMultiLingual: boolean;
+    supportedLanguages: SupportedLanguageNonNullableFields[];
+}
+interface OwnerInfoNonNullableFields {
+    email: string;
+    emailStatus: string;
+}
+interface SiteInfoNonNullableFields {
+    locale: string;
+    paymentCurrency: string;
+    multilingual?: MultilingualNonNullableFields;
+    installedWixApps: string[];
+    ownerInfo?: OwnerInfoNonNullableFields;
+    siteId: string;
+}
+export interface GetAppInstanceResponseNonNullableFields {
+    instance?: AppInstanceNonNullableFields;
+    site?: SiteInfoNonNullableFields;
+}
+export {};

package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.types.js

@@ -0,0 +1,37 @@
+export var PaymentCycle;
+(function (PaymentCycle) {
+    PaymentCycle["NO_CYCLE"] = "NO_CYCLE";
+    PaymentCycle["MONTHLY"] = "MONTHLY";
+    PaymentCycle["YEARLY"] = "YEARLY";
+    PaymentCycle["ONE_TIME"] = "ONE_TIME";
+    PaymentCycle["TWO_YEARS"] = "TWO_YEARS";
+    PaymentCycle["THREE_YEARS"] = "THREE_YEARS";
+    PaymentCycle["FOUR_YEARS"] = "FOUR_YEARS";
+    PaymentCycle["FIVE_YEARS"] = "FIVE_YEARS";
+})(PaymentCycle || (PaymentCycle = {}));
+export var FreeTrialStatus;
+(function (FreeTrialStatus) {
+    /** Unknown trial status. */
+    FreeTrialStatus["UNKNOWN_STATUS"] = "UNKNOWN_STATUS";
+    /** The free trial is currently in progress. */
+    FreeTrialStatus["IN_PROGRESS"] = "IN_PROGRESS";
+    /** The free trial has ended. */
+    FreeTrialStatus["ENDED"] = "ENDED";
+    /** No free trial was applied, as none was available. */
+    FreeTrialStatus["NOT_AVAILABLE"] = "NOT_AVAILABLE";
+})(FreeTrialStatus || (FreeTrialStatus = {}));
+export var ResolutionMethod;
+(function (ResolutionMethod) {
+    ResolutionMethod["QUERY_PARAM"] = "QUERY_PARAM";
+    ResolutionMethod["SUBDOMAIN"] = "SUBDOMAIN";
+    ResolutionMethod["SUBDIRECTORY"] = "SUBDIRECTORY";
+})(ResolutionMethod || (ResolutionMethod = {}));
+export var WebhookIdentityType;
+(function (WebhookIdentityType) {
+    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
+    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    WebhookIdentityType["MEMBER"] = "MEMBER";
+    WebhookIdentityType["WIX_USER"] = "WIX_USER";
+    WebhookIdentityType["APP"] = "APP";
+})(WebhookIdentityType || (WebhookIdentityType = {}));
+//# sourceMappingURL=devcenter-app-instance-v1-app-instance-app-instances.types.js.map

package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"devcenter-app-instance-v1-app-instance-app-instances.types.js","sourceRoot":"","sources":["../../../src/devcenter-app-instance-v1-app-instance-app-instances.types.ts"],"names":[],"mappings":"AA8FA,MAAM,CAAN,IAAY,YASX;AATD,WAAY,YAAY;IACtB,qCAAqB,CAAA;IACrB,mCAAmB,CAAA;IACnB,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,uCAAuB,CAAA;IACvB,2CAA2B,CAAA;IAC3B,yCAAyB,CAAA;IACzB,yCAAyB,CAAA;AAC3B,CAAC,EATW,YAAY,KAAZ,YAAY,QASvB;AAeD,MAAM,CAAN,IAAY,eASX;AATD,WAAY,eAAe;IACzB,4BAA4B;IAC5B,oDAAiC,CAAA;IACjC,+CAA+C;IAC/C,8CAA2B,CAAA;IAC3B,gCAAgC;IAChC,kCAAe,CAAA;IACf,wDAAwD;IACxD,kDAA+B,CAAA;AACjC,CAAC,EATW,eAAe,KAAf,eAAe,QAS1B;AA2ID,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,2CAAuB,CAAA;IACvB,iDAA6B,CAAA;AAC/B,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B;AAwDD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}