@wix/portfolio 1.0.9 → 1.0.11

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 (97) hide show
  1. package/build/cjs/index.d.ts +2 -1
  2. package/build/cjs/index.js +3 -2
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/src/portfolio-collections-v1-collection.http.js +26 -26
  5. package/build/cjs/src/portfolio-collections-v1-collection.http.js.map +1 -1
  6. package/build/cjs/src/portfolio-collections-v1-collection.public.d.ts +4 -4
  7. package/build/cjs/src/portfolio-collections-v1-collection.public.js +2 -2
  8. package/build/cjs/src/portfolio-collections-v1-collection.public.js.map +1 -1
  9. package/build/cjs/src/portfolio-collections-v1-collection.types.d.ts +27 -33
  10. package/build/cjs/src/portfolio-collections-v1-collection.types.js +7 -7
  11. package/build/cjs/src/portfolio-collections-v1-collection.types.js.map +1 -1
  12. package/build/cjs/src/portfolio-collections-v1-collection.universal.d.ts +50 -38
  13. package/build/cjs/src/portfolio-collections-v1-collection.universal.js +65 -35
  14. package/build/cjs/src/portfolio-collections-v1-collection.universal.js.map +1 -1
  15. package/build/cjs/src/portfolio-project-items-v1-project-item.http.js +21 -9
  16. package/build/cjs/src/portfolio-project-items-v1-project-item.http.js.map +1 -1
  17. package/build/cjs/src/portfolio-project-items-v1-project-item.public.d.ts +8 -8
  18. package/build/cjs/src/portfolio-project-items-v1-project-item.public.js +4 -4
  19. package/build/cjs/src/portfolio-project-items-v1-project-item.public.js.map +1 -1
  20. package/build/cjs/src/portfolio-project-items-v1-project-item.types.d.ts +28 -34
  21. package/build/cjs/src/portfolio-project-items-v1-project-item.types.js.map +1 -1
  22. package/build/cjs/src/portfolio-project-items-v1-project-item.universal.d.ts +57 -74
  23. package/build/cjs/src/portfolio-project-items-v1-project-item.universal.js +112 -70
  24. package/build/cjs/src/portfolio-project-items-v1-project-item.universal.js.map +1 -1
  25. package/build/cjs/src/portfolio-projects-v1-project-in-collection.http.d.ts +14 -0
  26. package/build/cjs/src/portfolio-projects-v1-project-in-collection.http.js +181 -0
  27. package/build/cjs/src/portfolio-projects-v1-project-in-collection.http.js.map +1 -0
  28. package/build/cjs/src/portfolio-projects-v1-project-in-collection.public.d.ts +6 -0
  29. package/build/cjs/src/portfolio-projects-v1-project-in-collection.public.js +22 -0
  30. package/build/cjs/src/portfolio-projects-v1-project-in-collection.public.js.map +1 -0
  31. package/build/cjs/src/portfolio-projects-v1-project-in-collection.types.d.ts +338 -0
  32. package/build/cjs/src/portfolio-projects-v1-project-in-collection.types.js +28 -0
  33. package/build/cjs/src/portfolio-projects-v1-project-in-collection.types.js.map +1 -0
  34. package/build/cjs/src/portfolio-projects-v1-project-in-collection.universal.d.ts +397 -0
  35. package/build/cjs/src/portfolio-projects-v1-project-in-collection.universal.js +214 -0
  36. package/build/cjs/src/portfolio-projects-v1-project-in-collection.universal.js.map +1 -0
  37. package/build/cjs/src/portfolio-projects-v1-project.http.d.ts +1 -13
  38. package/build/cjs/src/portfolio-projects-v1-project.http.js +57 -121
  39. package/build/cjs/src/portfolio-projects-v1-project.http.js.map +1 -1
  40. package/build/cjs/src/portfolio-projects-v1-project.public.d.ts +8 -10
  41. package/build/cjs/src/portfolio-projects-v1-project.public.js +5 -17
  42. package/build/cjs/src/portfolio-projects-v1-project.public.js.map +1 -1
  43. package/build/cjs/src/portfolio-projects-v1-project.types.d.ts +188 -136
  44. package/build/cjs/src/portfolio-projects-v1-project.types.js +14 -17
  45. package/build/cjs/src/portfolio-projects-v1-project.types.js.map +1 -1
  46. package/build/cjs/src/portfolio-projects-v1-project.universal.d.ts +192 -218
  47. package/build/cjs/src/portfolio-projects-v1-project.universal.js +86 -179
  48. package/build/cjs/src/portfolio-projects-v1-project.universal.js.map +1 -1
  49. package/build/es/index.d.ts +2 -1
  50. package/build/es/index.js +2 -1
  51. package/build/es/index.js.map +1 -1
  52. package/build/es/src/portfolio-collections-v1-collection.http.js +26 -26
  53. package/build/es/src/portfolio-collections-v1-collection.http.js.map +1 -1
  54. package/build/es/src/portfolio-collections-v1-collection.public.d.ts +4 -4
  55. package/build/es/src/portfolio-collections-v1-collection.public.js +2 -2
  56. package/build/es/src/portfolio-collections-v1-collection.public.js.map +1 -1
  57. package/build/es/src/portfolio-collections-v1-collection.types.d.ts +27 -33
  58. package/build/es/src/portfolio-collections-v1-collection.types.js +6 -6
  59. package/build/es/src/portfolio-collections-v1-collection.types.js.map +1 -1
  60. package/build/es/src/portfolio-collections-v1-collection.universal.d.ts +50 -38
  61. package/build/es/src/portfolio-collections-v1-collection.universal.js +65 -35
  62. package/build/es/src/portfolio-collections-v1-collection.universal.js.map +1 -1
  63. package/build/es/src/portfolio-project-items-v1-project-item.http.js +21 -9
  64. package/build/es/src/portfolio-project-items-v1-project-item.http.js.map +1 -1
  65. package/build/es/src/portfolio-project-items-v1-project-item.public.d.ts +8 -8
  66. package/build/es/src/portfolio-project-items-v1-project-item.public.js +4 -4
  67. package/build/es/src/portfolio-project-items-v1-project-item.public.js.map +1 -1
  68. package/build/es/src/portfolio-project-items-v1-project-item.types.d.ts +28 -34
  69. package/build/es/src/portfolio-project-items-v1-project-item.types.js.map +1 -1
  70. package/build/es/src/portfolio-project-items-v1-project-item.universal.d.ts +57 -74
  71. package/build/es/src/portfolio-project-items-v1-project-item.universal.js +112 -70
  72. package/build/es/src/portfolio-project-items-v1-project-item.universal.js.map +1 -1
  73. package/build/es/src/portfolio-projects-v1-project-in-collection.http.d.ts +14 -0
  74. package/build/es/src/portfolio-projects-v1-project-in-collection.http.js +176 -0
  75. package/build/es/src/portfolio-projects-v1-project-in-collection.http.js.map +1 -0
  76. package/build/es/src/portfolio-projects-v1-project-in-collection.public.d.ts +6 -0
  77. package/build/es/src/portfolio-projects-v1-project-in-collection.public.js +13 -0
  78. package/build/es/src/portfolio-projects-v1-project-in-collection.public.js.map +1 -0
  79. package/build/es/src/portfolio-projects-v1-project-in-collection.types.d.ts +338 -0
  80. package/build/es/src/portfolio-projects-v1-project-in-collection.types.js +25 -0
  81. package/build/es/src/portfolio-projects-v1-project-in-collection.types.js.map +1 -0
  82. package/build/es/src/portfolio-projects-v1-project-in-collection.universal.d.ts +397 -0
  83. package/build/es/src/portfolio-projects-v1-project-in-collection.universal.js +190 -0
  84. package/build/es/src/portfolio-projects-v1-project-in-collection.universal.js.map +1 -0
  85. package/build/es/src/portfolio-projects-v1-project.http.d.ts +1 -13
  86. package/build/es/src/portfolio-projects-v1-project.http.js +56 -118
  87. package/build/es/src/portfolio-projects-v1-project.http.js.map +1 -1
  88. package/build/es/src/portfolio-projects-v1-project.public.d.ts +8 -10
  89. package/build/es/src/portfolio-projects-v1-project.public.js +5 -15
  90. package/build/es/src/portfolio-projects-v1-project.public.js.map +1 -1
  91. package/build/es/src/portfolio-projects-v1-project.types.d.ts +188 -136
  92. package/build/es/src/portfolio-projects-v1-project.types.js +13 -16
  93. package/build/es/src/portfolio-projects-v1-project.types.js.map +1 -1
  94. package/build/es/src/portfolio-projects-v1-project.universal.d.ts +192 -218
  95. package/build/es/src/portfolio-projects-v1-project.universal.js +85 -176
  96. package/build/es/src/portfolio-projects-v1-project.universal.js.map +1 -1
  97. package/package.json +2 -2
@@ -1,5 +1,5 @@
1
1
  /** Project is the main entity of ProjectsService */
2
- export interface Project {
2
+ export interface Project extends ProjectCoverOneOf {
3
3
  /**
4
4
  * Project ID
5
5
  * @readonly
@@ -7,14 +7,10 @@ export interface Project {
7
7
  id?: string | null;
8
8
  /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision */
9
9
  revision?: string | null;
10
- /** Project name */
11
10
  title?: string | null;
12
- /** Project description */
13
11
  description?: string | null;
14
12
  /** indicates if the project should be hidden from Portfolio */
15
13
  hidden?: boolean | null;
16
- /** project's cover photo */
17
- coverImage?: Image;
18
14
  /** Collections must exist to be added to a project. can be created/updated/deleted using this //TODO */
19
15
  collectionIds?: string[];
20
16
  /** Custom project details */
@@ -36,30 +32,35 @@ export interface Project {
36
32
  */
37
33
  url?: PageUrlV2;
38
34
  seoData?: SeoSchema;
39
- }
40
- export interface Image {
41
- /** Image info - Wix Media Image. Required. */
42
- imageInfo?: CommonImage;
43
- /** Focal point of the image. */
44
- focalPoint?: Point;
45
- /** Set of key-value pairs describing the media in [Exchangeable Image File format](https://en.wikipedia.org/wiki/Exif). */
46
- exif?: Record<string, any> | null;
47
35
  /**
48
- * Image compression level. <br />
49
- *
50
- * Min: `30` <br />
51
- * Max: `100`
36
+ * indicates if the project is synced from external platform (via integration page) and therefore will be updated from the external platform on daily basis
37
+ * @readonly
52
38
  */
53
- quality?: number | null;
54
- /** [Unsharp masking](https://en.wikipedia.org/wiki/Unsharp_masking) values of the image. */
55
- unsharpMasking?: UnsharpMasking;
39
+ syncedProject?: boolean | null;
40
+ /** project's cover photo */
41
+ coverImage?: CommonImage;
42
+ /** project's cover video */
43
+ coverVideo?: Video;
44
+ }
45
+ /** @oneof */
46
+ export interface ProjectCoverOneOf {
47
+ /** project's cover photo */
48
+ coverImage?: CommonImage;
49
+ /** project's cover video */
50
+ coverVideo?: Video;
51
+ }
52
+ export interface CommonImage {
53
+ /** Image info - Wix Media Image. */
54
+ imageInfo?: Image;
55
+ /** Focal point of the image. */
56
+ focalPoint?: CommonPoint;
56
57
  }
57
- export declare enum ImageType {
58
+ export declare enum ImageImageType {
58
59
  UNDEFINED = "UNDEFINED",
59
60
  WIX_MEDIA = "WIX_MEDIA",
60
61
  EXTERNAL = "EXTERNAL"
61
62
  }
62
- export interface CommonImage {
63
+ export interface Image {
63
64
  /** WixMedia image ID. Required. */
64
65
  id?: string;
65
66
  /**
@@ -76,13 +77,13 @@ export interface CommonImage {
76
77
  /** Image filename. */
77
78
  filename?: string | null;
78
79
  }
79
- export interface Point {
80
+ export interface CommonPoint {
80
81
  /** X-coordinate of the focal point. */
81
82
  x?: number;
82
83
  /** Y-coordinate of the focal point. */
83
84
  y?: number;
84
85
  }
85
- export interface UnsharpMasking {
86
+ export interface CommonUnsharpMasking {
86
87
  /**
87
88
  * Unsharp masking amount. Controls the sharpening strength. <br />
88
89
  *
@@ -100,35 +101,58 @@ export interface UnsharpMasking {
100
101
  */
101
102
  threshold?: number | null;
102
103
  }
104
+ export interface Video {
105
+ /** Video info - Wix Media Image. */
106
+ videoInfo?: VideoV2;
107
+ /** Manually defined Video duration in milliseconds. */
108
+ durationInMillis?: number | null;
109
+ }
110
+ export declare enum VideoType {
111
+ UNDEFINED = "UNDEFINED",
112
+ WIX_MEDIA = "WIX_MEDIA",
113
+ YOUTUBE = "YOUTUBE",
114
+ VIMEO = "VIMEO"
115
+ }
116
+ export interface VideoV2 {
117
+ /** WixMedia ID. Required. */
118
+ id?: string;
119
+ /** Video URL. */
120
+ url?: string;
121
+ /** Available resolutions for the video, starting with the optimal resolution. */
122
+ resolutions?: VideoResolution[];
123
+ /** Video filename. */
124
+ filename?: string | null;
125
+ /** Video posters. */
126
+ posters?: Image[];
127
+ }
128
+ export interface VideoResolution {
129
+ /** Video URL. Required. */
130
+ url?: string;
131
+ /** Video height. Required. */
132
+ height?: number;
133
+ /** Video width. Required. */
134
+ width?: number;
135
+ /** Video format for example, mp4, hls. Required. */
136
+ format?: string;
137
+ /** Video quality for example 480p, 720p. */
138
+ quality?: string | null;
139
+ /** Video filename. */
140
+ filename?: string | null;
141
+ }
103
142
  export interface ProjectDetail extends ProjectDetailValueOneOf {
104
- /** key of the detail field from predefined list */
105
- key?: Key;
106
- /** display label of the key */
107
143
  label?: string;
108
- /** text value */
109
144
  text?: string;
110
- /** number value */
111
- number?: number;
112
- /** date value */
113
- date?: Date;
145
+ link?: DetailsLink;
114
146
  }
115
147
  /** @oneof */
116
148
  export interface ProjectDetailValueOneOf {
117
- /** text value */
118
149
  text?: string;
119
- /** number value */
120
- number?: number;
121
- /** date value */
122
- date?: Date;
150
+ link?: DetailsLink;
123
151
  }
124
- export declare enum Key {
125
- UNDEFINED = "UNDEFINED",
126
- ROLE = "ROLE",
127
- LOCATION = "LOCATION",
128
- DATE = "DATE",
129
- CUSTOM = "CUSTOM",
130
- /** examples of values: "real estate", "photography" */
131
- PROJECT_TYPE = "PROJECT_TYPE"
152
+ export interface DetailsLink {
153
+ text?: string | null;
154
+ /** link to external source */
155
+ url?: string | null;
132
156
  }
133
157
  export interface ProjectSource {
134
158
  appDefId?: string;
@@ -166,13 +190,21 @@ export interface SeoSchema {
166
190
  settings?: Settings;
167
191
  }
168
192
  export interface Tag {
169
- /** SEO tag type. Supported values: `title`, `meta`, `script`, `link`. */
193
+ /**
194
+ * SEO tag type.
195
+ *
196
+ *
197
+ * Supported values: `title`, `meta`, `script`, `link`.
198
+ */
170
199
  type?: string;
171
- /** SEO tag attributes/properties (name, content, rel, href). */
200
+ /**
201
+ * A `{'key':'value'} pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.
202
+ * For example: `{'name': 'description', 'content': 'the description itself'}`.
203
+ */
172
204
  props?: Record<string, any> | null;
173
- /** Tag meta data, e.g. {height: 300, width: 240}. */
205
+ /** SEO tag meta data. For example, `{height: 300, width: 240}`. */
174
206
  meta?: Record<string, any> | null;
175
- /** Tag inner content e.g. `<title> inner content </title>`. */
207
+ /** SEO tag inner content. For example, `<title> inner content </title>`. */
176
208
  children?: string;
177
209
  /** Whether the tag is a custom tag. */
178
210
  custom?: boolean;
@@ -180,7 +212,12 @@ export interface Tag {
180
212
  disabled?: boolean;
181
213
  }
182
214
  export interface Settings {
183
- /** disable auto creation of 301 redirects on slug changes (enabled by default). */
215
+ /**
216
+ * Whether the auto redirects feature creating `301 redirects` on a slug change is enabled.
217
+ *
218
+ *
219
+ * Default: enabled
220
+ */
184
221
  preventAutoRedirect?: boolean;
185
222
  }
186
223
  export interface GetProjectPageDataRequest {
@@ -391,6 +428,102 @@ export interface NamespaceChanged {
391
428
  }
392
429
  export interface Empty {
393
430
  }
431
+ export interface HtmlSitePublished {
432
+ /** Application instance ID */
433
+ appInstanceId?: string;
434
+ /** Application type */
435
+ appType?: string;
436
+ /** Revision */
437
+ revision?: string;
438
+ /** MSID */
439
+ metaSiteId?: string | null;
440
+ /** optional branch id if publish is done from branch */
441
+ branchId?: string | null;
442
+ /** The site's last transactionId */
443
+ lastTransactionId?: string | null;
444
+ /** A list of the site's pages */
445
+ pages?: EventsPage[];
446
+ /** Site's publish date */
447
+ publishDate?: string;
448
+ }
449
+ export interface EventsPage {
450
+ /** Page's Id */
451
+ id?: string;
452
+ }
453
+ export interface DomainEvent extends DomainEventBodyOneOf {
454
+ /** random GUID so clients can tell if event was already handled */
455
+ id?: string;
456
+ /**
457
+ * Assumes actions are also always typed to an entity_type
458
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
459
+ */
460
+ entityFqdn?: string;
461
+ /**
462
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
463
+ * This is although the created/updated/deleted notion is duplication of the oneof types
464
+ * Example: created/updated/deleted/started/completed/email_opened
465
+ */
466
+ slug?: string;
467
+ /**
468
+ * Assuming that all messages including Actions have id
469
+ * Example: The id of the specific order, the id of a specific campaign
470
+ */
471
+ entityId?: string;
472
+ /** The time of the event. Useful if there was a delay in dispatching */
473
+ eventTime?: Date;
474
+ /**
475
+ * A field that should be set if this event was triggered by an anonymize request.
476
+ * For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.
477
+ * NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.
478
+ */
479
+ triggeredByAnonymizeRequest?: boolean | null;
480
+ /** If present, indicates the action that triggered the event. */
481
+ originatedFrom?: string | null;
482
+ /**
483
+ * A sequence number defining the order of updates to the underlying entity.
484
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
485
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
486
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
487
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
488
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
489
+ */
490
+ entityEventSequence?: string | null;
491
+ createdEvent?: EntityCreatedEvent;
492
+ updatedEvent?: EntityUpdatedEvent;
493
+ deletedEvent?: EntityDeletedEvent;
494
+ actionEvent?: ActionEvent;
495
+ extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
496
+ }
497
+ /** @oneof */
498
+ export interface DomainEventBodyOneOf {
499
+ createdEvent?: EntityCreatedEvent;
500
+ updatedEvent?: EntityUpdatedEvent;
501
+ deletedEvent?: EntityDeletedEvent;
502
+ actionEvent?: ActionEvent;
503
+ extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
504
+ }
505
+ export interface EntityCreatedEvent {
506
+ entityAsJson?: string;
507
+ }
508
+ export interface EntityUpdatedEvent {
509
+ /**
510
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
511
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
512
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
513
+ */
514
+ currentEntityAsJson?: string;
515
+ }
516
+ export interface EntityDeletedEvent {
517
+ }
518
+ export interface ActionEvent {
519
+ bodyAsJson?: string;
520
+ }
521
+ export interface ExtendedFieldsUpdatedEvent {
522
+ currentEntityAsJson?: string;
523
+ }
524
+ export interface AdminUpdatePortfolioMenuResponse {
525
+ response?: string | null;
526
+ }
394
527
  export interface InvalidateCache extends InvalidateCacheGetByOneOf {
395
528
  /** tell us why you're invalidating the cache. You don't need to add your app name */
396
529
  reason?: string | null;
@@ -476,8 +609,6 @@ export interface ListProjectsResponse {
476
609
  /** The retrieved Projects */
477
610
  projects?: Project[];
478
611
  /** Paging metadata */
479
- pagingMetadataV2?: PagingMetadataV2;
480
- /** Paging metadata */
481
612
  metadata?: PagingMetadataV2;
482
613
  }
483
614
  export interface PagingMetadataV2 {
@@ -501,8 +632,6 @@ export interface Cursors {
501
632
  export interface UpdateProjectRequest {
502
633
  /** Project to be updated, may be partial */
503
634
  project: Project;
504
- /** Explicit list of fields to update */
505
- mask?: string[];
506
635
  }
507
636
  export interface UpdateProjectResponse {
508
637
  /** The updated Project */
@@ -511,8 +640,6 @@ export interface UpdateProjectResponse {
511
640
  export interface DeleteProjectRequest {
512
641
  /** Id of the Project to delete */
513
642
  projectId: string;
514
- /** The revision of the Project */
515
- revision?: string;
516
643
  }
517
644
  export interface DeleteProjectResponse {
518
645
  /** Id of the deleted Project */
@@ -574,21 +701,19 @@ export interface QueryProjectsResponse {
574
701
  /** The retrieved Projects */
575
702
  projects?: Project[];
576
703
  /** Paging metadata */
577
- pagingMetadataV2?: PagingMetadataV2;
578
- /** Paging metadata */
579
704
  metadata?: PagingMetadataV2;
580
705
  }
581
706
  export interface UpdateProjectOrderInCollectionRequest {
582
707
  /** Id of the Project to update its order */
583
- projectId: string;
708
+ projectId?: string;
584
709
  /** Id of the collection in which the project will be re-ordered */
585
- collectionId: string;
710
+ collectionId?: string;
586
711
  /** The new sort order of the project in the given collection */
587
- sortOrder: number | null;
712
+ sortOrder?: number | null;
588
713
  }
589
714
  export interface UpdateProjectOrderInCollectionResponse {
590
715
  /** project with new sort order set */
591
- project?: ProjectInCollection;
716
+ projectInCollection?: ProjectInCollection;
592
717
  }
593
718
  export interface ProjectInCollection {
594
719
  /** Collection ID */
@@ -608,85 +733,12 @@ export interface ProjectOrderInCollectionUpdatedEvent {
608
733
  }
609
734
  export interface QueryProjectWithCollectionInfoRequest {
610
735
  /** WQL expression */
611
- query: QueryV2;
736
+ query?: QueryV2;
612
737
  includePageUrl?: boolean | null;
613
738
  }
614
739
  export interface QueryProjectWithCollectionInfoResponse {
615
740
  /** The retrieved Projects in Collection */
616
741
  projects?: ProjectInCollection[];
617
742
  /** Paging metadata */
618
- pagingMetadataV2?: PagingMetadataV2;
619
- /** Paging metadata */
620
743
  metadata?: PagingMetadataV2;
621
744
  }
622
- export interface DomainEvent extends DomainEventBodyOneOf {
623
- /** random GUID so clients can tell if event was already handled */
624
- id?: string;
625
- /**
626
- * Assumes actions are also always typed to an entity_type
627
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
628
- */
629
- entityFqdn?: string;
630
- /**
631
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
632
- * This is although the created/updated/deleted notion is duplication of the oneof types
633
- * Example: created/updated/deleted/started/completed/email_opened
634
- */
635
- slug?: string;
636
- /**
637
- * Assuming that all messages including Actions have id
638
- * Example: The id of the specific order, the id of a specific campaign
639
- */
640
- entityId?: string;
641
- /** The time of the event. Useful if there was a delay in dispatching */
642
- eventTime?: Date;
643
- /**
644
- * A field that should be set if this event was triggered by an anonymize request.
645
- * For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.
646
- * NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.
647
- */
648
- triggeredByAnonymizeRequest?: boolean | null;
649
- /** If present, indicates the action that triggered the event. */
650
- originatedFrom?: string | null;
651
- /**
652
- * A sequence number defining the order of updates to the underlying entity.
653
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
654
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
655
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
656
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
657
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
658
- */
659
- entityEventSequence?: string | null;
660
- createdEvent?: EntityCreatedEvent;
661
- updatedEvent?: EntityUpdatedEvent;
662
- deletedEvent?: EntityDeletedEvent;
663
- actionEvent?: ActionEvent;
664
- extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
665
- }
666
- /** @oneof */
667
- export interface DomainEventBodyOneOf {
668
- createdEvent?: EntityCreatedEvent;
669
- updatedEvent?: EntityUpdatedEvent;
670
- deletedEvent?: EntityDeletedEvent;
671
- actionEvent?: ActionEvent;
672
- extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
673
- }
674
- export interface EntityCreatedEvent {
675
- entityAsJson?: string;
676
- }
677
- export interface EntityUpdatedEvent {
678
- /**
679
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
680
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
681
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
682
- */
683
- currentEntityAsJson?: string;
684
- }
685
- export interface EntityDeletedEvent {
686
- }
687
- export interface ActionEvent {
688
- bodyAsJson?: string;
689
- }
690
- export interface ExtendedFieldsUpdatedEvent {
691
- currentEntityAsJson?: string;
692
- }
@@ -1,22 +1,19 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.SortOrder = exports.DeleteStatus = exports.Namespace = exports.SiteCreatedContext = exports.State = exports.SyncStatus = exports.Key = exports.ImageType = void 0;
4
- var ImageType;
5
- (function (ImageType) {
6
- ImageType["UNDEFINED"] = "UNDEFINED";
7
- ImageType["WIX_MEDIA"] = "WIX_MEDIA";
8
- ImageType["EXTERNAL"] = "EXTERNAL";
9
- })(ImageType = exports.ImageType || (exports.ImageType = {}));
10
- var Key;
11
- (function (Key) {
12
- Key["UNDEFINED"] = "UNDEFINED";
13
- Key["ROLE"] = "ROLE";
14
- Key["LOCATION"] = "LOCATION";
15
- Key["DATE"] = "DATE";
16
- Key["CUSTOM"] = "CUSTOM";
17
- /** examples of values: "real estate", "photography" */
18
- Key["PROJECT_TYPE"] = "PROJECT_TYPE";
19
- })(Key = exports.Key || (exports.Key = {}));
3
+ exports.SortOrder = exports.DeleteStatus = exports.Namespace = exports.SiteCreatedContext = exports.State = exports.SyncStatus = exports.VideoType = exports.ImageImageType = void 0;
4
+ var ImageImageType;
5
+ (function (ImageImageType) {
6
+ ImageImageType["UNDEFINED"] = "UNDEFINED";
7
+ ImageImageType["WIX_MEDIA"] = "WIX_MEDIA";
8
+ ImageImageType["EXTERNAL"] = "EXTERNAL";
9
+ })(ImageImageType = exports.ImageImageType || (exports.ImageImageType = {}));
10
+ var VideoType;
11
+ (function (VideoType) {
12
+ VideoType["UNDEFINED"] = "UNDEFINED";
13
+ VideoType["WIX_MEDIA"] = "WIX_MEDIA";
14
+ VideoType["YOUTUBE"] = "YOUTUBE";
15
+ VideoType["VIMEO"] = "VIMEO";
16
+ })(VideoType = exports.VideoType || (exports.VideoType = {}));
20
17
  var SyncStatus;
21
18
  (function (SyncStatus) {
22
19
  SyncStatus["SYNCED"] = "SYNCED";
@@ -1 +1 @@
1
- {"version":3,"file":"portfolio-projects-v1-project.types.js","sourceRoot":"","sources":["../../../src/portfolio-projects-v1-project.types.ts"],"names":[],"mappings":";;;AA0DA,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,oCAAuB,CAAA;IACvB,oCAAuB,CAAA;IACvB,kCAAqB,CAAA;AACvB,CAAC,EAJW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAIpB;AAqED,IAAY,GAQX;AARD,WAAY,GAAG;IACb,8BAAuB,CAAA;IACvB,oBAAa,CAAA;IACb,4BAAqB,CAAA;IACrB,oBAAa,CAAA;IACb,wBAAiB,CAAA;IACjB,uDAAuD;IACvD,oCAA6B,CAAA;AAC/B,CAAC,EARW,GAAG,GAAH,WAAG,KAAH,WAAG,QAQd;AAgBD,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,+BAAiB,CAAA;IACjB,iCAAmB,CAAA;IACnB,uCAAyB,CAAA;AAC3B,CAAC,EAJW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAIrB;AA2GD,IAAY,KAMX;AAND,WAAY,KAAK;IACf,4BAAmB,CAAA;IACnB,4BAAmB,CAAA;IACnB,8BAAqB,CAAA;IACrB,4BAAmB,CAAA;IACnB,sBAAa,CAAA;AACf,CAAC,EANW,KAAK,GAAL,aAAK,KAAL,aAAK,QAMhB;AAiBD,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,GAAlB,0BAAkB,KAAlB,0BAAkB,QAa7B;AAED,IAAY,SA4CX;AA5CD,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;AACvB,CAAC,EA5CW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QA4CpB;AAsBD,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,+BAAe,CAAA;IACf,mCAAmB,CAAA;IACnB,+CAA+B,CAAA;AACjC,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB;AAoPD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB"}
1
+ {"version":3,"file":"portfolio-projects-v1-project.types.js","sourceRoot":"","sources":["../../../src/portfolio-projects-v1-project.types.ts"],"names":[],"mappings":";;;AA4DA,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,yCAAuB,CAAA;IACvB,yCAAuB,CAAA;IACvB,uCAAqB,CAAA;AACvB,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB;AAqDD,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,oCAAuB,CAAA;IACvB,oCAAuB,CAAA;IACvB,gCAAmB,CAAA;IACnB,4BAAe,CAAA;AACjB,CAAC,EALW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAKpB;AA8DD,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,+BAAiB,CAAA;IACjB,iCAAmB,CAAA;IACnB,uCAAyB,CAAA;AAC3B,CAAC,EAJW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAIrB;AAwHD,IAAY,KAMX;AAND,WAAY,KAAK;IACf,4BAAmB,CAAA;IACnB,4BAAmB,CAAA;IACnB,8BAAqB,CAAA;IACrB,4BAAmB,CAAA;IACnB,sBAAa,CAAA;AACf,CAAC,EANW,KAAK,GAAL,aAAK,KAAL,aAAK,QAMhB;AAiBD,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,GAAlB,0BAAkB,KAAlB,0BAAkB,QAa7B;AAED,IAAY,SA4CX;AA5CD,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;AACvB,CAAC,EA5CW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QA4CpB;AAsBD,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,+BAAe,CAAA;IACf,mCAAmB,CAAA;IACnB,+CAA+B,CAAA;AACjC,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB;AAuVD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB"}