@wix/auto_sdk_app-management_app-instances 1.0.18 → 1.0.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{cjs/src/devcenter-app-instance-v1-app-instance-app-instances.types.d.ts → devcenter-app-instance-v1-app-instance-app-instances.universal-Bfi1qsvM.d.mts} +85 -35
- package/build/{internal/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.types.d.ts → devcenter-app-instance-v1-app-instance-app-instances.universal-Bfi1qsvM.d.ts} +85 -35
- package/build/index.d.mts +65 -0
- package/build/index.d.ts +65 -0
- package/build/index.js +346 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +308 -0
- package/build/index.mjs.map +1 -0
- package/build/{es/src/devcenter-app-instance-v1-app-instance-app-instances.types.d.ts → internal/devcenter-app-instance-v1-app-instance-app-instances.universal-Bfi1qsvM.d.mts} +85 -35
- package/build/internal/{es/src/devcenter-app-instance-v1-app-instance-app-instances.types.d.ts → devcenter-app-instance-v1-app-instance-app-instances.universal-Bfi1qsvM.d.ts} +85 -35
- package/build/internal/index.d.mts +65 -0
- package/build/internal/index.d.ts +65 -0
- package/build/internal/index.js +346 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +308 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +243 -0
- package/build/internal/meta.d.ts +243 -0
- package/build/internal/meta.js +148 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +121 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +243 -0
- package/build/meta.d.ts +243 -0
- package/build/meta.js +148 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +121 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.context.d.ts +0 -48
- package/build/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.context.js +0 -57
- package/build/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.context.js.map +0 -1
- package/build/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.http.d.ts +0 -13
- package/build/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.http.js +0 -112
- package/build/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.http.js.map +0 -1
- package/build/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.meta.d.ts +0 -13
- package/build/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.meta.js +0 -47
- package/build/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.meta.js.map +0 -1
- package/build/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.public.d.ts +0 -29
- package/build/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.public.js +0 -70
- package/build/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.public.js.map +0 -1
- package/build/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.types.js +0 -56
- package/build/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.types.js.map +0 -1
- package/build/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.universal.d.ts +0 -649
- package/build/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.universal.js +0 -123
- package/build/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.context.d.ts +0 -48
- package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.context.js +0 -48
- package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.context.js.map +0 -1
- package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.http.d.ts +0 -13
- package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.http.js +0 -108
- package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.http.js.map +0 -1
- package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.meta.d.ts +0 -13
- package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.meta.js +0 -20
- package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.meta.js.map +0 -1
- package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.public.d.ts +0 -29
- package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.public.js +0 -60
- package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.public.js.map +0 -1
- package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.types.js +0 -53
- package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.types.js.map +0 -1
- package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.universal.d.ts +0 -649
- package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.universal.js +0 -96
- package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.context.d.ts +0 -48
- package/build/internal/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.context.js +0 -57
- package/build/internal/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.context.js.map +0 -1
- package/build/internal/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.http.d.ts +0 -13
- package/build/internal/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.http.js +0 -112
- package/build/internal/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.http.js.map +0 -1
- package/build/internal/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.meta.d.ts +0 -13
- package/build/internal/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.meta.js +0 -47
- package/build/internal/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.meta.js.map +0 -1
- package/build/internal/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.public.d.ts +0 -29
- package/build/internal/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.public.js +0 -70
- package/build/internal/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.public.js.map +0 -1
- package/build/internal/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.types.js +0 -56
- package/build/internal/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.types.js.map +0 -1
- package/build/internal/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.universal.d.ts +0 -649
- package/build/internal/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.universal.js +0 -123
- package/build/internal/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/devcenter-app-instance-v1-app-instance-app-instances.context.d.ts +0 -48
- package/build/internal/es/src/devcenter-app-instance-v1-app-instance-app-instances.context.js +0 -48
- package/build/internal/es/src/devcenter-app-instance-v1-app-instance-app-instances.context.js.map +0 -1
- package/build/internal/es/src/devcenter-app-instance-v1-app-instance-app-instances.http.d.ts +0 -13
- package/build/internal/es/src/devcenter-app-instance-v1-app-instance-app-instances.http.js +0 -108
- package/build/internal/es/src/devcenter-app-instance-v1-app-instance-app-instances.http.js.map +0 -1
- package/build/internal/es/src/devcenter-app-instance-v1-app-instance-app-instances.meta.d.ts +0 -13
- package/build/internal/es/src/devcenter-app-instance-v1-app-instance-app-instances.meta.js +0 -20
- package/build/internal/es/src/devcenter-app-instance-v1-app-instance-app-instances.meta.js.map +0 -1
- package/build/internal/es/src/devcenter-app-instance-v1-app-instance-app-instances.public.d.ts +0 -29
- package/build/internal/es/src/devcenter-app-instance-v1-app-instance-app-instances.public.js +0 -60
- package/build/internal/es/src/devcenter-app-instance-v1-app-instance-app-instances.public.js.map +0 -1
- package/build/internal/es/src/devcenter-app-instance-v1-app-instance-app-instances.types.js +0 -53
- package/build/internal/es/src/devcenter-app-instance-v1-app-instance-app-instances.types.js.map +0 -1
- package/build/internal/es/src/devcenter-app-instance-v1-app-instance-app-instances.universal.d.ts +0 -649
- package/build/internal/es/src/devcenter-app-instance-v1-app-instance-app-instances.universal.js +0 -96
- package/build/internal/es/src/devcenter-app-instance-v1-app-instance-app-instances.universal.js.map +0 -1
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* specific site. Use the `instanceId` to keep track of the individual data
|
|
5
5
|
* associated with each app instance.
|
|
6
6
|
*/
|
|
7
|
-
|
|
7
|
+
interface AppInstance {
|
|
8
8
|
/**
|
|
9
9
|
* App instance ID. Useful to keep track of the
|
|
10
10
|
* data that's associated with the specific instance of your app
|
|
@@ -52,7 +52,7 @@ export interface AppInstance {
|
|
|
52
52
|
/** Whether this app instance includes a free trial that hasn't started yet. */
|
|
53
53
|
freeTrialAvailable?: boolean;
|
|
54
54
|
}
|
|
55
|
-
|
|
55
|
+
interface BillingInfo {
|
|
56
56
|
/** Name of the package that the site owner has paid for. */
|
|
57
57
|
packageName?: string;
|
|
58
58
|
/**
|
|
@@ -92,7 +92,7 @@ export interface BillingInfo {
|
|
|
92
92
|
/** Information about the free trial applied, if relevant. */
|
|
93
93
|
freeTrialInfo?: FreeTrialInfo;
|
|
94
94
|
}
|
|
95
|
-
|
|
95
|
+
declare enum PaymentCycle {
|
|
96
96
|
NO_CYCLE = "NO_CYCLE",
|
|
97
97
|
MONTHLY = "MONTHLY",
|
|
98
98
|
YEARLY = "YEARLY",
|
|
@@ -103,8 +103,8 @@ export declare enum PaymentCycle {
|
|
|
103
103
|
FIVE_YEARS = "FIVE_YEARS"
|
|
104
104
|
}
|
|
105
105
|
/** @enumType */
|
|
106
|
-
|
|
107
|
-
|
|
106
|
+
type PaymentCycleWithLiterals = PaymentCycle | 'NO_CYCLE' | 'MONTHLY' | 'YEARLY' | 'ONE_TIME' | 'TWO_YEARS' | 'THREE_YEARS' | 'FOUR_YEARS' | 'FIVE_YEARS';
|
|
107
|
+
interface FreeTrialInfo {
|
|
108
108
|
/**
|
|
109
109
|
* Current free trial status.
|
|
110
110
|
* @readonly
|
|
@@ -116,7 +116,7 @@ export interface FreeTrialInfo {
|
|
|
116
116
|
*/
|
|
117
117
|
endDate?: Date | null;
|
|
118
118
|
}
|
|
119
|
-
|
|
119
|
+
declare enum FreeTrialStatus {
|
|
120
120
|
/** Unknown trial status. */
|
|
121
121
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
122
122
|
/** The free trial is currently in progress. */
|
|
@@ -127,14 +127,14 @@ export declare enum FreeTrialStatus {
|
|
|
127
127
|
NOT_AVAILABLE = "NOT_AVAILABLE"
|
|
128
128
|
}
|
|
129
129
|
/** @enumType */
|
|
130
|
-
|
|
131
|
-
|
|
130
|
+
type FreeTrialStatusWithLiterals = FreeTrialStatus | 'UNKNOWN_STATUS' | 'IN_PROGRESS' | 'ENDED' | 'NOT_AVAILABLE';
|
|
131
|
+
interface AvailablePlan {
|
|
132
132
|
/** Package name of the available plan. */
|
|
133
133
|
packageName?: string;
|
|
134
134
|
/** Source of the available plan. Can be a bundle or 3rd-party app. */
|
|
135
135
|
source?: string;
|
|
136
136
|
}
|
|
137
|
-
|
|
137
|
+
interface AppInstalled {
|
|
138
138
|
/**
|
|
139
139
|
* Unique identifier of the app within the website.
|
|
140
140
|
* @format GUID
|
|
@@ -146,14 +146,14 @@ export interface AppInstalled {
|
|
|
146
146
|
*/
|
|
147
147
|
originInstanceId?: string | null;
|
|
148
148
|
}
|
|
149
|
-
|
|
149
|
+
interface AppRemoved {
|
|
150
150
|
/**
|
|
151
151
|
* Unique identifier of the app within the website.
|
|
152
152
|
* @format GUID
|
|
153
153
|
*/
|
|
154
154
|
appId?: string;
|
|
155
155
|
}
|
|
156
|
-
|
|
156
|
+
interface PaidPlanPurchased {
|
|
157
157
|
/** Date and time of purchase. */
|
|
158
158
|
operationTimeStamp?: Date | null;
|
|
159
159
|
/**
|
|
@@ -176,7 +176,7 @@ export interface PaidPlanPurchased {
|
|
|
176
176
|
*/
|
|
177
177
|
invoiceId?: string | null;
|
|
178
178
|
}
|
|
179
|
-
|
|
179
|
+
interface PaidPlanChanged {
|
|
180
180
|
/** Date and time of change. */
|
|
181
181
|
operationTimeStamp?: Date | null;
|
|
182
182
|
/**
|
|
@@ -204,7 +204,7 @@ export interface PaidPlanChanged {
|
|
|
204
204
|
*/
|
|
205
205
|
invoiceId?: string | null;
|
|
206
206
|
}
|
|
207
|
-
|
|
207
|
+
interface PaidPlanAutoRenewalCancelled {
|
|
208
208
|
/** Date and time of auto-renewal cancellation. */
|
|
209
209
|
operationTimeStamp?: Date | null;
|
|
210
210
|
/**
|
|
@@ -232,7 +232,7 @@ export interface PaidPlanAutoRenewalCancelled {
|
|
|
232
232
|
/** Whether the cancellation occurred during a free trial. */
|
|
233
233
|
cancelledDuringFreeTrial?: FreeTrialPeriodWithLiterals;
|
|
234
234
|
}
|
|
235
|
-
|
|
235
|
+
declare enum FreeTrialPeriod {
|
|
236
236
|
/** Free trial status unknown. */
|
|
237
237
|
FREE_TRIAL_PERIOD_UNKNOWN = "FREE_TRIAL_PERIOD_UNKNOWN",
|
|
238
238
|
/** During a free trial period. */
|
|
@@ -241,8 +241,8 @@ export declare enum FreeTrialPeriod {
|
|
|
241
241
|
NOT_DURING_FREE_TRIAL = "NOT_DURING_FREE_TRIAL"
|
|
242
242
|
}
|
|
243
243
|
/** @enumType */
|
|
244
|
-
|
|
245
|
-
|
|
244
|
+
type FreeTrialPeriodWithLiterals = FreeTrialPeriod | 'FREE_TRIAL_PERIOD_UNKNOWN' | 'DURING_FREE_TRIAL' | 'NOT_DURING_FREE_TRIAL';
|
|
245
|
+
interface PlanTransferred {
|
|
246
246
|
/** Date and time of transfer. */
|
|
247
247
|
operationTimeStamp?: Date | null;
|
|
248
248
|
/**
|
|
@@ -258,7 +258,7 @@ export interface PlanTransferred {
|
|
|
258
258
|
*/
|
|
259
259
|
invoiceId?: string | null;
|
|
260
260
|
}
|
|
261
|
-
|
|
261
|
+
interface PlanReactivated {
|
|
262
262
|
/** Date and time of reactivation. */
|
|
263
263
|
operationTimeStamp?: Date | null;
|
|
264
264
|
/**
|
|
@@ -278,15 +278,15 @@ export interface PlanReactivated {
|
|
|
278
278
|
/** Reason for reactivation. */
|
|
279
279
|
reason?: ReactivationReasonWithLiterals;
|
|
280
280
|
}
|
|
281
|
-
|
|
281
|
+
declare enum ReactivationReason {
|
|
282
282
|
/** Reactivation reason unknown. */
|
|
283
283
|
REACTIVATION_REASON_UNKNOWN = "REACTIVATION_REASON_UNKNOWN",
|
|
284
284
|
/** The subscription's auto-renewal is turned on. */
|
|
285
285
|
AUTO_RENEW_TURNED_ON = "AUTO_RENEW_TURNED_ON"
|
|
286
286
|
}
|
|
287
287
|
/** @enumType */
|
|
288
|
-
|
|
289
|
-
|
|
288
|
+
type ReactivationReasonWithLiterals = ReactivationReason | 'REACTIVATION_REASON_UNKNOWN' | 'AUTO_RENEW_TURNED_ON';
|
|
289
|
+
interface PlanConvertedToPaid {
|
|
290
290
|
/** Date and time of conversion to paid subscription (free-trial ended). */
|
|
291
291
|
operationTimeStamp?: Date | null;
|
|
292
292
|
/**
|
|
@@ -299,15 +299,15 @@ export interface PlanConvertedToPaid {
|
|
|
299
299
|
/** Plan expiration date. */
|
|
300
300
|
expiresOn?: Date | null;
|
|
301
301
|
}
|
|
302
|
-
|
|
302
|
+
interface GetAppInstanceRequest {
|
|
303
303
|
}
|
|
304
|
-
|
|
304
|
+
interface GetAppInstanceResponse {
|
|
305
305
|
/** Retrieved app instance. */
|
|
306
306
|
instance?: AppInstance;
|
|
307
307
|
/** Information about the site. */
|
|
308
308
|
site?: SiteInfo;
|
|
309
309
|
}
|
|
310
|
-
|
|
310
|
+
interface SiteInfo {
|
|
311
311
|
/** Display name of the site. */
|
|
312
312
|
siteDisplayName?: string | null;
|
|
313
313
|
/**
|
|
@@ -342,13 +342,13 @@ export interface SiteInfo {
|
|
|
342
342
|
/** Site ID. */
|
|
343
343
|
siteId?: string;
|
|
344
344
|
}
|
|
345
|
-
|
|
345
|
+
interface Multilingual {
|
|
346
346
|
/** Whether the site supports more than a single language. */
|
|
347
347
|
isMultiLingual?: boolean;
|
|
348
348
|
/** List of supported languages. Returned only when `{"isMultiLingual": true}`. */
|
|
349
349
|
supportedLanguages?: SupportedLanguage[];
|
|
350
350
|
}
|
|
351
|
-
|
|
351
|
+
interface SupportedLanguage {
|
|
352
352
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
353
353
|
languageCode?: string;
|
|
354
354
|
/** Locale. */
|
|
@@ -359,21 +359,23 @@ export interface SupportedLanguage {
|
|
|
359
359
|
countryCode?: string;
|
|
360
360
|
/** How the language will be resolved. For internal use. */
|
|
361
361
|
resolutionMethod?: ResolutionMethodWithLiterals;
|
|
362
|
+
/** Whether the supported language is the primary language for site visitors. */
|
|
363
|
+
isVisitorPrimary?: boolean | null;
|
|
362
364
|
}
|
|
363
|
-
|
|
365
|
+
interface Locale {
|
|
364
366
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
365
367
|
languageCode?: string;
|
|
366
368
|
/** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
367
369
|
country?: string;
|
|
368
370
|
}
|
|
369
|
-
|
|
371
|
+
declare enum ResolutionMethod {
|
|
370
372
|
QUERY_PARAM = "QUERY_PARAM",
|
|
371
373
|
SUBDOMAIN = "SUBDOMAIN",
|
|
372
374
|
SUBDIRECTORY = "SUBDIRECTORY"
|
|
373
375
|
}
|
|
374
376
|
/** @enumType */
|
|
375
|
-
|
|
376
|
-
|
|
377
|
+
type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
|
|
378
|
+
interface OwnerInfo {
|
|
377
379
|
/**
|
|
378
380
|
* Wix user's email address. Identical to the their login email.
|
|
379
381
|
* @format EMAIL
|
|
@@ -388,14 +390,14 @@ export interface OwnerInfo {
|
|
|
388
390
|
*/
|
|
389
391
|
emailStatus?: string;
|
|
390
392
|
}
|
|
391
|
-
|
|
393
|
+
interface GetAppInstanceByInstanceIdRequest {
|
|
392
394
|
/**
|
|
393
395
|
* ID of the app instance to retrieve.
|
|
394
396
|
* @format GUID
|
|
395
397
|
*/
|
|
396
398
|
instanceId?: string;
|
|
397
399
|
}
|
|
398
|
-
|
|
400
|
+
interface MessageEnvelope {
|
|
399
401
|
/**
|
|
400
402
|
* App instance ID.
|
|
401
403
|
* @format GUID
|
|
@@ -411,7 +413,7 @@ export interface MessageEnvelope {
|
|
|
411
413
|
/** Stringify payload. */
|
|
412
414
|
data?: string;
|
|
413
415
|
}
|
|
414
|
-
|
|
416
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
415
417
|
/**
|
|
416
418
|
* ID of a site visitor that has not logged in to the site.
|
|
417
419
|
* @format GUID
|
|
@@ -436,7 +438,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
436
438
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
437
439
|
}
|
|
438
440
|
/** @oneof */
|
|
439
|
-
|
|
441
|
+
interface IdentificationDataIdOneOf {
|
|
440
442
|
/**
|
|
441
443
|
* ID of a site visitor that has not logged in to the site.
|
|
442
444
|
* @format GUID
|
|
@@ -458,7 +460,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
458
460
|
*/
|
|
459
461
|
appId?: string;
|
|
460
462
|
}
|
|
461
|
-
|
|
463
|
+
declare enum WebhookIdentityType {
|
|
462
464
|
UNKNOWN = "UNKNOWN",
|
|
463
465
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
464
466
|
MEMBER = "MEMBER",
|
|
@@ -466,4 +468,52 @@ export declare enum WebhookIdentityType {
|
|
|
466
468
|
APP = "APP"
|
|
467
469
|
}
|
|
468
470
|
/** @enumType */
|
|
469
|
-
|
|
471
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
472
|
+
interface BaseEventMetadata {
|
|
473
|
+
/**
|
|
474
|
+
* App instance ID.
|
|
475
|
+
* @format GUID
|
|
476
|
+
*/
|
|
477
|
+
instanceId?: string | null;
|
|
478
|
+
/**
|
|
479
|
+
* Event type.
|
|
480
|
+
* @maxLength 150
|
|
481
|
+
*/
|
|
482
|
+
eventType?: string;
|
|
483
|
+
/** The identification type and identity data. */
|
|
484
|
+
identity?: IdentificationData;
|
|
485
|
+
}
|
|
486
|
+
interface AppInstanceInstalledEnvelope {
|
|
487
|
+
data: AppInstalled;
|
|
488
|
+
metadata: BaseEventMetadata;
|
|
489
|
+
}
|
|
490
|
+
interface AppInstanceRemovedEnvelope {
|
|
491
|
+
data: AppRemoved;
|
|
492
|
+
metadata: BaseEventMetadata;
|
|
493
|
+
}
|
|
494
|
+
interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
|
|
495
|
+
data: PaidPlanAutoRenewalCancelled;
|
|
496
|
+
metadata: BaseEventMetadata;
|
|
497
|
+
}
|
|
498
|
+
interface AppInstancePaidPlanChangedEnvelope {
|
|
499
|
+
data: PaidPlanChanged;
|
|
500
|
+
metadata: BaseEventMetadata;
|
|
501
|
+
}
|
|
502
|
+
interface AppInstancePaidPlanPurchasedEnvelope {
|
|
503
|
+
data: PaidPlanPurchased;
|
|
504
|
+
metadata: BaseEventMetadata;
|
|
505
|
+
}
|
|
506
|
+
interface AppInstancePlanConvertedToPaidEnvelope {
|
|
507
|
+
data: PlanConvertedToPaid;
|
|
508
|
+
metadata: BaseEventMetadata;
|
|
509
|
+
}
|
|
510
|
+
interface AppInstancePlanReactivatedEnvelope {
|
|
511
|
+
data: PlanReactivated;
|
|
512
|
+
metadata: BaseEventMetadata;
|
|
513
|
+
}
|
|
514
|
+
interface AppInstancePlanTransferredEnvelope {
|
|
515
|
+
data: PlanTransferred;
|
|
516
|
+
metadata: BaseEventMetadata;
|
|
517
|
+
}
|
|
518
|
+
|
|
519
|
+
export { type AppInstanceInstalledEnvelope as A, type BillingInfo as B, FreeTrialStatus as F, type GetAppInstanceResponse as G, type IdentificationData as I, type Locale as L, type Multilingual as M, type OwnerInfo as O, PaymentCycle as P, ReactivationReason as R, type SiteInfo as S, WebhookIdentityType as W, type AppInstanceRemovedEnvelope as a, type AppInstancePaidPlanAutoRenewalCancelledEnvelope as b, type AppInstancePaidPlanChangedEnvelope as c, type AppInstancePaidPlanPurchasedEnvelope as d, type AppInstancePlanConvertedToPaidEnvelope as e, type AppInstancePlanReactivatedEnvelope as f, type AppInstancePlanTransferredEnvelope as g, FreeTrialPeriod as h, ResolutionMethod as i, type AppInstance as j, type FreeTrialInfo as k, type AvailablePlan as l, type AppInstalled as m, type AppRemoved as n, type PaidPlanPurchased as o, type PaidPlanChanged as p, type PaidPlanAutoRenewalCancelled as q, type PlanTransferred as r, type PlanReactivated as s, type PlanConvertedToPaid as t, type GetAppInstanceRequest as u, type SupportedLanguage as v, type GetAppInstanceByInstanceIdRequest as w, type MessageEnvelope as x, type IdentificationDataIdOneOf as y, type BaseEventMetadata as z };
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* specific site. Use the `instanceId` to keep track of the individual data
|
|
5
5
|
* associated with each app instance.
|
|
6
6
|
*/
|
|
7
|
-
|
|
7
|
+
interface AppInstance {
|
|
8
8
|
/**
|
|
9
9
|
* App instance ID. Useful to keep track of the
|
|
10
10
|
* data that's associated with the specific instance of your app
|
|
@@ -52,7 +52,7 @@ export interface AppInstance {
|
|
|
52
52
|
/** Whether this app instance includes a free trial that hasn't started yet. */
|
|
53
53
|
freeTrialAvailable?: boolean;
|
|
54
54
|
}
|
|
55
|
-
|
|
55
|
+
interface BillingInfo {
|
|
56
56
|
/** Name of the package that the site owner has paid for. */
|
|
57
57
|
packageName?: string;
|
|
58
58
|
/**
|
|
@@ -92,7 +92,7 @@ export interface BillingInfo {
|
|
|
92
92
|
/** Information about the free trial applied, if relevant. */
|
|
93
93
|
freeTrialInfo?: FreeTrialInfo;
|
|
94
94
|
}
|
|
95
|
-
|
|
95
|
+
declare enum PaymentCycle {
|
|
96
96
|
NO_CYCLE = "NO_CYCLE",
|
|
97
97
|
MONTHLY = "MONTHLY",
|
|
98
98
|
YEARLY = "YEARLY",
|
|
@@ -103,8 +103,8 @@ export declare enum PaymentCycle {
|
|
|
103
103
|
FIVE_YEARS = "FIVE_YEARS"
|
|
104
104
|
}
|
|
105
105
|
/** @enumType */
|
|
106
|
-
|
|
107
|
-
|
|
106
|
+
type PaymentCycleWithLiterals = PaymentCycle | 'NO_CYCLE' | 'MONTHLY' | 'YEARLY' | 'ONE_TIME' | 'TWO_YEARS' | 'THREE_YEARS' | 'FOUR_YEARS' | 'FIVE_YEARS';
|
|
107
|
+
interface FreeTrialInfo {
|
|
108
108
|
/**
|
|
109
109
|
* Current free trial status.
|
|
110
110
|
* @readonly
|
|
@@ -116,7 +116,7 @@ export interface FreeTrialInfo {
|
|
|
116
116
|
*/
|
|
117
117
|
endDate?: Date | null;
|
|
118
118
|
}
|
|
119
|
-
|
|
119
|
+
declare enum FreeTrialStatus {
|
|
120
120
|
/** Unknown trial status. */
|
|
121
121
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
122
122
|
/** The free trial is currently in progress. */
|
|
@@ -127,14 +127,14 @@ export declare enum FreeTrialStatus {
|
|
|
127
127
|
NOT_AVAILABLE = "NOT_AVAILABLE"
|
|
128
128
|
}
|
|
129
129
|
/** @enumType */
|
|
130
|
-
|
|
131
|
-
|
|
130
|
+
type FreeTrialStatusWithLiterals = FreeTrialStatus | 'UNKNOWN_STATUS' | 'IN_PROGRESS' | 'ENDED' | 'NOT_AVAILABLE';
|
|
131
|
+
interface AvailablePlan {
|
|
132
132
|
/** Package name of the available plan. */
|
|
133
133
|
packageName?: string;
|
|
134
134
|
/** Source of the available plan. Can be a bundle or 3rd-party app. */
|
|
135
135
|
source?: string;
|
|
136
136
|
}
|
|
137
|
-
|
|
137
|
+
interface AppInstalled {
|
|
138
138
|
/**
|
|
139
139
|
* Unique identifier of the app within the website.
|
|
140
140
|
* @format GUID
|
|
@@ -146,14 +146,14 @@ export interface AppInstalled {
|
|
|
146
146
|
*/
|
|
147
147
|
originInstanceId?: string | null;
|
|
148
148
|
}
|
|
149
|
-
|
|
149
|
+
interface AppRemoved {
|
|
150
150
|
/**
|
|
151
151
|
* Unique identifier of the app within the website.
|
|
152
152
|
* @format GUID
|
|
153
153
|
*/
|
|
154
154
|
appId?: string;
|
|
155
155
|
}
|
|
156
|
-
|
|
156
|
+
interface PaidPlanPurchased {
|
|
157
157
|
/** Date and time of purchase. */
|
|
158
158
|
operationTimeStamp?: Date | null;
|
|
159
159
|
/**
|
|
@@ -176,7 +176,7 @@ export interface PaidPlanPurchased {
|
|
|
176
176
|
*/
|
|
177
177
|
invoiceId?: string | null;
|
|
178
178
|
}
|
|
179
|
-
|
|
179
|
+
interface PaidPlanChanged {
|
|
180
180
|
/** Date and time of change. */
|
|
181
181
|
operationTimeStamp?: Date | null;
|
|
182
182
|
/**
|
|
@@ -204,7 +204,7 @@ export interface PaidPlanChanged {
|
|
|
204
204
|
*/
|
|
205
205
|
invoiceId?: string | null;
|
|
206
206
|
}
|
|
207
|
-
|
|
207
|
+
interface PaidPlanAutoRenewalCancelled {
|
|
208
208
|
/** Date and time of auto-renewal cancellation. */
|
|
209
209
|
operationTimeStamp?: Date | null;
|
|
210
210
|
/**
|
|
@@ -232,7 +232,7 @@ export interface PaidPlanAutoRenewalCancelled {
|
|
|
232
232
|
/** Whether the cancellation occurred during a free trial. */
|
|
233
233
|
cancelledDuringFreeTrial?: FreeTrialPeriodWithLiterals;
|
|
234
234
|
}
|
|
235
|
-
|
|
235
|
+
declare enum FreeTrialPeriod {
|
|
236
236
|
/** Free trial status unknown. */
|
|
237
237
|
FREE_TRIAL_PERIOD_UNKNOWN = "FREE_TRIAL_PERIOD_UNKNOWN",
|
|
238
238
|
/** During a free trial period. */
|
|
@@ -241,8 +241,8 @@ export declare enum FreeTrialPeriod {
|
|
|
241
241
|
NOT_DURING_FREE_TRIAL = "NOT_DURING_FREE_TRIAL"
|
|
242
242
|
}
|
|
243
243
|
/** @enumType */
|
|
244
|
-
|
|
245
|
-
|
|
244
|
+
type FreeTrialPeriodWithLiterals = FreeTrialPeriod | 'FREE_TRIAL_PERIOD_UNKNOWN' | 'DURING_FREE_TRIAL' | 'NOT_DURING_FREE_TRIAL';
|
|
245
|
+
interface PlanTransferred {
|
|
246
246
|
/** Date and time of transfer. */
|
|
247
247
|
operationTimeStamp?: Date | null;
|
|
248
248
|
/**
|
|
@@ -258,7 +258,7 @@ export interface PlanTransferred {
|
|
|
258
258
|
*/
|
|
259
259
|
invoiceId?: string | null;
|
|
260
260
|
}
|
|
261
|
-
|
|
261
|
+
interface PlanReactivated {
|
|
262
262
|
/** Date and time of reactivation. */
|
|
263
263
|
operationTimeStamp?: Date | null;
|
|
264
264
|
/**
|
|
@@ -278,15 +278,15 @@ export interface PlanReactivated {
|
|
|
278
278
|
/** Reason for reactivation. */
|
|
279
279
|
reason?: ReactivationReasonWithLiterals;
|
|
280
280
|
}
|
|
281
|
-
|
|
281
|
+
declare enum ReactivationReason {
|
|
282
282
|
/** Reactivation reason unknown. */
|
|
283
283
|
REACTIVATION_REASON_UNKNOWN = "REACTIVATION_REASON_UNKNOWN",
|
|
284
284
|
/** The subscription's auto-renewal is turned on. */
|
|
285
285
|
AUTO_RENEW_TURNED_ON = "AUTO_RENEW_TURNED_ON"
|
|
286
286
|
}
|
|
287
287
|
/** @enumType */
|
|
288
|
-
|
|
289
|
-
|
|
288
|
+
type ReactivationReasonWithLiterals = ReactivationReason | 'REACTIVATION_REASON_UNKNOWN' | 'AUTO_RENEW_TURNED_ON';
|
|
289
|
+
interface PlanConvertedToPaid {
|
|
290
290
|
/** Date and time of conversion to paid subscription (free-trial ended). */
|
|
291
291
|
operationTimeStamp?: Date | null;
|
|
292
292
|
/**
|
|
@@ -299,15 +299,15 @@ export interface PlanConvertedToPaid {
|
|
|
299
299
|
/** Plan expiration date. */
|
|
300
300
|
expiresOn?: Date | null;
|
|
301
301
|
}
|
|
302
|
-
|
|
302
|
+
interface GetAppInstanceRequest {
|
|
303
303
|
}
|
|
304
|
-
|
|
304
|
+
interface GetAppInstanceResponse {
|
|
305
305
|
/** Retrieved app instance. */
|
|
306
306
|
instance?: AppInstance;
|
|
307
307
|
/** Information about the site. */
|
|
308
308
|
site?: SiteInfo;
|
|
309
309
|
}
|
|
310
|
-
|
|
310
|
+
interface SiteInfo {
|
|
311
311
|
/** Display name of the site. */
|
|
312
312
|
siteDisplayName?: string | null;
|
|
313
313
|
/**
|
|
@@ -342,13 +342,13 @@ export interface SiteInfo {
|
|
|
342
342
|
/** Site ID. */
|
|
343
343
|
siteId?: string;
|
|
344
344
|
}
|
|
345
|
-
|
|
345
|
+
interface Multilingual {
|
|
346
346
|
/** Whether the site supports more than a single language. */
|
|
347
347
|
isMultiLingual?: boolean;
|
|
348
348
|
/** List of supported languages. Returned only when `{"isMultiLingual": true}`. */
|
|
349
349
|
supportedLanguages?: SupportedLanguage[];
|
|
350
350
|
}
|
|
351
|
-
|
|
351
|
+
interface SupportedLanguage {
|
|
352
352
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
353
353
|
languageCode?: string;
|
|
354
354
|
/** Locale. */
|
|
@@ -359,21 +359,23 @@ export interface SupportedLanguage {
|
|
|
359
359
|
countryCode?: string;
|
|
360
360
|
/** How the language will be resolved. For internal use. */
|
|
361
361
|
resolutionMethod?: ResolutionMethodWithLiterals;
|
|
362
|
+
/** Whether the supported language is the primary language for site visitors. */
|
|
363
|
+
isVisitorPrimary?: boolean | null;
|
|
362
364
|
}
|
|
363
|
-
|
|
365
|
+
interface Locale {
|
|
364
366
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
365
367
|
languageCode?: string;
|
|
366
368
|
/** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
367
369
|
country?: string;
|
|
368
370
|
}
|
|
369
|
-
|
|
371
|
+
declare enum ResolutionMethod {
|
|
370
372
|
QUERY_PARAM = "QUERY_PARAM",
|
|
371
373
|
SUBDOMAIN = "SUBDOMAIN",
|
|
372
374
|
SUBDIRECTORY = "SUBDIRECTORY"
|
|
373
375
|
}
|
|
374
376
|
/** @enumType */
|
|
375
|
-
|
|
376
|
-
|
|
377
|
+
type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
|
|
378
|
+
interface OwnerInfo {
|
|
377
379
|
/**
|
|
378
380
|
* Wix user's email address. Identical to the their login email.
|
|
379
381
|
* @format EMAIL
|
|
@@ -388,14 +390,14 @@ export interface OwnerInfo {
|
|
|
388
390
|
*/
|
|
389
391
|
emailStatus?: string;
|
|
390
392
|
}
|
|
391
|
-
|
|
393
|
+
interface GetAppInstanceByInstanceIdRequest {
|
|
392
394
|
/**
|
|
393
395
|
* ID of the app instance to retrieve.
|
|
394
396
|
* @format GUID
|
|
395
397
|
*/
|
|
396
398
|
instanceId?: string;
|
|
397
399
|
}
|
|
398
|
-
|
|
400
|
+
interface MessageEnvelope {
|
|
399
401
|
/**
|
|
400
402
|
* App instance ID.
|
|
401
403
|
* @format GUID
|
|
@@ -411,7 +413,7 @@ export interface MessageEnvelope {
|
|
|
411
413
|
/** Stringify payload. */
|
|
412
414
|
data?: string;
|
|
413
415
|
}
|
|
414
|
-
|
|
416
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
415
417
|
/**
|
|
416
418
|
* ID of a site visitor that has not logged in to the site.
|
|
417
419
|
* @format GUID
|
|
@@ -436,7 +438,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
436
438
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
437
439
|
}
|
|
438
440
|
/** @oneof */
|
|
439
|
-
|
|
441
|
+
interface IdentificationDataIdOneOf {
|
|
440
442
|
/**
|
|
441
443
|
* ID of a site visitor that has not logged in to the site.
|
|
442
444
|
* @format GUID
|
|
@@ -458,7 +460,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
458
460
|
*/
|
|
459
461
|
appId?: string;
|
|
460
462
|
}
|
|
461
|
-
|
|
463
|
+
declare enum WebhookIdentityType {
|
|
462
464
|
UNKNOWN = "UNKNOWN",
|
|
463
465
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
464
466
|
MEMBER = "MEMBER",
|
|
@@ -466,4 +468,52 @@ export declare enum WebhookIdentityType {
|
|
|
466
468
|
APP = "APP"
|
|
467
469
|
}
|
|
468
470
|
/** @enumType */
|
|
469
|
-
|
|
471
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
472
|
+
interface BaseEventMetadata {
|
|
473
|
+
/**
|
|
474
|
+
* App instance ID.
|
|
475
|
+
* @format GUID
|
|
476
|
+
*/
|
|
477
|
+
instanceId?: string | null;
|
|
478
|
+
/**
|
|
479
|
+
* Event type.
|
|
480
|
+
* @maxLength 150
|
|
481
|
+
*/
|
|
482
|
+
eventType?: string;
|
|
483
|
+
/** The identification type and identity data. */
|
|
484
|
+
identity?: IdentificationData;
|
|
485
|
+
}
|
|
486
|
+
interface AppInstanceInstalledEnvelope {
|
|
487
|
+
data: AppInstalled;
|
|
488
|
+
metadata: BaseEventMetadata;
|
|
489
|
+
}
|
|
490
|
+
interface AppInstanceRemovedEnvelope {
|
|
491
|
+
data: AppRemoved;
|
|
492
|
+
metadata: BaseEventMetadata;
|
|
493
|
+
}
|
|
494
|
+
interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
|
|
495
|
+
data: PaidPlanAutoRenewalCancelled;
|
|
496
|
+
metadata: BaseEventMetadata;
|
|
497
|
+
}
|
|
498
|
+
interface AppInstancePaidPlanChangedEnvelope {
|
|
499
|
+
data: PaidPlanChanged;
|
|
500
|
+
metadata: BaseEventMetadata;
|
|
501
|
+
}
|
|
502
|
+
interface AppInstancePaidPlanPurchasedEnvelope {
|
|
503
|
+
data: PaidPlanPurchased;
|
|
504
|
+
metadata: BaseEventMetadata;
|
|
505
|
+
}
|
|
506
|
+
interface AppInstancePlanConvertedToPaidEnvelope {
|
|
507
|
+
data: PlanConvertedToPaid;
|
|
508
|
+
metadata: BaseEventMetadata;
|
|
509
|
+
}
|
|
510
|
+
interface AppInstancePlanReactivatedEnvelope {
|
|
511
|
+
data: PlanReactivated;
|
|
512
|
+
metadata: BaseEventMetadata;
|
|
513
|
+
}
|
|
514
|
+
interface AppInstancePlanTransferredEnvelope {
|
|
515
|
+
data: PlanTransferred;
|
|
516
|
+
metadata: BaseEventMetadata;
|
|
517
|
+
}
|
|
518
|
+
|
|
519
|
+
export { type AppInstanceInstalledEnvelope as A, type BillingInfo as B, FreeTrialStatus as F, type GetAppInstanceResponse as G, type IdentificationData as I, type Locale as L, type Multilingual as M, type OwnerInfo as O, PaymentCycle as P, ReactivationReason as R, type SiteInfo as S, WebhookIdentityType as W, type AppInstanceRemovedEnvelope as a, type AppInstancePaidPlanAutoRenewalCancelledEnvelope as b, type AppInstancePaidPlanChangedEnvelope as c, type AppInstancePaidPlanPurchasedEnvelope as d, type AppInstancePlanConvertedToPaidEnvelope as e, type AppInstancePlanReactivatedEnvelope as f, type AppInstancePlanTransferredEnvelope as g, FreeTrialPeriod as h, ResolutionMethod as i, type AppInstance as j, type FreeTrialInfo as k, type AvailablePlan as l, type AppInstalled as m, type AppRemoved as n, type PaidPlanPurchased as o, type PaidPlanChanged as p, type PaidPlanAutoRenewalCancelled as q, type PlanTransferred as r, type PlanReactivated as s, type PlanConvertedToPaid as t, type GetAppInstanceRequest as u, type SupportedLanguage as v, type GetAppInstanceByInstanceIdRequest as w, type MessageEnvelope as x, type IdentificationDataIdOneOf as y, type BaseEventMetadata as z };
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
+
import { G as GetAppInstanceResponse, A as AppInstanceInstalledEnvelope, a as AppInstanceRemovedEnvelope, b as AppInstancePaidPlanAutoRenewalCancelledEnvelope, c as AppInstancePaidPlanChangedEnvelope, d as AppInstancePaidPlanPurchasedEnvelope, e as AppInstancePlanConvertedToPaidEnvelope, f as AppInstancePlanReactivatedEnvelope, g as AppInstancePlanTransferredEnvelope } from './devcenter-app-instance-v1-app-instance-app-instances.universal-Bfi1qsvM.mjs';
|
|
3
|
+
export { m as AppInstalled, j as AppInstance, n as AppRemoved, l as AvailablePlan, z as BaseEventMetadata, B as BillingInfo, k as FreeTrialInfo, h as FreeTrialPeriod, F as FreeTrialStatus, w as GetAppInstanceByInstanceIdRequest, u as GetAppInstanceRequest, I as IdentificationData, y as IdentificationDataIdOneOf, L as Locale, x as MessageEnvelope, M as Multilingual, O as OwnerInfo, q as PaidPlanAutoRenewalCancelled, p as PaidPlanChanged, o as PaidPlanPurchased, P as PaymentCycle, t as PlanConvertedToPaid, s as PlanReactivated, r as PlanTransferred, R as ReactivationReason, i as ResolutionMethod, S as SiteInfo, v as SupportedLanguage, W as WebhookIdentityType } from './devcenter-app-instance-v1-app-instance-app-instances.universal-Bfi1qsvM.mjs';
|
|
4
|
+
|
|
5
|
+
declare function getAppInstance$1(httpClient: HttpClient): GetAppInstanceSignature;
|
|
6
|
+
interface GetAppInstanceSignature {
|
|
7
|
+
/**
|
|
8
|
+
* Retrieves data about the instance of your app that's installed on a Wix
|
|
9
|
+
* 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,
|
|
10
|
+
* or to check which apps made by Wix are installed on the site.
|
|
11
|
+
*
|
|
12
|
+
* You must authenticate this method [as a Wix app](https://dev.wix.com/docs/build-apps/develop-your-app/access/authentication/authenticate-using-oauth#step-2--make-an-authenticated-api-request).
|
|
13
|
+
*
|
|
14
|
+
* To retrieve `site.ownerInfo` in the response, you must
|
|
15
|
+
* have the __READ SITE OWNER EMAIL__ permission scope in addition to
|
|
16
|
+
* __MANAGE YOUR APP__.
|
|
17
|
+
*/
|
|
18
|
+
(): Promise<GetAppInstanceResponse>;
|
|
19
|
+
}
|
|
20
|
+
declare const onAppInstanceInstalled$1: EventDefinition<AppInstanceInstalledEnvelope, "AppInstalled">;
|
|
21
|
+
declare const onAppInstanceRemoved$1: EventDefinition<AppInstanceRemovedEnvelope, "AppRemoved">;
|
|
22
|
+
declare const onAppInstancePaidPlanAutoRenewalCancelled$1: EventDefinition<AppInstancePaidPlanAutoRenewalCancelledEnvelope, "PaidPlanAutoRenewalCancelled">;
|
|
23
|
+
declare const onAppInstancePaidPlanChanged$1: EventDefinition<AppInstancePaidPlanChangedEnvelope, "PaidPlanChanged">;
|
|
24
|
+
declare const onAppInstancePaidPlanPurchased$1: EventDefinition<AppInstancePaidPlanPurchasedEnvelope, "PaidPlanPurchased">;
|
|
25
|
+
declare const onAppInstancePlanConvertedToPaid$1: EventDefinition<AppInstancePlanConvertedToPaidEnvelope, "PlanConvertedToPaid">;
|
|
26
|
+
declare const onAppInstancePlanReactivated$1: EventDefinition<AppInstancePlanReactivatedEnvelope, "PlanReactivated">;
|
|
27
|
+
declare const onAppInstancePlanTransferred$1: EventDefinition<AppInstancePlanTransferredEnvelope, "PlanTransferred">;
|
|
28
|
+
|
|
29
|
+
declare const getAppInstance: MaybeContext<BuildRESTFunction<typeof getAppInstance$1> & typeof getAppInstance$1>;
|
|
30
|
+
/**
|
|
31
|
+
* Triggered when an instance of your app is installed on a Wix site.
|
|
32
|
+
*/
|
|
33
|
+
declare const onAppInstanceInstalled: BuildEventDefinition<typeof onAppInstanceInstalled$1>;
|
|
34
|
+
/**
|
|
35
|
+
* Triggered when an instance of your app is uninstalled from a Wix site.
|
|
36
|
+
*/
|
|
37
|
+
declare const onAppInstanceRemoved: BuildEventDefinition<typeof onAppInstanceRemoved$1>;
|
|
38
|
+
/**
|
|
39
|
+
* Triggered when a Wix user either cancels a paid plan for your app, or cancels the plan's auto-renewal. The
|
|
40
|
+
* Wix user can continue to use your app until the end of the current billing
|
|
41
|
+
* cycle.
|
|
42
|
+
*/
|
|
43
|
+
declare const onAppInstancePaidPlanAutoRenewalCancelled: BuildEventDefinition<typeof onAppInstancePaidPlanAutoRenewalCancelled$1>;
|
|
44
|
+
/**
|
|
45
|
+
* Triggered when a Wix user upgrades or downgrades their plan for your app.
|
|
46
|
+
*/
|
|
47
|
+
declare const onAppInstancePaidPlanChanged: BuildEventDefinition<typeof onAppInstancePaidPlanChanged$1>;
|
|
48
|
+
/**
|
|
49
|
+
* Triggered when a Wix user purchases a paid plan for your app.
|
|
50
|
+
*/
|
|
51
|
+
declare const onAppInstancePaidPlanPurchased: BuildEventDefinition<typeof onAppInstancePaidPlanPurchased$1>;
|
|
52
|
+
/**
|
|
53
|
+
* Triggered when a Wix user reaches the end of a free-trial period and is charged successfully.
|
|
54
|
+
*/
|
|
55
|
+
declare const onAppInstancePlanConvertedToPaid: BuildEventDefinition<typeof onAppInstancePlanConvertedToPaid$1>;
|
|
56
|
+
/**
|
|
57
|
+
* Triggered when auto-renewal is turned on for a paid plan.
|
|
58
|
+
*/
|
|
59
|
+
declare const onAppInstancePlanReactivated: BuildEventDefinition<typeof onAppInstancePlanReactivated$1>;
|
|
60
|
+
/**
|
|
61
|
+
* Triggered when a paid plan for your app is transferred to a different Wix account.
|
|
62
|
+
*/
|
|
63
|
+
declare const onAppInstancePlanTransferred: BuildEventDefinition<typeof onAppInstancePlanTransferred$1>;
|
|
64
|
+
|
|
65
|
+
export { AppInstanceInstalledEnvelope, AppInstancePaidPlanAutoRenewalCancelledEnvelope, AppInstancePaidPlanChangedEnvelope, AppInstancePaidPlanPurchasedEnvelope, AppInstancePlanConvertedToPaidEnvelope, AppInstancePlanReactivatedEnvelope, AppInstancePlanTransferredEnvelope, AppInstanceRemovedEnvelope, GetAppInstanceResponse, getAppInstance, onAppInstanceInstalled, onAppInstancePaidPlanAutoRenewalCancelled, onAppInstancePaidPlanChanged, onAppInstancePaidPlanPurchased, onAppInstancePlanConvertedToPaid, onAppInstancePlanReactivated, onAppInstancePlanTransferred, onAppInstanceRemoved };
|