@wix/auto_sdk_portfolio_project-items 1.0.45 → 1.0.46

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.
@@ -42,6 +42,11 @@ interface Item extends ItemMetadataOneOf {
42
42
  * @readonly
43
43
  */
44
44
  updatedDate?: Date | null;
45
+ /**
46
+ * Project item tags.
47
+ * @internal
48
+ */
49
+ tags?: Tags;
45
50
  /** Project item link. */
46
51
  link?: Link;
47
52
  }
@@ -63,10 +68,48 @@ declare enum Type {
63
68
  /** @enumType */
64
69
  type TypeWithLiterals = Type | 'UNDEFINED' | 'IMAGE' | 'VIDEO';
65
70
  interface Image {
71
+ /**
72
+ * @internal
73
+ * @deprecated
74
+ * @targetRemovalDate 2026-02-05
75
+ */
76
+ type?: ImageTypeWithLiterals;
66
77
  /** Information about the Wix Media image. */
67
78
  imageInfo?: CommonImage;
68
79
  /** Focal point of the image. */
69
80
  focalPoint?: Point;
81
+ /**
82
+ * Set of key-value pairs describing the media in [Exchangeable Image File format](https://en.wikipedia.org/wiki/Exif).
83
+ * @internal
84
+ */
85
+ exif?: Record<string, any> | null;
86
+ /**
87
+ * Image compression level. <br />
88
+ *
89
+ * Min: `30` <br />
90
+ * Max: `100`
91
+ * @internal
92
+ * @min 30
93
+ * @max 100
94
+ */
95
+ quality?: number | null;
96
+ /**
97
+ * [Unsharp masking](https://en.wikipedia.org/wiki/Unsharp_masking) values of the image.
98
+ * @internal
99
+ */
100
+ unsharpMasking?: UnsharpMasking;
101
+ /**
102
+ * Whether the image is saved in secure media.
103
+ * @internal
104
+ */
105
+ secure?: boolean | null;
106
+ /**
107
+ * When image is saved in secure media, token is generated.
108
+ * @internal
109
+ * @readonly
110
+ * @maxLength 5000
111
+ */
112
+ token?: string | null;
70
113
  }
71
114
  declare enum ImageType {
72
115
  UNDEFINED = "UNDEFINED",
@@ -96,11 +139,22 @@ interface CommonImage {
96
139
  * @maxLength 5000
97
140
  */
98
141
  altText?: string | null;
142
+ /**
143
+ * Image URL expiration date (when relevant).
144
+ * @internal
145
+ */
146
+ urlExpirationDate?: Date | null;
99
147
  /**
100
148
  * Image filename.
101
149
  * @maxLength 512
102
150
  */
103
151
  filename?: string | null;
152
+ /**
153
+ * Image size in bytes.
154
+ * @internal
155
+ * @decimalValue options { maxScale:100 }
156
+ */
157
+ sizeInBytes?: string | null;
104
158
  }
105
159
  interface Point {
106
160
  /** X-coordinate of the focal point. */
@@ -160,6 +214,17 @@ interface VideoV2 {
160
214
  * @maxSize 100
161
215
  */
162
216
  posters?: CommonImage[];
217
+ /**
218
+ * Original video size in bytes.
219
+ * @internal
220
+ * @decimalValue options { maxScale:100 }
221
+ */
222
+ sizeInBytes?: string | null;
223
+ /**
224
+ * Video URL expiration date (when relevant).
225
+ * @internal
226
+ */
227
+ urlExpirationDate?: Date | null;
163
228
  }
164
229
  interface VideoResolution {
165
230
  /**
@@ -171,6 +236,13 @@ interface VideoResolution {
171
236
  height?: number;
172
237
  /** Video width. Required. */
173
238
  width?: number;
239
+ /**
240
+ * Video poster. Deprecated, please use the `posters` property in the parent entity
241
+ * @internal
242
+ * @deprecated Video poster. Deprecated, please use the `posters` property in the parent entity
243
+ * @targetRemovalDate 2026-02-05
244
+ */
245
+ poster?: CommonImage;
174
246
  /**
175
247
  * Video format for example, mp4, hls. Required.
176
248
  * @maxLength 50
@@ -373,10 +445,23 @@ interface CreateProjectItemRequest {
373
445
  item: Item;
374
446
  }
375
447
  interface CreateProjectItemResponse {
448
+ /**
449
+ * @internal
450
+ * @format GUID
451
+ * @deprecated
452
+ * @targetRemovalDate 2025-05-25
453
+ */
454
+ projectId?: string;
376
455
  /** Newly created project item. */
377
456
  item?: Item;
378
457
  }
379
458
  interface BulkCreateProjectItemsRequest {
459
+ /**
460
+ * Project ID.
461
+ * @internal
462
+ * @format GUID
463
+ */
464
+ projectId: string;
380
465
  /**
381
466
  * Project items to create.
382
467
  * @minSize 1
@@ -393,6 +478,12 @@ interface BulkCreateProjectItemsRequest {
393
478
  returnFullEntity?: boolean | null;
394
479
  }
395
480
  interface BulkCreateProjectItemsResponse {
481
+ /**
482
+ * Project ID.
483
+ * @internal
484
+ * @format GUID
485
+ */
486
+ projectId?: string;
396
487
  /** List of individual Bulk Create Project Items results. */
397
488
  results?: BulkCreateProjectItemResult[];
398
489
  /** Total number of successes and failures for Bulk Create Project Items. */
@@ -460,6 +551,13 @@ interface Paging {
460
551
  offset?: number | null;
461
552
  }
462
553
  interface ListProjectItemsResponse {
554
+ /**
555
+ * @internal
556
+ * @format GUID
557
+ * @deprecated
558
+ * @targetRemovalDate 2025-05-25
559
+ */
560
+ projectId?: string;
463
561
  /** Project items. */
464
562
  items?: Item[];
465
563
  /**
@@ -481,6 +579,13 @@ interface PagingMetadataV2 {
481
579
  tooManyToCount?: boolean | null;
482
580
  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
483
581
  cursors?: Cursors;
582
+ /**
583
+ * Indicates if there are more results after the current page.
584
+ * If `true`, another page of results can be retrieved.
585
+ * If `false`, this is the last page.
586
+ * @internal
587
+ */
588
+ hasNext?: boolean | null;
484
589
  }
485
590
  interface Cursors {
486
591
  /**
@@ -535,6 +640,20 @@ interface Sorting {
535
640
  fieldName?: string;
536
641
  /** Sort order. */
537
642
  order?: SortOrderWithLiterals;
643
+ /**
644
+ * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
645
+ * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
646
+ *
647
+ * If multiple filters are provided, they are combined with AND operator.
648
+ *
649
+ * Example:
650
+ * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
651
+ * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
652
+ * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
653
+ * @internal
654
+ * @maxSize 10
655
+ */
656
+ selectItemsBy?: Record<string, any>[] | null;
538
657
  /**
539
658
  * Origin point for geo-distance sorting on a GEO field
540
659
  * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
@@ -577,12 +696,30 @@ interface QueryProjectItemsResponse {
577
696
  interface UpdateProjectItemRequest {
578
697
  /** The project item to update. */
579
698
  item: Item;
699
+ /**
700
+ * Explicit list of fields to update
701
+ * @internal
702
+ */
703
+ mask?: string[];
580
704
  }
581
705
  interface UpdateProjectItemResponse {
706
+ /**
707
+ * @internal
708
+ * @format GUID
709
+ * @deprecated
710
+ * @targetRemovalDate 2025-05-25
711
+ */
712
+ projectId?: string;
582
713
  /** The updated project item. */
583
714
  item?: Item;
584
715
  }
585
716
  interface BulkUpdateProjectItemsRequest {
717
+ /**
718
+ * Project ID.
719
+ * @internal
720
+ * @format GUID
721
+ */
722
+ projectId: string;
586
723
  /**
587
724
  * Project items to update.
588
725
  * @maxSize 100
@@ -600,8 +737,19 @@ interface BulkUpdateProjectItemsRequest {
600
737
  interface MaskedItem {
601
738
  /** Item to be updated. */
602
739
  item?: Item;
740
+ /**
741
+ * Fields to update.
742
+ * @internal
743
+ */
744
+ fieldMask?: string[];
603
745
  }
604
746
  interface BulkUpdateProjectItemsResponse {
747
+ /**
748
+ * Project ID.
749
+ * @internal
750
+ * @format GUID
751
+ */
752
+ projectId?: string;
605
753
  /** List of individual Bulk Update Project Items results. */
606
754
  results?: BulkUpdateProjectItemResult[];
607
755
  /** Total number of successes and failures for Bulk Update Project Items. */
@@ -631,6 +779,12 @@ interface DeleteProjectItemResponse {
631
779
  itemId?: string;
632
780
  }
633
781
  interface BulkDeleteProjectItemsRequest {
782
+ /**
783
+ * Project ID.
784
+ * @internal
785
+ * @format GUID
786
+ */
787
+ projectId: string;
634
788
  /**
635
789
  * IDs of project items to delete.
636
790
  * @format GUID
@@ -640,6 +794,12 @@ interface BulkDeleteProjectItemsRequest {
640
794
  itemIds: string[];
641
795
  }
642
796
  interface BulkDeleteProjectItemsResponse {
797
+ /**
798
+ * Project ID.
799
+ * @internal
800
+ * @format GUID
801
+ */
802
+ projectId?: string;
643
803
  /** List of individual Bulk Delete Project Items results. */
644
804
  results?: BulkDeleteProjectItemResult[];
645
805
  /** Total number of successes and failures for Bulk Delete Project Items. */
@@ -719,8 +879,18 @@ interface DomainEventBodyOneOf {
719
879
  }
720
880
  interface EntityCreatedEvent {
721
881
  entityAsJson?: string;
882
+ /**
883
+ * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
884
+ * @internal
885
+ */
886
+ triggeredByUndelete?: boolean | null;
722
887
  /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
723
888
  restoreInfo?: RestoreInfo;
889
+ /**
890
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
891
+ * @internal
892
+ */
893
+ additionalMetadataAsJson?: string | null;
724
894
  }
725
895
  interface RestoreInfo {
726
896
  deletedDate?: Date | null;
@@ -732,10 +902,42 @@ interface EntityUpdatedEvent {
732
902
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
733
903
  */
734
904
  currentEntityAsJson?: string;
905
+ /**
906
+ * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
907
+ * wont populate it / have any reference to it in the API.
908
+ * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
909
+ * the developer should send only the new (current) entity.
910
+ * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
911
+ * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
912
+ * @internal
913
+ * @deprecated
914
+ */
915
+ previousEntityAsJson?: string | null;
916
+ /**
917
+ * Map of fully qualified field paths to their previous values for fields that changed.
918
+ * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
919
+ * @internal
920
+ */
921
+ modifiedFields?: Record<string, any>;
922
+ /**
923
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
924
+ * @internal
925
+ */
926
+ additionalMetadataAsJson?: string | null;
735
927
  }
736
928
  interface EntityDeletedEvent {
929
+ /**
930
+ * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
931
+ * @internal
932
+ */
933
+ movedToTrash?: boolean | null;
737
934
  /** Entity that was deleted. */
738
935
  deletedEntityAsJson?: string | null;
936
+ /**
937
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
938
+ * @internal
939
+ */
940
+ additionalMetadataAsJson?: string | null;
739
941
  }
740
942
  interface ActionEvent {
741
943
  bodyAsJson?: string;