@wix/auto_sdk_app-management_app-instances 1.0.0 → 1.0.2

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.
Files changed (17) hide show
  1. package/build/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.types.d.ts +49 -12
  2. package/build/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.types.js.map +1 -1
  3. package/build/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.universal.d.ts +67 -14
  4. package/build/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.universal.js.map +1 -1
  5. package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.types.d.ts +49 -12
  6. package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.types.js.map +1 -1
  7. package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.universal.d.ts +67 -14
  8. package/build/es/src/devcenter-app-instance-v1-app-instance-app-instances.universal.js.map +1 -1
  9. package/build/internal/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.types.d.ts +49 -12
  10. package/build/internal/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.types.js.map +1 -1
  11. package/build/internal/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.universal.d.ts +67 -14
  12. package/build/internal/cjs/src/devcenter-app-instance-v1-app-instance-app-instances.universal.js.map +1 -1
  13. package/build/internal/es/src/devcenter-app-instance-v1-app-instance-app-instances.types.d.ts +49 -12
  14. package/build/internal/es/src/devcenter-app-instance-v1-app-instance-app-instances.types.js.map +1 -1
  15. package/build/internal/es/src/devcenter-app-instance-v1-app-instance-app-instances.universal.d.ts +67 -14
  16. package/build/internal/es/src/devcenter-app-instance-v1-app-instance-app-instances.universal.js.map +1 -1
  17. package/package.json +2 -2
@@ -213,6 +213,7 @@ export interface SiteInfo {
213
213
  installedWixApps?: string[];
214
214
  /**
215
215
  * > **Deprecation Notice:** This parameter will be removed on June 30, 2022. Use `ownerInfo` instead.
216
+ * @format EMAIL
216
217
  * @deprecated
217
218
  */
218
219
  ownerEmail?: string | null;
@@ -254,7 +255,10 @@ export declare enum ResolutionMethod {
254
255
  SUBDIRECTORY = "SUBDIRECTORY"
255
256
  }
256
257
  export interface OwnerInfo {
257
- /** Wix user's email address. Identical to the their login email. */
258
+ /**
259
+ * Wix user's email address. Identical to the their login email.
260
+ * @format EMAIL
261
+ */
258
262
  email?: string;
259
263
  /**
260
264
  * Supported values: `VERIFIED_OPT_IN`, `VERIFIED_OPT_OUT`,
@@ -266,13 +270,22 @@ export interface OwnerInfo {
266
270
  emailStatus?: string;
267
271
  }
268
272
  export interface GetAppInstanceByInstanceIdRequest {
269
- /** ID of the app instance to retrieve. */
273
+ /**
274
+ * ID of the app instance to retrieve.
275
+ * @format GUID
276
+ */
270
277
  instanceId?: string;
271
278
  }
272
279
  export interface MessageEnvelope {
273
- /** App instance ID. */
280
+ /**
281
+ * App instance ID.
282
+ * @format GUID
283
+ */
274
284
  instanceId?: string | null;
275
- /** Event type. */
285
+ /**
286
+ * Event type.
287
+ * @maxLength 150
288
+ */
276
289
  eventType?: string;
277
290
  /** The identification type and identity data. */
278
291
  identity?: IdentificationData;
@@ -280,26 +293,50 @@ export interface MessageEnvelope {
280
293
  data?: string;
281
294
  }
282
295
  export interface IdentificationData extends IdentificationDataIdOneOf {
283
- /** ID of a site visitor that has not logged in to the site. */
296
+ /**
297
+ * ID of a site visitor that has not logged in to the site.
298
+ * @format GUID
299
+ */
284
300
  anonymousVisitorId?: string;
285
- /** ID of a site visitor that has logged in to the site. */
301
+ /**
302
+ * ID of a site visitor that has logged in to the site.
303
+ * @format GUID
304
+ */
286
305
  memberId?: string;
287
- /** ID of a Wix user (site owner, contributor, etc.). */
306
+ /**
307
+ * ID of a Wix user (site owner, contributor, etc.).
308
+ * @format GUID
309
+ */
288
310
  wixUserId?: string;
289
- /** ID of an app. */
311
+ /**
312
+ * ID of an app.
313
+ * @format GUID
314
+ */
290
315
  appId?: string;
291
316
  /** @readonly */
292
317
  identityType?: WebhookIdentityType;
293
318
  }
294
319
  /** @oneof */
295
320
  export interface IdentificationDataIdOneOf {
296
- /** ID of a site visitor that has not logged in to the site. */
321
+ /**
322
+ * ID of a site visitor that has not logged in to the site.
323
+ * @format GUID
324
+ */
297
325
  anonymousVisitorId?: string;
298
- /** ID of a site visitor that has logged in to the site. */
326
+ /**
327
+ * ID of a site visitor that has logged in to the site.
328
+ * @format GUID
329
+ */
299
330
  memberId?: string;
300
- /** ID of a Wix user (site owner, contributor, etc.). */
331
+ /**
332
+ * ID of a Wix user (site owner, contributor, etc.).
333
+ * @format GUID
334
+ */
301
335
  wixUserId?: string;
302
- /** ID of an app. */
336
+ /**
337
+ * ID of an app.
338
+ * @format GUID
339
+ */
303
340
  appId?: string;
304
341
  }
305
342
  export declare enum WebhookIdentityType {
@@ -1 +1 @@
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,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,4BAAZ,YAAY,QASvB;AAeD,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,+BAAf,eAAe,QAS1B;AA2ID,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,2CAAuB,CAAA;IACvB,iDAA6B,CAAA;AAC/B,CAAC,EAJW,gBAAgB,gCAAhB,gBAAgB,QAI3B;AAwDD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
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,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,4BAAZ,YAAY,QASvB;AAeD,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,+BAAf,eAAe,QAS1B;AA4ID,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,2CAAuB,CAAA;IACvB,iDAA6B,CAAA;AAC/B,CAAC,EAJW,gBAAgB,gCAAhB,gBAAgB,QAI3B;AA4FD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
@@ -213,6 +213,7 @@ export interface SiteInfo {
213
213
  installedWixApps?: string[];
214
214
  /**
215
215
  * > **Deprecation Notice:** This parameter will be removed on June 30, 2022. Use `ownerInfo` instead.
216
+ * @format EMAIL
216
217
  * @deprecated
217
218
  */
218
219
  ownerEmail?: string | null;
@@ -254,7 +255,10 @@ export declare enum ResolutionMethod {
254
255
  SUBDIRECTORY = "SUBDIRECTORY"
255
256
  }
256
257
  export interface OwnerInfo {
257
- /** Wix user's email address. Identical to the their login email. */
258
+ /**
259
+ * Wix user's email address. Identical to the their login email.
260
+ * @format EMAIL
261
+ */
258
262
  email?: string;
259
263
  /**
260
264
  * Supported values: `VERIFIED_OPT_IN`, `VERIFIED_OPT_OUT`,
@@ -266,13 +270,22 @@ export interface OwnerInfo {
266
270
  emailStatus?: string;
267
271
  }
268
272
  export interface GetAppInstanceByInstanceIdRequest {
269
- /** ID of the app instance to retrieve. */
273
+ /**
274
+ * ID of the app instance to retrieve.
275
+ * @format GUID
276
+ */
270
277
  instanceId?: string;
271
278
  }
272
279
  export interface MessageEnvelope {
273
- /** App instance ID. */
280
+ /**
281
+ * App instance ID.
282
+ * @format GUID
283
+ */
274
284
  instanceId?: string | null;
275
- /** Event type. */
285
+ /**
286
+ * Event type.
287
+ * @maxLength 150
288
+ */
276
289
  eventType?: string;
277
290
  /** The identification type and identity data. */
278
291
  identity?: IdentificationData;
@@ -280,26 +293,50 @@ export interface MessageEnvelope {
280
293
  data?: string;
281
294
  }
282
295
  export interface IdentificationData extends IdentificationDataIdOneOf {
283
- /** ID of a site visitor that has not logged in to the site. */
296
+ /**
297
+ * ID of a site visitor that has not logged in to the site.
298
+ * @format GUID
299
+ */
284
300
  anonymousVisitorId?: string;
285
- /** ID of a site visitor that has logged in to the site. */
301
+ /**
302
+ * ID of a site visitor that has logged in to the site.
303
+ * @format GUID
304
+ */
286
305
  memberId?: string;
287
- /** ID of a Wix user (site owner, contributor, etc.). */
306
+ /**
307
+ * ID of a Wix user (site owner, contributor, etc.).
308
+ * @format GUID
309
+ */
288
310
  wixUserId?: string;
289
- /** ID of an app. */
311
+ /**
312
+ * ID of an app.
313
+ * @format GUID
314
+ */
290
315
  appId?: string;
291
316
  /** @readonly */
292
317
  identityType?: WebhookIdentityType;
293
318
  }
294
319
  /** @oneof */
295
320
  export interface IdentificationDataIdOneOf {
296
- /** ID of a site visitor that has not logged in to the site. */
321
+ /**
322
+ * ID of a site visitor that has not logged in to the site.
323
+ * @format GUID
324
+ */
297
325
  anonymousVisitorId?: string;
298
- /** ID of a site visitor that has logged in to the site. */
326
+ /**
327
+ * ID of a site visitor that has logged in to the site.
328
+ * @format GUID
329
+ */
299
330
  memberId?: string;
300
- /** ID of a Wix user (site owner, contributor, etc.). */
331
+ /**
332
+ * ID of a Wix user (site owner, contributor, etc.).
333
+ * @format GUID
334
+ */
301
335
  wixUserId?: string;
302
- /** ID of an app. */
336
+ /**
337
+ * ID of an app.
338
+ * @format GUID
339
+ */
303
340
  appId?: string;
304
341
  }
305
342
  export declare enum WebhookIdentityType {
@@ -365,9 +402,15 @@ export interface GetAppInstanceResponseNonNullableFields {
365
402
  site?: SiteInfoNonNullableFields;
366
403
  }
367
404
  export interface BaseEventMetadata {
368
- /** App instance ID. */
405
+ /**
406
+ * App instance ID.
407
+ * @format GUID
408
+ */
369
409
  instanceId?: string | null;
370
- /** Event type. */
410
+ /**
411
+ * Event type.
412
+ * @maxLength 150
413
+ */
371
414
  eventType?: string;
372
415
  /** The identification type and identity data. */
373
416
  identity?: IdentificationData;
@@ -380,6 +423,8 @@ export interface AppInstanceInstalledEnvelope {
380
423
  * Triggered when an instance of your app is installed on a Wix site.
381
424
  * @webhook
382
425
  * @eventType AppInstalled
426
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
427
+ * @slug installed
383
428
  */
384
429
  export declare function onAppInstanceInstalled(handler: (event: AppInstanceInstalledEnvelope) => void | Promise<void>): void;
385
430
  export interface AppInstanceRemovedEnvelope {
@@ -390,6 +435,8 @@ export interface AppInstanceRemovedEnvelope {
390
435
  * Triggered when an instance of your app is uninstalled from a Wix site.
391
436
  * @webhook
392
437
  * @eventType AppRemoved
438
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
439
+ * @slug removed
393
440
  */
394
441
  export declare function onAppInstanceRemoved(handler: (event: AppInstanceRemovedEnvelope) => void | Promise<void>): void;
395
442
  export interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
@@ -402,6 +449,8 @@ export interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
402
449
  * cycle.
403
450
  * @webhook
404
451
  * @eventType PaidPlanAutoRenewalCancelled
452
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
453
+ * @slug paid_plan_auto_renewal_cancelled
405
454
  */
406
455
  export declare function onAppInstancePaidPlanAutoRenewalCancelled(handler: (event: AppInstancePaidPlanAutoRenewalCancelledEnvelope) => void | Promise<void>): void;
407
456
  export interface AppInstancePaidPlanChangedEnvelope {
@@ -412,6 +461,8 @@ export interface AppInstancePaidPlanChangedEnvelope {
412
461
  * Triggered when a Wix user upgrades or downgrades their plan for your app.
413
462
  * @webhook
414
463
  * @eventType PaidPlanChanged
464
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
465
+ * @slug paid_plan_changed
415
466
  */
416
467
  export declare function onAppInstancePaidPlanChanged(handler: (event: AppInstancePaidPlanChangedEnvelope) => void | Promise<void>): void;
417
468
  export interface AppInstancePaidPlanPurchasedEnvelope {
@@ -422,6 +473,8 @@ export interface AppInstancePaidPlanPurchasedEnvelope {
422
473
  * Triggered when a Wix user purchases a paid plan for your app.
423
474
  * @webhook
424
475
  * @eventType PaidPlanPurchased
476
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
477
+ * @slug paid_plan_purchased
425
478
  */
426
479
  export declare function onAppInstancePaidPlanPurchased(handler: (event: AppInstancePaidPlanPurchasedEnvelope) => void | Promise<void>): void;
427
480
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"devcenter-app-instance-v1-app-instance-app-instances.universal.js","sourceRoot":"","sources":["../../../src/devcenter-app-instance-v1-app-instance-app-instances.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,+IAAiI;AAgGjI,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,4BAAZ,YAAY,QASvB;AAeD,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,+BAAf,eAAe,QAS1B;AA2ID,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,2CAAuB,CAAA;IACvB,iDAA6B,CAAA;AAC/B,CAAC,EAJW,gBAAgB,gCAAhB,gBAAgB,QAI3B;AAwDD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AAsJD;;;;;;;;;;;;;;;;;;GAkBG;AACI,KAAK,UAAU,cAAc;IAGlC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GACX,8CAA8C,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAEzE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAlCD,wCAkCC"}
1
+ {"version":3,"file":"devcenter-app-instance-v1-app-instance-app-instances.universal.js","sourceRoot":"","sources":["../../../src/devcenter-app-instance-v1-app-instance-app-instances.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,+IAAiI;AAgGjI,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,4BAAZ,YAAY,QASvB;AAeD,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,+BAAf,eAAe,QAS1B;AA4ID,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,2CAAuB,CAAA;IACvB,iDAA6B,CAAA;AAC/B,CAAC,EAJW,gBAAgB,gCAAhB,gBAAgB,QAI3B;AA4FD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AAsKD;;;;;;;;;;;;;;;;;;GAkBG;AACI,KAAK,UAAU,cAAc;IAGlC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GACX,8CAA8C,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAEzE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAlCD,wCAkCC"}
@@ -213,6 +213,7 @@ export interface SiteInfo {
213
213
  installedWixApps?: string[];
214
214
  /**
215
215
  * > **Deprecation Notice:** This parameter will be removed on June 30, 2022. Use `ownerInfo` instead.
216
+ * @format EMAIL
216
217
  * @deprecated
217
218
  */
218
219
  ownerEmail?: string | null;
@@ -254,7 +255,10 @@ export declare enum ResolutionMethod {
254
255
  SUBDIRECTORY = "SUBDIRECTORY"
255
256
  }
256
257
  export interface OwnerInfo {
257
- /** Wix user's email address. Identical to the their login email. */
258
+ /**
259
+ * Wix user's email address. Identical to the their login email.
260
+ * @format EMAIL
261
+ */
258
262
  email?: string;
259
263
  /**
260
264
  * Supported values: `VERIFIED_OPT_IN`, `VERIFIED_OPT_OUT`,
@@ -266,13 +270,22 @@ export interface OwnerInfo {
266
270
  emailStatus?: string;
267
271
  }
268
272
  export interface GetAppInstanceByInstanceIdRequest {
269
- /** ID of the app instance to retrieve. */
273
+ /**
274
+ * ID of the app instance to retrieve.
275
+ * @format GUID
276
+ */
270
277
  instanceId?: string;
271
278
  }
272
279
  export interface MessageEnvelope {
273
- /** App instance ID. */
280
+ /**
281
+ * App instance ID.
282
+ * @format GUID
283
+ */
274
284
  instanceId?: string | null;
275
- /** Event type. */
285
+ /**
286
+ * Event type.
287
+ * @maxLength 150
288
+ */
276
289
  eventType?: string;
277
290
  /** The identification type and identity data. */
278
291
  identity?: IdentificationData;
@@ -280,26 +293,50 @@ export interface MessageEnvelope {
280
293
  data?: string;
281
294
  }
282
295
  export interface IdentificationData extends IdentificationDataIdOneOf {
283
- /** ID of a site visitor that has not logged in to the site. */
296
+ /**
297
+ * ID of a site visitor that has not logged in to the site.
298
+ * @format GUID
299
+ */
284
300
  anonymousVisitorId?: string;
285
- /** ID of a site visitor that has logged in to the site. */
301
+ /**
302
+ * ID of a site visitor that has logged in to the site.
303
+ * @format GUID
304
+ */
286
305
  memberId?: string;
287
- /** ID of a Wix user (site owner, contributor, etc.). */
306
+ /**
307
+ * ID of a Wix user (site owner, contributor, etc.).
308
+ * @format GUID
309
+ */
288
310
  wixUserId?: string;
289
- /** ID of an app. */
311
+ /**
312
+ * ID of an app.
313
+ * @format GUID
314
+ */
290
315
  appId?: string;
291
316
  /** @readonly */
292
317
  identityType?: WebhookIdentityType;
293
318
  }
294
319
  /** @oneof */
295
320
  export interface IdentificationDataIdOneOf {
296
- /** ID of a site visitor that has not logged in to the site. */
321
+ /**
322
+ * ID of a site visitor that has not logged in to the site.
323
+ * @format GUID
324
+ */
297
325
  anonymousVisitorId?: string;
298
- /** ID of a site visitor that has logged in to the site. */
326
+ /**
327
+ * ID of a site visitor that has logged in to the site.
328
+ * @format GUID
329
+ */
299
330
  memberId?: string;
300
- /** ID of a Wix user (site owner, contributor, etc.). */
331
+ /**
332
+ * ID of a Wix user (site owner, contributor, etc.).
333
+ * @format GUID
334
+ */
301
335
  wixUserId?: string;
302
- /** ID of an app. */
336
+ /**
337
+ * ID of an app.
338
+ * @format GUID
339
+ */
303
340
  appId?: string;
304
341
  }
305
342
  export declare enum WebhookIdentityType {
@@ -1 +1 @@
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"}
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;AA4ID,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,2CAAuB,CAAA;IACvB,iDAA6B,CAAA;AAC/B,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B;AA4FD,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"}
@@ -213,6 +213,7 @@ export interface SiteInfo {
213
213
  installedWixApps?: string[];
214
214
  /**
215
215
  * > **Deprecation Notice:** This parameter will be removed on June 30, 2022. Use `ownerInfo` instead.
216
+ * @format EMAIL
216
217
  * @deprecated
217
218
  */
218
219
  ownerEmail?: string | null;
@@ -254,7 +255,10 @@ export declare enum ResolutionMethod {
254
255
  SUBDIRECTORY = "SUBDIRECTORY"
255
256
  }
256
257
  export interface OwnerInfo {
257
- /** Wix user's email address. Identical to the their login email. */
258
+ /**
259
+ * Wix user's email address. Identical to the their login email.
260
+ * @format EMAIL
261
+ */
258
262
  email?: string;
259
263
  /**
260
264
  * Supported values: `VERIFIED_OPT_IN`, `VERIFIED_OPT_OUT`,
@@ -266,13 +270,22 @@ export interface OwnerInfo {
266
270
  emailStatus?: string;
267
271
  }
268
272
  export interface GetAppInstanceByInstanceIdRequest {
269
- /** ID of the app instance to retrieve. */
273
+ /**
274
+ * ID of the app instance to retrieve.
275
+ * @format GUID
276
+ */
270
277
  instanceId?: string;
271
278
  }
272
279
  export interface MessageEnvelope {
273
- /** App instance ID. */
280
+ /**
281
+ * App instance ID.
282
+ * @format GUID
283
+ */
274
284
  instanceId?: string | null;
275
- /** Event type. */
285
+ /**
286
+ * Event type.
287
+ * @maxLength 150
288
+ */
276
289
  eventType?: string;
277
290
  /** The identification type and identity data. */
278
291
  identity?: IdentificationData;
@@ -280,26 +293,50 @@ export interface MessageEnvelope {
280
293
  data?: string;
281
294
  }
282
295
  export interface IdentificationData extends IdentificationDataIdOneOf {
283
- /** ID of a site visitor that has not logged in to the site. */
296
+ /**
297
+ * ID of a site visitor that has not logged in to the site.
298
+ * @format GUID
299
+ */
284
300
  anonymousVisitorId?: string;
285
- /** ID of a site visitor that has logged in to the site. */
301
+ /**
302
+ * ID of a site visitor that has logged in to the site.
303
+ * @format GUID
304
+ */
286
305
  memberId?: string;
287
- /** ID of a Wix user (site owner, contributor, etc.). */
306
+ /**
307
+ * ID of a Wix user (site owner, contributor, etc.).
308
+ * @format GUID
309
+ */
288
310
  wixUserId?: string;
289
- /** ID of an app. */
311
+ /**
312
+ * ID of an app.
313
+ * @format GUID
314
+ */
290
315
  appId?: string;
291
316
  /** @readonly */
292
317
  identityType?: WebhookIdentityType;
293
318
  }
294
319
  /** @oneof */
295
320
  export interface IdentificationDataIdOneOf {
296
- /** ID of a site visitor that has not logged in to the site. */
321
+ /**
322
+ * ID of a site visitor that has not logged in to the site.
323
+ * @format GUID
324
+ */
297
325
  anonymousVisitorId?: string;
298
- /** ID of a site visitor that has logged in to the site. */
326
+ /**
327
+ * ID of a site visitor that has logged in to the site.
328
+ * @format GUID
329
+ */
299
330
  memberId?: string;
300
- /** ID of a Wix user (site owner, contributor, etc.). */
331
+ /**
332
+ * ID of a Wix user (site owner, contributor, etc.).
333
+ * @format GUID
334
+ */
301
335
  wixUserId?: string;
302
- /** ID of an app. */
336
+ /**
337
+ * ID of an app.
338
+ * @format GUID
339
+ */
303
340
  appId?: string;
304
341
  }
305
342
  export declare enum WebhookIdentityType {
@@ -365,9 +402,15 @@ export interface GetAppInstanceResponseNonNullableFields {
365
402
  site?: SiteInfoNonNullableFields;
366
403
  }
367
404
  export interface BaseEventMetadata {
368
- /** App instance ID. */
405
+ /**
406
+ * App instance ID.
407
+ * @format GUID
408
+ */
369
409
  instanceId?: string | null;
370
- /** Event type. */
410
+ /**
411
+ * Event type.
412
+ * @maxLength 150
413
+ */
371
414
  eventType?: string;
372
415
  /** The identification type and identity data. */
373
416
  identity?: IdentificationData;
@@ -380,6 +423,8 @@ export interface AppInstanceInstalledEnvelope {
380
423
  * Triggered when an instance of your app is installed on a Wix site.
381
424
  * @webhook
382
425
  * @eventType AppInstalled
426
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
427
+ * @slug installed
383
428
  */
384
429
  export declare function onAppInstanceInstalled(handler: (event: AppInstanceInstalledEnvelope) => void | Promise<void>): void;
385
430
  export interface AppInstanceRemovedEnvelope {
@@ -390,6 +435,8 @@ export interface AppInstanceRemovedEnvelope {
390
435
  * Triggered when an instance of your app is uninstalled from a Wix site.
391
436
  * @webhook
392
437
  * @eventType AppRemoved
438
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
439
+ * @slug removed
393
440
  */
394
441
  export declare function onAppInstanceRemoved(handler: (event: AppInstanceRemovedEnvelope) => void | Promise<void>): void;
395
442
  export interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
@@ -402,6 +449,8 @@ export interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
402
449
  * cycle.
403
450
  * @webhook
404
451
  * @eventType PaidPlanAutoRenewalCancelled
452
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
453
+ * @slug paid_plan_auto_renewal_cancelled
405
454
  */
406
455
  export declare function onAppInstancePaidPlanAutoRenewalCancelled(handler: (event: AppInstancePaidPlanAutoRenewalCancelledEnvelope) => void | Promise<void>): void;
407
456
  export interface AppInstancePaidPlanChangedEnvelope {
@@ -412,6 +461,8 @@ export interface AppInstancePaidPlanChangedEnvelope {
412
461
  * Triggered when a Wix user upgrades or downgrades their plan for your app.
413
462
  * @webhook
414
463
  * @eventType PaidPlanChanged
464
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
465
+ * @slug paid_plan_changed
415
466
  */
416
467
  export declare function onAppInstancePaidPlanChanged(handler: (event: AppInstancePaidPlanChangedEnvelope) => void | Promise<void>): void;
417
468
  export interface AppInstancePaidPlanPurchasedEnvelope {
@@ -422,6 +473,8 @@ export interface AppInstancePaidPlanPurchasedEnvelope {
422
473
  * Triggered when a Wix user purchases a paid plan for your app.
423
474
  * @webhook
424
475
  * @eventType PaidPlanPurchased
476
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
477
+ * @slug paid_plan_purchased
425
478
  */
426
479
  export declare function onAppInstancePaidPlanPurchased(handler: (event: AppInstancePaidPlanPurchasedEnvelope) => void | Promise<void>): void;
427
480
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"devcenter-app-instance-v1-app-instance-app-instances.universal.js","sourceRoot":"","sources":["../../../src/devcenter-app-instance-v1-app-instance-app-instances.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,8CAA8C,MAAM,gEAAgE,CAAC;AAgGjI,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;AAsJD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc;IAGlC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GACX,8CAA8C,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAEzE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}
1
+ {"version":3,"file":"devcenter-app-instance-v1-app-instance-app-instances.universal.js","sourceRoot":"","sources":["../../../src/devcenter-app-instance-v1-app-instance-app-instances.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,8CAA8C,MAAM,gEAAgE,CAAC;AAgGjI,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;AA4ID,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,2CAAuB,CAAA;IACvB,iDAA6B,CAAA;AAC/B,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B;AA4FD,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;AAsKD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc;IAGlC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GACX,8CAA8C,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAEzE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}
@@ -213,6 +213,7 @@ export interface SiteInfo {
213
213
  installedWixApps?: string[];
214
214
  /**
215
215
  * > **Deprecation Notice:** This parameter will be removed on June 30, 2022. Use `ownerInfo` instead.
216
+ * @format EMAIL
216
217
  * @deprecated
217
218
  */
218
219
  ownerEmail?: string | null;
@@ -254,7 +255,10 @@ export declare enum ResolutionMethod {
254
255
  SUBDIRECTORY = "SUBDIRECTORY"
255
256
  }
256
257
  export interface OwnerInfo {
257
- /** Wix user's email address. Identical to the their login email. */
258
+ /**
259
+ * Wix user's email address. Identical to the their login email.
260
+ * @format EMAIL
261
+ */
258
262
  email?: string;
259
263
  /**
260
264
  * Supported values: `VERIFIED_OPT_IN`, `VERIFIED_OPT_OUT`,
@@ -266,13 +270,22 @@ export interface OwnerInfo {
266
270
  emailStatus?: string;
267
271
  }
268
272
  export interface GetAppInstanceByInstanceIdRequest {
269
- /** ID of the app instance to retrieve. */
273
+ /**
274
+ * ID of the app instance to retrieve.
275
+ * @format GUID
276
+ */
270
277
  instanceId?: string;
271
278
  }
272
279
  export interface MessageEnvelope {
273
- /** App instance ID. */
280
+ /**
281
+ * App instance ID.
282
+ * @format GUID
283
+ */
274
284
  instanceId?: string | null;
275
- /** Event type. */
285
+ /**
286
+ * Event type.
287
+ * @maxLength 150
288
+ */
276
289
  eventType?: string;
277
290
  /** The identification type and identity data. */
278
291
  identity?: IdentificationData;
@@ -280,26 +293,50 @@ export interface MessageEnvelope {
280
293
  data?: string;
281
294
  }
282
295
  export interface IdentificationData extends IdentificationDataIdOneOf {
283
- /** ID of a site visitor that has not logged in to the site. */
296
+ /**
297
+ * ID of a site visitor that has not logged in to the site.
298
+ * @format GUID
299
+ */
284
300
  anonymousVisitorId?: string;
285
- /** ID of a site visitor that has logged in to the site. */
301
+ /**
302
+ * ID of a site visitor that has logged in to the site.
303
+ * @format GUID
304
+ */
286
305
  memberId?: string;
287
- /** ID of a Wix user (site owner, contributor, etc.). */
306
+ /**
307
+ * ID of a Wix user (site owner, contributor, etc.).
308
+ * @format GUID
309
+ */
288
310
  wixUserId?: string;
289
- /** ID of an app. */
311
+ /**
312
+ * ID of an app.
313
+ * @format GUID
314
+ */
290
315
  appId?: string;
291
316
  /** @readonly */
292
317
  identityType?: WebhookIdentityType;
293
318
  }
294
319
  /** @oneof */
295
320
  export interface IdentificationDataIdOneOf {
296
- /** ID of a site visitor that has not logged in to the site. */
321
+ /**
322
+ * ID of a site visitor that has not logged in to the site.
323
+ * @format GUID
324
+ */
297
325
  anonymousVisitorId?: string;
298
- /** ID of a site visitor that has logged in to the site. */
326
+ /**
327
+ * ID of a site visitor that has logged in to the site.
328
+ * @format GUID
329
+ */
299
330
  memberId?: string;
300
- /** ID of a Wix user (site owner, contributor, etc.). */
331
+ /**
332
+ * ID of a Wix user (site owner, contributor, etc.).
333
+ * @format GUID
334
+ */
301
335
  wixUserId?: string;
302
- /** ID of an app. */
336
+ /**
337
+ * ID of an app.
338
+ * @format GUID
339
+ */
303
340
  appId?: string;
304
341
  }
305
342
  export declare enum WebhookIdentityType {
@@ -1 +1 @@
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,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,4BAAZ,YAAY,QASvB;AAeD,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,+BAAf,eAAe,QAS1B;AA2ID,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,2CAAuB,CAAA;IACvB,iDAA6B,CAAA;AAC/B,CAAC,EAJW,gBAAgB,gCAAhB,gBAAgB,QAI3B;AAwDD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
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,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,4BAAZ,YAAY,QASvB;AAeD,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,+BAAf,eAAe,QAS1B;AA4ID,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,2CAAuB,CAAA;IACvB,iDAA6B,CAAA;AAC/B,CAAC,EAJW,gBAAgB,gCAAhB,gBAAgB,QAI3B;AA4FD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
@@ -213,6 +213,7 @@ export interface SiteInfo {
213
213
  installedWixApps?: string[];
214
214
  /**
215
215
  * > **Deprecation Notice:** This parameter will be removed on June 30, 2022. Use `ownerInfo` instead.
216
+ * @format EMAIL
216
217
  * @deprecated
217
218
  */
218
219
  ownerEmail?: string | null;
@@ -254,7 +255,10 @@ export declare enum ResolutionMethod {
254
255
  SUBDIRECTORY = "SUBDIRECTORY"
255
256
  }
256
257
  export interface OwnerInfo {
257
- /** Wix user's email address. Identical to the their login email. */
258
+ /**
259
+ * Wix user's email address. Identical to the their login email.
260
+ * @format EMAIL
261
+ */
258
262
  email?: string;
259
263
  /**
260
264
  * Supported values: `VERIFIED_OPT_IN`, `VERIFIED_OPT_OUT`,
@@ -266,13 +270,22 @@ export interface OwnerInfo {
266
270
  emailStatus?: string;
267
271
  }
268
272
  export interface GetAppInstanceByInstanceIdRequest {
269
- /** ID of the app instance to retrieve. */
273
+ /**
274
+ * ID of the app instance to retrieve.
275
+ * @format GUID
276
+ */
270
277
  instanceId?: string;
271
278
  }
272
279
  export interface MessageEnvelope {
273
- /** App instance ID. */
280
+ /**
281
+ * App instance ID.
282
+ * @format GUID
283
+ */
274
284
  instanceId?: string | null;
275
- /** Event type. */
285
+ /**
286
+ * Event type.
287
+ * @maxLength 150
288
+ */
276
289
  eventType?: string;
277
290
  /** The identification type and identity data. */
278
291
  identity?: IdentificationData;
@@ -280,26 +293,50 @@ export interface MessageEnvelope {
280
293
  data?: string;
281
294
  }
282
295
  export interface IdentificationData extends IdentificationDataIdOneOf {
283
- /** ID of a site visitor that has not logged in to the site. */
296
+ /**
297
+ * ID of a site visitor that has not logged in to the site.
298
+ * @format GUID
299
+ */
284
300
  anonymousVisitorId?: string;
285
- /** ID of a site visitor that has logged in to the site. */
301
+ /**
302
+ * ID of a site visitor that has logged in to the site.
303
+ * @format GUID
304
+ */
286
305
  memberId?: string;
287
- /** ID of a Wix user (site owner, contributor, etc.). */
306
+ /**
307
+ * ID of a Wix user (site owner, contributor, etc.).
308
+ * @format GUID
309
+ */
288
310
  wixUserId?: string;
289
- /** ID of an app. */
311
+ /**
312
+ * ID of an app.
313
+ * @format GUID
314
+ */
290
315
  appId?: string;
291
316
  /** @readonly */
292
317
  identityType?: WebhookIdentityType;
293
318
  }
294
319
  /** @oneof */
295
320
  export interface IdentificationDataIdOneOf {
296
- /** ID of a site visitor that has not logged in to the site. */
321
+ /**
322
+ * ID of a site visitor that has not logged in to the site.
323
+ * @format GUID
324
+ */
297
325
  anonymousVisitorId?: string;
298
- /** ID of a site visitor that has logged in to the site. */
326
+ /**
327
+ * ID of a site visitor that has logged in to the site.
328
+ * @format GUID
329
+ */
299
330
  memberId?: string;
300
- /** ID of a Wix user (site owner, contributor, etc.). */
331
+ /**
332
+ * ID of a Wix user (site owner, contributor, etc.).
333
+ * @format GUID
334
+ */
301
335
  wixUserId?: string;
302
- /** ID of an app. */
336
+ /**
337
+ * ID of an app.
338
+ * @format GUID
339
+ */
303
340
  appId?: string;
304
341
  }
305
342
  export declare enum WebhookIdentityType {
@@ -365,9 +402,15 @@ export interface GetAppInstanceResponseNonNullableFields {
365
402
  site?: SiteInfoNonNullableFields;
366
403
  }
367
404
  export interface BaseEventMetadata {
368
- /** App instance ID. */
405
+ /**
406
+ * App instance ID.
407
+ * @format GUID
408
+ */
369
409
  instanceId?: string | null;
370
- /** Event type. */
410
+ /**
411
+ * Event type.
412
+ * @maxLength 150
413
+ */
371
414
  eventType?: string;
372
415
  /** The identification type and identity data. */
373
416
  identity?: IdentificationData;
@@ -380,6 +423,8 @@ export interface AppInstanceInstalledEnvelope {
380
423
  * Triggered when an instance of your app is installed on a Wix site.
381
424
  * @webhook
382
425
  * @eventType AppInstalled
426
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
427
+ * @slug installed
383
428
  */
384
429
  export declare function onAppInstanceInstalled(handler: (event: AppInstanceInstalledEnvelope) => void | Promise<void>): void;
385
430
  export interface AppInstanceRemovedEnvelope {
@@ -390,6 +435,8 @@ export interface AppInstanceRemovedEnvelope {
390
435
  * Triggered when an instance of your app is uninstalled from a Wix site.
391
436
  * @webhook
392
437
  * @eventType AppRemoved
438
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
439
+ * @slug removed
393
440
  */
394
441
  export declare function onAppInstanceRemoved(handler: (event: AppInstanceRemovedEnvelope) => void | Promise<void>): void;
395
442
  export interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
@@ -402,6 +449,8 @@ export interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
402
449
  * cycle.
403
450
  * @webhook
404
451
  * @eventType PaidPlanAutoRenewalCancelled
452
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
453
+ * @slug paid_plan_auto_renewal_cancelled
405
454
  */
406
455
  export declare function onAppInstancePaidPlanAutoRenewalCancelled(handler: (event: AppInstancePaidPlanAutoRenewalCancelledEnvelope) => void | Promise<void>): void;
407
456
  export interface AppInstancePaidPlanChangedEnvelope {
@@ -412,6 +461,8 @@ export interface AppInstancePaidPlanChangedEnvelope {
412
461
  * Triggered when a Wix user upgrades or downgrades their plan for your app.
413
462
  * @webhook
414
463
  * @eventType PaidPlanChanged
464
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
465
+ * @slug paid_plan_changed
415
466
  */
416
467
  export declare function onAppInstancePaidPlanChanged(handler: (event: AppInstancePaidPlanChangedEnvelope) => void | Promise<void>): void;
417
468
  export interface AppInstancePaidPlanPurchasedEnvelope {
@@ -422,6 +473,8 @@ export interface AppInstancePaidPlanPurchasedEnvelope {
422
473
  * Triggered when a Wix user purchases a paid plan for your app.
423
474
  * @webhook
424
475
  * @eventType PaidPlanPurchased
476
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
477
+ * @slug paid_plan_purchased
425
478
  */
426
479
  export declare function onAppInstancePaidPlanPurchased(handler: (event: AppInstancePaidPlanPurchasedEnvelope) => void | Promise<void>): void;
427
480
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"devcenter-app-instance-v1-app-instance-app-instances.universal.js","sourceRoot":"","sources":["../../../../src/devcenter-app-instance-v1-app-instance-app-instances.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,+IAAiI;AAgGjI,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,4BAAZ,YAAY,QASvB;AAeD,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,+BAAf,eAAe,QAS1B;AA2ID,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,2CAAuB,CAAA;IACvB,iDAA6B,CAAA;AAC/B,CAAC,EAJW,gBAAgB,gCAAhB,gBAAgB,QAI3B;AAwDD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AAsJD;;;;;;;;;;;;;;;;;;GAkBG;AACI,KAAK,UAAU,cAAc;IAGlC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GACX,8CAA8C,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAEzE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAlCD,wCAkCC"}
1
+ {"version":3,"file":"devcenter-app-instance-v1-app-instance-app-instances.universal.js","sourceRoot":"","sources":["../../../../src/devcenter-app-instance-v1-app-instance-app-instances.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,+IAAiI;AAgGjI,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,4BAAZ,YAAY,QASvB;AAeD,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,+BAAf,eAAe,QAS1B;AA4ID,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,2CAAuB,CAAA;IACvB,iDAA6B,CAAA;AAC/B,CAAC,EAJW,gBAAgB,gCAAhB,gBAAgB,QAI3B;AA4FD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AAsKD;;;;;;;;;;;;;;;;;;GAkBG;AACI,KAAK,UAAU,cAAc;IAGlC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GACX,8CAA8C,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAEzE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAlCD,wCAkCC"}
@@ -213,6 +213,7 @@ export interface SiteInfo {
213
213
  installedWixApps?: string[];
214
214
  /**
215
215
  * > **Deprecation Notice:** This parameter will be removed on June 30, 2022. Use `ownerInfo` instead.
216
+ * @format EMAIL
216
217
  * @deprecated
217
218
  */
218
219
  ownerEmail?: string | null;
@@ -254,7 +255,10 @@ export declare enum ResolutionMethod {
254
255
  SUBDIRECTORY = "SUBDIRECTORY"
255
256
  }
256
257
  export interface OwnerInfo {
257
- /** Wix user's email address. Identical to the their login email. */
258
+ /**
259
+ * Wix user's email address. Identical to the their login email.
260
+ * @format EMAIL
261
+ */
258
262
  email?: string;
259
263
  /**
260
264
  * Supported values: `VERIFIED_OPT_IN`, `VERIFIED_OPT_OUT`,
@@ -266,13 +270,22 @@ export interface OwnerInfo {
266
270
  emailStatus?: string;
267
271
  }
268
272
  export interface GetAppInstanceByInstanceIdRequest {
269
- /** ID of the app instance to retrieve. */
273
+ /**
274
+ * ID of the app instance to retrieve.
275
+ * @format GUID
276
+ */
270
277
  instanceId?: string;
271
278
  }
272
279
  export interface MessageEnvelope {
273
- /** App instance ID. */
280
+ /**
281
+ * App instance ID.
282
+ * @format GUID
283
+ */
274
284
  instanceId?: string | null;
275
- /** Event type. */
285
+ /**
286
+ * Event type.
287
+ * @maxLength 150
288
+ */
276
289
  eventType?: string;
277
290
  /** The identification type and identity data. */
278
291
  identity?: IdentificationData;
@@ -280,26 +293,50 @@ export interface MessageEnvelope {
280
293
  data?: string;
281
294
  }
282
295
  export interface IdentificationData extends IdentificationDataIdOneOf {
283
- /** ID of a site visitor that has not logged in to the site. */
296
+ /**
297
+ * ID of a site visitor that has not logged in to the site.
298
+ * @format GUID
299
+ */
284
300
  anonymousVisitorId?: string;
285
- /** ID of a site visitor that has logged in to the site. */
301
+ /**
302
+ * ID of a site visitor that has logged in to the site.
303
+ * @format GUID
304
+ */
286
305
  memberId?: string;
287
- /** ID of a Wix user (site owner, contributor, etc.). */
306
+ /**
307
+ * ID of a Wix user (site owner, contributor, etc.).
308
+ * @format GUID
309
+ */
288
310
  wixUserId?: string;
289
- /** ID of an app. */
311
+ /**
312
+ * ID of an app.
313
+ * @format GUID
314
+ */
290
315
  appId?: string;
291
316
  /** @readonly */
292
317
  identityType?: WebhookIdentityType;
293
318
  }
294
319
  /** @oneof */
295
320
  export interface IdentificationDataIdOneOf {
296
- /** ID of a site visitor that has not logged in to the site. */
321
+ /**
322
+ * ID of a site visitor that has not logged in to the site.
323
+ * @format GUID
324
+ */
297
325
  anonymousVisitorId?: string;
298
- /** ID of a site visitor that has logged in to the site. */
326
+ /**
327
+ * ID of a site visitor that has logged in to the site.
328
+ * @format GUID
329
+ */
299
330
  memberId?: string;
300
- /** ID of a Wix user (site owner, contributor, etc.). */
331
+ /**
332
+ * ID of a Wix user (site owner, contributor, etc.).
333
+ * @format GUID
334
+ */
301
335
  wixUserId?: string;
302
- /** ID of an app. */
336
+ /**
337
+ * ID of an app.
338
+ * @format GUID
339
+ */
303
340
  appId?: string;
304
341
  }
305
342
  export declare enum WebhookIdentityType {
@@ -1 +1 @@
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"}
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;AA4ID,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,2CAAuB,CAAA;IACvB,iDAA6B,CAAA;AAC/B,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B;AA4FD,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"}
@@ -213,6 +213,7 @@ export interface SiteInfo {
213
213
  installedWixApps?: string[];
214
214
  /**
215
215
  * > **Deprecation Notice:** This parameter will be removed on June 30, 2022. Use `ownerInfo` instead.
216
+ * @format EMAIL
216
217
  * @deprecated
217
218
  */
218
219
  ownerEmail?: string | null;
@@ -254,7 +255,10 @@ export declare enum ResolutionMethod {
254
255
  SUBDIRECTORY = "SUBDIRECTORY"
255
256
  }
256
257
  export interface OwnerInfo {
257
- /** Wix user's email address. Identical to the their login email. */
258
+ /**
259
+ * Wix user's email address. Identical to the their login email.
260
+ * @format EMAIL
261
+ */
258
262
  email?: string;
259
263
  /**
260
264
  * Supported values: `VERIFIED_OPT_IN`, `VERIFIED_OPT_OUT`,
@@ -266,13 +270,22 @@ export interface OwnerInfo {
266
270
  emailStatus?: string;
267
271
  }
268
272
  export interface GetAppInstanceByInstanceIdRequest {
269
- /** ID of the app instance to retrieve. */
273
+ /**
274
+ * ID of the app instance to retrieve.
275
+ * @format GUID
276
+ */
270
277
  instanceId?: string;
271
278
  }
272
279
  export interface MessageEnvelope {
273
- /** App instance ID. */
280
+ /**
281
+ * App instance ID.
282
+ * @format GUID
283
+ */
274
284
  instanceId?: string | null;
275
- /** Event type. */
285
+ /**
286
+ * Event type.
287
+ * @maxLength 150
288
+ */
276
289
  eventType?: string;
277
290
  /** The identification type and identity data. */
278
291
  identity?: IdentificationData;
@@ -280,26 +293,50 @@ export interface MessageEnvelope {
280
293
  data?: string;
281
294
  }
282
295
  export interface IdentificationData extends IdentificationDataIdOneOf {
283
- /** ID of a site visitor that has not logged in to the site. */
296
+ /**
297
+ * ID of a site visitor that has not logged in to the site.
298
+ * @format GUID
299
+ */
284
300
  anonymousVisitorId?: string;
285
- /** ID of a site visitor that has logged in to the site. */
301
+ /**
302
+ * ID of a site visitor that has logged in to the site.
303
+ * @format GUID
304
+ */
286
305
  memberId?: string;
287
- /** ID of a Wix user (site owner, contributor, etc.). */
306
+ /**
307
+ * ID of a Wix user (site owner, contributor, etc.).
308
+ * @format GUID
309
+ */
288
310
  wixUserId?: string;
289
- /** ID of an app. */
311
+ /**
312
+ * ID of an app.
313
+ * @format GUID
314
+ */
290
315
  appId?: string;
291
316
  /** @readonly */
292
317
  identityType?: WebhookIdentityType;
293
318
  }
294
319
  /** @oneof */
295
320
  export interface IdentificationDataIdOneOf {
296
- /** ID of a site visitor that has not logged in to the site. */
321
+ /**
322
+ * ID of a site visitor that has not logged in to the site.
323
+ * @format GUID
324
+ */
297
325
  anonymousVisitorId?: string;
298
- /** ID of a site visitor that has logged in to the site. */
326
+ /**
327
+ * ID of a site visitor that has logged in to the site.
328
+ * @format GUID
329
+ */
299
330
  memberId?: string;
300
- /** ID of a Wix user (site owner, contributor, etc.). */
331
+ /**
332
+ * ID of a Wix user (site owner, contributor, etc.).
333
+ * @format GUID
334
+ */
301
335
  wixUserId?: string;
302
- /** ID of an app. */
336
+ /**
337
+ * ID of an app.
338
+ * @format GUID
339
+ */
303
340
  appId?: string;
304
341
  }
305
342
  export declare enum WebhookIdentityType {
@@ -365,9 +402,15 @@ export interface GetAppInstanceResponseNonNullableFields {
365
402
  site?: SiteInfoNonNullableFields;
366
403
  }
367
404
  export interface BaseEventMetadata {
368
- /** App instance ID. */
405
+ /**
406
+ * App instance ID.
407
+ * @format GUID
408
+ */
369
409
  instanceId?: string | null;
370
- /** Event type. */
410
+ /**
411
+ * Event type.
412
+ * @maxLength 150
413
+ */
371
414
  eventType?: string;
372
415
  /** The identification type and identity data. */
373
416
  identity?: IdentificationData;
@@ -380,6 +423,8 @@ export interface AppInstanceInstalledEnvelope {
380
423
  * Triggered when an instance of your app is installed on a Wix site.
381
424
  * @webhook
382
425
  * @eventType AppInstalled
426
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
427
+ * @slug installed
383
428
  */
384
429
  export declare function onAppInstanceInstalled(handler: (event: AppInstanceInstalledEnvelope) => void | Promise<void>): void;
385
430
  export interface AppInstanceRemovedEnvelope {
@@ -390,6 +435,8 @@ export interface AppInstanceRemovedEnvelope {
390
435
  * Triggered when an instance of your app is uninstalled from a Wix site.
391
436
  * @webhook
392
437
  * @eventType AppRemoved
438
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
439
+ * @slug removed
393
440
  */
394
441
  export declare function onAppInstanceRemoved(handler: (event: AppInstanceRemovedEnvelope) => void | Promise<void>): void;
395
442
  export interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
@@ -402,6 +449,8 @@ export interface AppInstancePaidPlanAutoRenewalCancelledEnvelope {
402
449
  * cycle.
403
450
  * @webhook
404
451
  * @eventType PaidPlanAutoRenewalCancelled
452
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
453
+ * @slug paid_plan_auto_renewal_cancelled
405
454
  */
406
455
  export declare function onAppInstancePaidPlanAutoRenewalCancelled(handler: (event: AppInstancePaidPlanAutoRenewalCancelledEnvelope) => void | Promise<void>): void;
407
456
  export interface AppInstancePaidPlanChangedEnvelope {
@@ -412,6 +461,8 @@ export interface AppInstancePaidPlanChangedEnvelope {
412
461
  * Triggered when a Wix user upgrades or downgrades their plan for your app.
413
462
  * @webhook
414
463
  * @eventType PaidPlanChanged
464
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
465
+ * @slug paid_plan_changed
415
466
  */
416
467
  export declare function onAppInstancePaidPlanChanged(handler: (event: AppInstancePaidPlanChangedEnvelope) => void | Promise<void>): void;
417
468
  export interface AppInstancePaidPlanPurchasedEnvelope {
@@ -422,6 +473,8 @@ export interface AppInstancePaidPlanPurchasedEnvelope {
422
473
  * Triggered when a Wix user purchases a paid plan for your app.
423
474
  * @webhook
424
475
  * @eventType PaidPlanPurchased
476
+ * @serviceIdentifier com.wixpress.market.aim.api.AppInstanceService
477
+ * @slug paid_plan_purchased
425
478
  */
426
479
  export declare function onAppInstancePaidPlanPurchased(handler: (event: AppInstancePaidPlanPurchasedEnvelope) => void | Promise<void>): void;
427
480
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"devcenter-app-instance-v1-app-instance-app-instances.universal.js","sourceRoot":"","sources":["../../../../src/devcenter-app-instance-v1-app-instance-app-instances.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,8CAA8C,MAAM,gEAAgE,CAAC;AAgGjI,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;AAsJD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc;IAGlC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GACX,8CAA8C,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAEzE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}
1
+ {"version":3,"file":"devcenter-app-instance-v1-app-instance-app-instances.universal.js","sourceRoot":"","sources":["../../../../src/devcenter-app-instance-v1-app-instance-app-instances.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,8CAA8C,MAAM,gEAAgE,CAAC;AAgGjI,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;AA4ID,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,2CAAuB,CAAA;IACvB,iDAA6B,CAAA;AAC/B,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B;AA4FD,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;AAsKD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc;IAGlC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GACX,8CAA8C,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAEzE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/auto_sdk_app-management_app-instances",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -48,5 +48,5 @@
48
48
  "fqdn": "wix.devcenter.app_instance.v1.app_instance"
49
49
  }
50
50
  },
51
- "falconPackageHash": "82efb6dd3da1867a37f10931e42e4b501b81d90a28365ee394cc1330"
51
+ "falconPackageHash": "0eb644c7cb2a22d96f5a76826cee82f665472f3c1495eacdce046db3"
52
52
  }