@wix/auto_sdk_portfolio_project-items 1.0.44 → 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.
@@ -41,6 +41,11 @@ interface Item extends ItemMetadataOneOf {
41
41
  * @readonly
42
42
  */
43
43
  _updatedDate?: Date | null;
44
+ /**
45
+ * Project item tags.
46
+ * @internal
47
+ */
48
+ tags?: Tags;
44
49
  /** Project item link. */
45
50
  link?: Link;
46
51
  }
@@ -62,10 +67,48 @@ declare enum Type {
62
67
  /** @enumType */
63
68
  type TypeWithLiterals = Type | 'UNDEFINED' | 'IMAGE' | 'VIDEO';
64
69
  interface Image {
70
+ /**
71
+ * @internal
72
+ * @deprecated
73
+ * @targetRemovalDate 2026-02-05
74
+ */
75
+ type?: ImageTypeWithLiterals;
65
76
  /** Information about the Wix Media image. */
66
77
  imageInfo?: string;
67
78
  /** Focal point of the image. */
68
79
  focalPoint?: Point;
80
+ /**
81
+ * Set of key-value pairs describing the media in [Exchangeable Image File format](https://en.wikipedia.org/wiki/Exif).
82
+ * @internal
83
+ */
84
+ exif?: Record<string, any> | null;
85
+ /**
86
+ * Image compression level. <br />
87
+ *
88
+ * Min: `30` <br />
89
+ * Max: `100`
90
+ * @internal
91
+ * @min 30
92
+ * @max 100
93
+ */
94
+ quality?: number | null;
95
+ /**
96
+ * [Unsharp masking](https://en.wikipedia.org/wiki/Unsharp_masking) values of the image.
97
+ * @internal
98
+ */
99
+ unsharpMasking?: UnsharpMasking;
100
+ /**
101
+ * Whether the image is saved in secure media.
102
+ * @internal
103
+ */
104
+ secure?: boolean | null;
105
+ /**
106
+ * When image is saved in secure media, token is generated.
107
+ * @internal
108
+ * @readonly
109
+ * @maxLength 5000
110
+ */
111
+ token?: string | null;
69
112
  }
70
113
  declare enum ImageType {
71
114
  UNDEFINED = "UNDEFINED",
@@ -116,6 +159,13 @@ interface VideoResolution {
116
159
  height?: number;
117
160
  /** Video width. Required. */
118
161
  width?: number;
162
+ /**
163
+ * Video poster. Deprecated, please use the `posters` property in the parent entity
164
+ * @internal
165
+ * @deprecated Video poster. Deprecated, please use the `posters` property in the parent entity
166
+ * @targetRemovalDate 2026-02-05
167
+ */
168
+ poster?: string;
119
169
  /**
120
170
  * Video format for example, mp4, hls. Required.
121
171
  * @maxLength 50
@@ -318,10 +368,23 @@ interface CreateProjectItemRequest {
318
368
  item: Item;
319
369
  }
320
370
  interface CreateProjectItemResponse {
371
+ /**
372
+ * @internal
373
+ * @format GUID
374
+ * @deprecated
375
+ * @targetRemovalDate 2025-05-25
376
+ */
377
+ projectId?: string;
321
378
  /** Newly created project item. */
322
379
  item?: Item;
323
380
  }
324
381
  interface BulkCreateProjectItemsRequest {
382
+ /**
383
+ * Project ID.
384
+ * @internal
385
+ * @format GUID
386
+ */
387
+ projectId: string;
325
388
  /**
326
389
  * Project items to create.
327
390
  * @minSize 1
@@ -338,6 +401,12 @@ interface BulkCreateProjectItemsRequest {
338
401
  returnFullEntity?: boolean | null;
339
402
  }
340
403
  interface BulkCreateProjectItemsResponse {
404
+ /**
405
+ * Project ID.
406
+ * @internal
407
+ * @format GUID
408
+ */
409
+ projectId?: string;
341
410
  /** List of individual Bulk Create Project Items results. */
342
411
  results?: BulkCreateProjectItemResult[];
343
412
  /** Total number of successes and failures for Bulk Create Project Items. */
@@ -405,6 +474,13 @@ interface Paging {
405
474
  offset?: number | null;
406
475
  }
407
476
  interface ListProjectItemsResponse {
477
+ /**
478
+ * @internal
479
+ * @format GUID
480
+ * @deprecated
481
+ * @targetRemovalDate 2025-05-25
482
+ */
483
+ projectId?: string;
408
484
  /** Project items. */
409
485
  items?: Item[];
410
486
  /**
@@ -426,6 +502,13 @@ interface PagingMetadataV2 {
426
502
  tooManyToCount?: boolean | null;
427
503
  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
428
504
  cursors?: Cursors;
505
+ /**
506
+ * Indicates if there are more results after the current page.
507
+ * If `true`, another page of results can be retrieved.
508
+ * If `false`, this is the last page.
509
+ * @internal
510
+ */
511
+ hasNext?: boolean | null;
429
512
  }
430
513
  interface Cursors {
431
514
  /**
@@ -480,6 +563,20 @@ interface Sorting {
480
563
  fieldName?: string;
481
564
  /** Sort order. */
482
565
  order?: SortOrderWithLiterals;
566
+ /**
567
+ * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
568
+ * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
569
+ *
570
+ * If multiple filters are provided, they are combined with AND operator.
571
+ *
572
+ * Example:
573
+ * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
574
+ * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
575
+ * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
576
+ * @internal
577
+ * @maxSize 10
578
+ */
579
+ selectItemsBy?: Record<string, any>[] | null;
483
580
  /**
484
581
  * Origin point for geo-distance sorting on a GEO field
485
582
  * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
@@ -522,12 +619,30 @@ interface QueryProjectItemsResponse {
522
619
  interface UpdateProjectItemRequest {
523
620
  /** The project item to update. */
524
621
  item: Item;
622
+ /**
623
+ * Explicit list of fields to update
624
+ * @internal
625
+ */
626
+ mask?: string[];
525
627
  }
526
628
  interface UpdateProjectItemResponse {
629
+ /**
630
+ * @internal
631
+ * @format GUID
632
+ * @deprecated
633
+ * @targetRemovalDate 2025-05-25
634
+ */
635
+ projectId?: string;
527
636
  /** The updated project item. */
528
637
  item?: Item;
529
638
  }
530
639
  interface BulkUpdateProjectItemsRequest {
640
+ /**
641
+ * Project ID.
642
+ * @internal
643
+ * @format GUID
644
+ */
645
+ projectId: string;
531
646
  /**
532
647
  * Project items to update.
533
648
  * @maxSize 100
@@ -545,8 +660,19 @@ interface BulkUpdateProjectItemsRequest {
545
660
  interface MaskedItem {
546
661
  /** Item to be updated. */
547
662
  item?: Item;
663
+ /**
664
+ * Fields to update.
665
+ * @internal
666
+ */
667
+ fieldMask?: string[];
548
668
  }
549
669
  interface BulkUpdateProjectItemsResponse {
670
+ /**
671
+ * Project ID.
672
+ * @internal
673
+ * @format GUID
674
+ */
675
+ projectId?: string;
550
676
  /** List of individual Bulk Update Project Items results. */
551
677
  results?: BulkUpdateProjectItemResult[];
552
678
  /** Total number of successes and failures for Bulk Update Project Items. */
@@ -576,6 +702,12 @@ interface DeleteProjectItemResponse {
576
702
  itemId?: string;
577
703
  }
578
704
  interface BulkDeleteProjectItemsRequest {
705
+ /**
706
+ * Project ID.
707
+ * @internal
708
+ * @format GUID
709
+ */
710
+ projectId: string;
579
711
  /**
580
712
  * IDs of project items to delete.
581
713
  * @format GUID
@@ -585,6 +717,12 @@ interface BulkDeleteProjectItemsRequest {
585
717
  itemIds: string[];
586
718
  }
587
719
  interface BulkDeleteProjectItemsResponse {
720
+ /**
721
+ * Project ID.
722
+ * @internal
723
+ * @format GUID
724
+ */
725
+ projectId?: string;
588
726
  /** List of individual Bulk Delete Project Items results. */
589
727
  results?: BulkDeleteProjectItemResult[];
590
728
  /** Total number of successes and failures for Bulk Delete Project Items. */
@@ -885,8 +1023,6 @@ interface ProjectItemCreatedEnvelope {
885
1023
  }
886
1024
  /**
887
1025
  * Triggered when a project item is created.
888
- * @permissionScope Wix Multilingual - Nile Wrapper Domain Events Read
889
- * @permissionScopeId SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ
890
1026
  * @permissionScope Manage Portfolio
891
1027
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
892
1028
  * @permissionId PORTFOLIO.PROJECT_ITEM_READ
@@ -900,8 +1036,6 @@ interface ProjectItemDeletedEnvelope {
900
1036
  }
901
1037
  /**
902
1038
  * Triggered when a project item is deleted.
903
- * @permissionScope Wix Multilingual - Nile Wrapper Domain Events Read
904
- * @permissionScopeId SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ
905
1039
  * @permissionScope Manage Portfolio
906
1040
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
907
1041
  * @permissionId PORTFOLIO.PROJECT_ITEM_READ
@@ -916,8 +1050,6 @@ interface ProjectItemUpdatedEnvelope {
916
1050
  }
917
1051
  /**
918
1052
  * Triggered when a project item is updated.
919
- * @permissionScope Wix Multilingual - Nile Wrapper Domain Events Read
920
- * @permissionScopeId SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ
921
1053
  * @permissionScope Manage Portfolio
922
1054
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
923
1055
  * @permissionId PORTFOLIO.PROJECT_ITEM_READ
@@ -1042,6 +1174,11 @@ interface UpdateProjectItem {
1042
1174
  * @readonly
1043
1175
  */
1044
1176
  _updatedDate?: Date | null;
1177
+ /**
1178
+ * Project item tags.
1179
+ * @internal
1180
+ */
1181
+ tags?: Tags;
1045
1182
  /** Project item link. */
1046
1183
  link?: Link;
1047
1184
  }