@wix/auto_sdk_portfolio_synced-project 1.0.0 → 1.0.1

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/portfolio-syncedprojects-v1-synced-project-synced-project.types.d.ts +166 -40
  2. package/build/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.types.js.map +1 -1
  3. package/build/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.universal.d.ts +166 -40
  4. package/build/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.universal.js.map +1 -1
  5. package/build/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.types.d.ts +166 -40
  6. package/build/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.types.js.map +1 -1
  7. package/build/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.universal.d.ts +166 -40
  8. package/build/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.universal.js.map +1 -1
  9. package/build/internal/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.types.d.ts +166 -40
  10. package/build/internal/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.types.js.map +1 -1
  11. package/build/internal/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.universal.d.ts +166 -40
  12. package/build/internal/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.universal.js.map +1 -1
  13. package/build/internal/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.types.d.ts +166 -40
  14. package/build/internal/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.types.js.map +1 -1
  15. package/build/internal/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.universal.d.ts +166 -40
  16. package/build/internal/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.universal.js.map +1 -1
  17. package/package.json +2 -2
@@ -1,15 +1,30 @@
1
1
  export interface SyncedProject {
2
- /** Project ID in Portfolio - if project was yet to be create, will be None */
2
+ /**
3
+ * Project ID in Portfolio - if project was yet to be create, will be None
4
+ * @format GUID
5
+ */
3
6
  portfolioProjectId?: string | null;
4
- /** External Project ID */
7
+ /**
8
+ * External Project ID
9
+ * @maxLength 50
10
+ */
5
11
  externalId?: string;
6
- /** Project name */
12
+ /**
13
+ * Project name
14
+ * @maxLength 100
15
+ */
7
16
  title?: string | null;
8
17
  /** Project media count */
9
18
  mediaCount?: number;
10
- /** Project image url */
19
+ /**
20
+ * Project image url
21
+ * @format WEB_URL
22
+ */
11
23
  coverImage?: string | null;
12
- /** Project url in external */
24
+ /**
25
+ * Project url in external
26
+ * @format WEB_URL
27
+ */
13
28
  link?: string | null;
14
29
  /**
15
30
  * Represents the last time project was synced - returned only if external project is synced
@@ -54,19 +69,26 @@ export interface SyncProjectPagingEvent {
54
69
  projectSyncRevision?: Date | null;
55
70
  }
56
71
  export interface SyncSiteEvent {
57
- /** Portfolio instance id */
72
+ /**
73
+ * Portfolio instance id
74
+ * @format GUID
75
+ */
58
76
  instanceId?: string;
59
77
  /** Paging */
60
78
  paging?: CursorPaging;
61
79
  }
62
80
  export interface CursorPaging {
63
- /** Maximum number of items to return in the results. */
81
+ /**
82
+ * Maximum number of items to return in the results.
83
+ * @max 100
84
+ */
64
85
  limit?: number | null;
65
86
  /**
66
87
  * Pointer to the next or previous page in the list of results.
67
88
  *
68
89
  * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
69
90
  * Not relevant for the first request.
91
+ * @maxLength 16000
70
92
  */
71
93
  cursor?: string | null;
72
94
  }
@@ -101,9 +123,15 @@ export interface PagingMetadataV2 {
101
123
  cursors?: Cursors;
102
124
  }
103
125
  export interface Cursors {
104
- /** Cursor string pointing to the next page in the list of results. */
126
+ /**
127
+ * Cursor string pointing to the next page in the list of results.
128
+ * @maxLength 16000
129
+ */
105
130
  next?: string | null;
106
- /** Cursor pointing to the previous page in the list of results. */
131
+ /**
132
+ * Cursor pointing to the previous page in the list of results.
133
+ * @maxLength 16000
134
+ */
107
135
  prev?: string | null;
108
136
  }
109
137
  export interface SyncProjectResponse {
@@ -233,6 +261,7 @@ export interface ItemCreatedMediaCallbackRequest {
233
261
  width?: number | null;
234
262
  height?: number | null;
235
263
  fileOutput?: MediaFileOutput;
264
+ /** @format GUID */
236
265
  siteId?: string | null;
237
266
  }
238
267
  export interface MediaFileOutput {
@@ -270,6 +299,7 @@ export interface ProjectCoverImageCreatedMediaCallbackRequest {
270
299
  width?: number | null;
271
300
  height?: number | null;
272
301
  fileOutput?: MediaFileOutput;
302
+ /** @format GUID */
273
303
  siteId?: string | null;
274
304
  }
275
305
  export interface ProjectCoverImageCreatedMediaCallbackResponse {
@@ -305,7 +335,10 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
305
335
  studioAssigned?: StudioAssigned;
306
336
  /** Emitted when Studio is detached. */
307
337
  studioUnassigned?: StudioUnassigned;
308
- /** A meta site id. */
338
+ /**
339
+ * A meta site id.
340
+ * @format GUID
341
+ */
309
342
  metaSiteId?: string;
310
343
  /** A meta site version. Monotonically increasing. */
311
344
  version?: string;
@@ -314,6 +347,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
314
347
  /**
315
348
  * TODO(meta-site): Change validation once validations are disabled for consumers
316
349
  * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
350
+ * @maxSize 4000
317
351
  */
318
352
  assets?: Asset[];
319
353
  }
@@ -351,9 +385,15 @@ export interface MetaSiteSpecialEventPayloadOneOf {
351
385
  studioUnassigned?: StudioUnassigned;
352
386
  }
353
387
  export interface Asset {
354
- /** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */
388
+ /**
389
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
390
+ * @maxLength 36
391
+ */
355
392
  appDefId?: string;
356
- /** An instance id. For legacy reasons may be UUID or a string. */
393
+ /**
394
+ * An instance id. For legacy reasons may be UUID or a string.
395
+ * @maxLength 200
396
+ */
357
397
  instanceId?: string;
358
398
  /** An application state. */
359
399
  state?: State;
@@ -366,9 +406,15 @@ export declare enum State {
366
406
  DEMO = "DEMO"
367
407
  }
368
408
  export interface SiteCreated {
369
- /** A template identifier (empty if not created from a template). */
409
+ /**
410
+ * A template identifier (empty if not created from a template).
411
+ * @maxLength 36
412
+ */
370
413
  originTemplateId?: string;
371
- /** An account id of the owner. */
414
+ /**
415
+ * An account id of the owner.
416
+ * @format GUID
417
+ */
372
418
  ownerId?: string;
373
419
  /** A context in which meta site was created. */
374
420
  context?: SiteCreatedContext;
@@ -377,9 +423,13 @@ export interface SiteCreated {
377
423
  *
378
424
  * In case of a creation from a template it's a template id.
379
425
  * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
426
+ * @format GUID
380
427
  */
381
428
  originMetaSiteId?: string | null;
382
- /** A meta site name (URL slug). */
429
+ /**
430
+ * A meta site name (URL slug).
431
+ * @maxLength 20
432
+ */
383
433
  siteName?: string;
384
434
  /** A namespace. */
385
435
  namespace?: Namespace;
@@ -476,9 +526,15 @@ export declare enum Namespace {
476
526
  }
477
527
  /** Site transferred to another user. */
478
528
  export interface SiteTransferred {
479
- /** A previous owner id (user that transfers meta site). */
529
+ /**
530
+ * A previous owner id (user that transfers meta site).
531
+ * @format GUID
532
+ */
480
533
  oldOwnerId?: string;
481
- /** A new owner id (user that accepts meta site). */
534
+ /**
535
+ * A new owner id (user that accepts meta site).
536
+ * @format GUID
537
+ */
482
538
  newOwnerId?: string;
483
539
  }
484
540
  /** Soft deletion of the meta site. Could be restored. */
@@ -491,9 +547,15 @@ export interface DeleteContext {
491
547
  dateDeleted?: Date | null;
492
548
  /** A status. */
493
549
  deleteStatus?: DeleteStatus;
494
- /** A reason (flow). */
550
+ /**
551
+ * A reason (flow).
552
+ * @maxLength 255
553
+ */
495
554
  deleteOrigin?: string;
496
- /** A service that deleted it. */
555
+ /**
556
+ * A service that deleted it.
557
+ * @maxLength 255
558
+ */
497
559
  initiatorId?: string | null;
498
560
  }
499
561
  export declare enum DeleteStatus {
@@ -509,7 +571,11 @@ export interface SiteUndeleted {
509
571
  export interface SitePublished {
510
572
  }
511
573
  export interface SiteUnpublished {
512
- /** A list of URLs previously associated with the meta site. */
574
+ /**
575
+ * A list of URLs previously associated with the meta site.
576
+ * @maxLength 4000
577
+ * @maxSize 10000
578
+ */
513
579
  urls?: string[];
514
580
  }
515
581
  export interface SiteMarkedAsTemplate {
@@ -532,30 +598,60 @@ export interface SiteMarkedAsWixSite {
532
598
  * To ensure this, the TPA on the template gets a new instance_id.
533
599
  */
534
600
  export interface ServiceProvisioned {
535
- /** Either UUID or EmbeddedServiceType. */
601
+ /**
602
+ * Either UUID or EmbeddedServiceType.
603
+ * @maxLength 36
604
+ */
536
605
  appDefId?: string;
537
- /** Not only UUID. Something here could be something weird. */
606
+ /**
607
+ * Not only UUID. Something here could be something weird.
608
+ * @maxLength 36
609
+ */
538
610
  instanceId?: string;
539
- /** An instance id from which this instance is originated. */
611
+ /**
612
+ * An instance id from which this instance is originated.
613
+ * @maxLength 36
614
+ */
540
615
  originInstanceId?: string;
541
- /** A version. */
616
+ /**
617
+ * A version.
618
+ * @maxLength 500
619
+ */
542
620
  version?: string | null;
543
- /** The origin meta site id */
621
+ /**
622
+ * The origin meta site id
623
+ * @format GUID
624
+ */
544
625
  originMetaSiteId?: string | null;
545
626
  }
546
627
  export interface ServiceRemoved {
547
- /** Either UUID or EmbeddedServiceType. */
628
+ /**
629
+ * Either UUID or EmbeddedServiceType.
630
+ * @maxLength 36
631
+ */
548
632
  appDefId?: string;
549
- /** Not only UUID. Something here could be something weird. */
633
+ /**
634
+ * Not only UUID. Something here could be something weird.
635
+ * @maxLength 36
636
+ */
550
637
  instanceId?: string;
551
- /** A version. */
638
+ /**
639
+ * A version.
640
+ * @maxLength 500
641
+ */
552
642
  version?: string | null;
553
643
  }
554
644
  /** Rename of the site. Meaning, free public url has been changed as well. */
555
645
  export interface SiteRenamed {
556
- /** A new meta site name (URL slug). */
646
+ /**
647
+ * A new meta site name (URL slug).
648
+ * @maxLength 20
649
+ */
557
650
  newSiteName?: string;
558
- /** A previous meta site name (URL slug). */
651
+ /**
652
+ * A previous meta site name (URL slug).
653
+ * @maxLength 255
654
+ */
559
655
  oldSiteName?: string;
560
656
  }
561
657
  /**
@@ -584,9 +680,15 @@ export interface SyncAllSitesEvent {
584
680
  paging?: CursorPaging;
585
681
  }
586
682
  export interface MessageEnvelope {
587
- /** App instance ID. */
683
+ /**
684
+ * App instance ID.
685
+ * @format GUID
686
+ */
588
687
  instanceId?: string | null;
589
- /** Event type. */
688
+ /**
689
+ * Event type.
690
+ * @maxLength 150
691
+ */
590
692
  eventType?: string;
591
693
  /** The identification type and identity data. */
592
694
  identity?: IdentificationData;
@@ -594,26 +696,50 @@ export interface MessageEnvelope {
594
696
  data?: string;
595
697
  }
596
698
  export interface IdentificationData extends IdentificationDataIdOneOf {
597
- /** ID of a site visitor that has not logged in to the site. */
699
+ /**
700
+ * ID of a site visitor that has not logged in to the site.
701
+ * @format GUID
702
+ */
598
703
  anonymousVisitorId?: string;
599
- /** ID of a site visitor that has logged in to the site. */
704
+ /**
705
+ * ID of a site visitor that has logged in to the site.
706
+ * @format GUID
707
+ */
600
708
  memberId?: string;
601
- /** ID of a Wix user (site owner, contributor, etc.). */
709
+ /**
710
+ * ID of a Wix user (site owner, contributor, etc.).
711
+ * @format GUID
712
+ */
602
713
  wixUserId?: string;
603
- /** ID of an app. */
714
+ /**
715
+ * ID of an app.
716
+ * @format GUID
717
+ */
604
718
  appId?: string;
605
719
  /** @readonly */
606
720
  identityType?: WebhookIdentityType;
607
721
  }
608
722
  /** @oneof */
609
723
  export interface IdentificationDataIdOneOf {
610
- /** ID of a site visitor that has not logged in to the site. */
724
+ /**
725
+ * ID of a site visitor that has not logged in to the site.
726
+ * @format GUID
727
+ */
611
728
  anonymousVisitorId?: string;
612
- /** ID of a site visitor that has logged in to the site. */
729
+ /**
730
+ * ID of a site visitor that has logged in to the site.
731
+ * @format GUID
732
+ */
613
733
  memberId?: string;
614
- /** ID of a Wix user (site owner, contributor, etc.). */
734
+ /**
735
+ * ID of a Wix user (site owner, contributor, etc.).
736
+ * @format GUID
737
+ */
615
738
  wixUserId?: string;
616
- /** ID of an app. */
739
+ /**
740
+ * ID of an app.
741
+ * @format GUID
742
+ */
617
743
  appId?: string;
618
744
  }
619
745
  export declare enum WebhookIdentityType {
@@ -1 +1 @@
1
- {"version":3,"file":"portfolio-syncedprojects-v1-synced-project-synced-project.types.js","sourceRoot":"","sources":["../../../src/portfolio-syncedprojects-v1-synced-project-synced-project.types.ts"],"names":[],"mappings":";;;AAsBA,IAAY,UASX;AATD,WAAY,UAAU;IACpB,6BAA6B;IAC7B,uCAAyB,CAAA;IACzB,kCAAkC;IAClC,iCAAmB,CAAA;IACnB,kCAAkC;IAClC,iCAAmB,CAAA;IACnB,yBAAyB;IACzB,+BAAiB,CAAA;AACnB,CAAC,EATW,UAAU,0BAAV,UAAU,QASrB;AA0WD,IAAY,KAMX;AAND,WAAY,KAAK;IACf,4BAAmB,CAAA;IACnB,4BAAmB,CAAA;IACnB,8BAAqB,CAAA;IACrB,4BAAmB,CAAA;IACnB,sBAAa,CAAA;AACf,CAAC,EANW,KAAK,qBAAL,KAAK,QAMhB;AAsBD,IAAY,kBAaX;AAbD,WAAY,kBAAkB;IAC5B,6EAA6E;IAC7E,qCAAe,CAAA;IACf,6CAA6C;IAC7C,qDAA+B,CAAA;IAC/B,wEAAwE;IACxE,+EAAyD,CAAA;IACzD,oCAAoC;IACpC,6CAAuB,CAAA;IACvB,wGAAwG;IACxG,6DAAuC,CAAA;IACvC,2DAA2D;IAC3D,qCAAe,CAAA;AACjB,CAAC,EAbW,kBAAkB,kCAAlB,kBAAkB,QAa7B;AAED,IAAY,SA2EX;AA3ED,WAAY,SAAS;IACnB,oDAAuC,CAAA;IACvC,qHAAqH;IACrH,wBAAW,CAAA;IACX,6KAA6K;IAC7K,oCAAuB,CAAA;IACvB,0KAA0K;IAC1K,8BAAiB,CAAA;IACjB,6RAA6R;IAC7R,4DAA+C,CAAA;IAC/C,wHAAwH;IACxH,8BAAiB,CAAA;IACjB,kJAAkJ;IAClJ,4BAAe,CAAA;IACf,2HAA2H;IAC3H,kDAAqC,CAAA;IACrC,iIAAiI;IACjI,kCAAqB,CAAA;IACrB,sJAAsJ;IACtJ,4BAAe,CAAA;IACf,wJAAwJ;IACxJ,wCAA2B,CAAA;IAC3B,0FAA0F;IAC1F,oDAAuC,CAAA;IACvC,0FAA0F;IAC1F,sDAAyC,CAAA;IACzC;;;;OAIG;IACH,sCAAyB,CAAA;IACzB;;;;OAIG;IACH,oDAAuC,CAAA;IACvC,oGAAoG;IACpG,gDAAmC,CAAA;IACnC,sDAAsD;IACtD,gDAAmC,CAAA;IACnC,2CAA2C;IAC3C,kCAAqB,CAAA;IACrB,uDAAuD;IACvD,kCAAqB,CAAA;IACrB;;;OAGG;IACH,sDAAyC,CAAA;IACzC,2EAA2E;IAC3E,0BAAa,CAAA;IACb;;;;OAIG;IACH,4CAA+B,CAAA;IAC/B,0EAA0E;IAC1E,8BAAiB,CAAA;IACjB;;;OAGG;IACH,0CAA6B,CAAA;IAC7B,2BAA2B;IAC3B,4BAAe,CAAA;IACf,gCAAgC;IAChC,0DAA6C,CAAA;IAC7C;;;OAGG;IACH,8DAAiD,CAAA;AACnD,CAAC,EA3EW,SAAS,yBAAT,SAAS,QA2EpB;AA2BD,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,+BAAe,CAAA;IACf,mCAAmB,CAAA;IACnB,+CAA+B,CAAA;AACjC,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AA8HD,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":"portfolio-syncedprojects-v1-synced-project-synced-project.types.js","sourceRoot":"","sources":["../../../src/portfolio-syncedprojects-v1-synced-project-synced-project.types.ts"],"names":[],"mappings":";;;AAqCA,IAAY,UASX;AATD,WAAY,UAAU;IACpB,6BAA6B;IAC7B,uCAAyB,CAAA;IACzB,kCAAkC;IAClC,iCAAmB,CAAA;IACnB,kCAAkC;IAClC,iCAAmB,CAAA;IACnB,yBAAyB;IACzB,+BAAiB,CAAA;AACnB,CAAC,EATW,UAAU,0BAAV,UAAU,QASrB;AAmYD,IAAY,KAMX;AAND,WAAY,KAAK;IACf,4BAAmB,CAAA;IACnB,4BAAmB,CAAA;IACnB,8BAAqB,CAAA;IACrB,4BAAmB,CAAA;IACnB,sBAAa,CAAA;AACf,CAAC,EANW,KAAK,qBAAL,KAAK,QAMhB;AAgCD,IAAY,kBAaX;AAbD,WAAY,kBAAkB;IAC5B,6EAA6E;IAC7E,qCAAe,CAAA;IACf,6CAA6C;IAC7C,qDAA+B,CAAA;IAC/B,wEAAwE;IACxE,+EAAyD,CAAA;IACzD,oCAAoC;IACpC,6CAAuB,CAAA;IACvB,wGAAwG;IACxG,6DAAuC,CAAA;IACvC,2DAA2D;IAC3D,qCAAe,CAAA;AACjB,CAAC,EAbW,kBAAkB,kCAAlB,kBAAkB,QAa7B;AAED,IAAY,SA2EX;AA3ED,WAAY,SAAS;IACnB,oDAAuC,CAAA;IACvC,qHAAqH;IACrH,wBAAW,CAAA;IACX,6KAA6K;IAC7K,oCAAuB,CAAA;IACvB,0KAA0K;IAC1K,8BAAiB,CAAA;IACjB,6RAA6R;IAC7R,4DAA+C,CAAA;IAC/C,wHAAwH;IACxH,8BAAiB,CAAA;IACjB,kJAAkJ;IAClJ,4BAAe,CAAA;IACf,2HAA2H;IAC3H,kDAAqC,CAAA;IACrC,iIAAiI;IACjI,kCAAqB,CAAA;IACrB,sJAAsJ;IACtJ,4BAAe,CAAA;IACf,wJAAwJ;IACxJ,wCAA2B,CAAA;IAC3B,0FAA0F;IAC1F,oDAAuC,CAAA;IACvC,0FAA0F;IAC1F,sDAAyC,CAAA;IACzC;;;;OAIG;IACH,sCAAyB,CAAA;IACzB;;;;OAIG;IACH,oDAAuC,CAAA;IACvC,oGAAoG;IACpG,gDAAmC,CAAA;IACnC,sDAAsD;IACtD,gDAAmC,CAAA;IACnC,2CAA2C;IAC3C,kCAAqB,CAAA;IACrB,uDAAuD;IACvD,kCAAqB,CAAA;IACrB;;;OAGG;IACH,sDAAyC,CAAA;IACzC,2EAA2E;IAC3E,0BAAa,CAAA;IACb;;;;OAIG;IACH,4CAA+B,CAAA;IAC/B,0EAA0E;IAC1E,8BAAiB,CAAA;IACjB;;;OAGG;IACH,0CAA6B,CAAA;IAC7B,2BAA2B;IAC3B,4BAAe,CAAA;IACf,gCAAgC;IAChC,0DAA6C,CAAA;IAC7C;;;OAGG;IACH,8DAAiD,CAAA;AACnD,CAAC,EA3EW,SAAS,yBAAT,SAAS,QA2EpB;AAuCD,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,+BAAe,CAAA;IACf,mCAAmB,CAAA;IACnB,+CAA+B,CAAA;AACjC,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AA8LD,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"}