@wix/portfolio 1.0.93 → 1.0.94

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.
@@ -1,47 +1,50 @@
1
- /** Collection is the main entity of CollectionsService */
2
1
  interface Collection$1 {
3
2
  /**
4
- * Collection ID
3
+ * Collection ID.
5
4
  * @readonly
6
5
  */
7
6
  id?: string | null;
8
7
  /**
9
- * 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
8
+ * Revision number, which increments by 1 each time the collection is updated. To prevent conflicting changes, the existing revision must be passed when updating the collection object.
10
9
  * @readonly
11
10
  */
12
11
  revision?: string | null;
13
- /** Title of Collection */
12
+ /** Collection title. */
14
13
  title?: string | null;
15
- /** Description of Collection */
14
+ /** Collection description. */
16
15
  description?: string | null;
17
- /** Url of Collection */
16
+ /** Collection slug. */
18
17
  slug?: string | null;
19
- /** Collection's cover photo */
18
+ /** Collection cover image. */
20
19
  coverImage?: Image$7;
21
- /** Indicates if the collection is hidden from Portfolio */
20
+ /** Whether the collection is hidden from the portfolio. */
22
21
  hidden?: boolean | null;
23
- /** if not present in an update it means the collection will be added as currentTimestamp - as the last collection */
22
+ /**
23
+ * Index that determines which position a media item is displayed in the gallery. <br />
24
+ *
25
+ * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
26
+ */
24
27
  sortOrder?: number | null;
25
28
  /**
26
- * Represents the time this Collection was created
29
+ * Date and time the collection was created.
27
30
  * @readonly
28
31
  */
29
32
  createdDate?: Date;
30
33
  /**
31
- * Represents the time this Collection was last updated
34
+ * Date and time the collection was updated.
32
35
  * @readonly
33
36
  */
34
37
  updatedDate?: Date;
35
38
  /**
36
- * Url and relative url of Collection - in order to receive this field in READ requests you will need to pass the `include_page_url` field as part of request
39
+ * Collection's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
37
40
  * @readonly
38
41
  */
39
42
  url?: PageUrlV2$2;
40
- /** SEO data for Collection */
43
+ /** Collection SEO data. */
41
44
  seoData?: SeoSchema$5;
42
45
  }
43
46
  interface Image$7 {
44
- /** Image info - Wix Media Image. */
47
+ /** Information about the Wix Media image. */
45
48
  imageInfo?: CommonImage$3;
46
49
  /** Focal point of the image. */
47
50
  focalPoint?: Point$7;
@@ -133,27 +136,27 @@ interface Settings$5 {
133
136
  keywords?: Keyword$5[];
134
137
  }
135
138
  interface CreateCollectionRequest$1 {
136
- /** Collection to be created */
139
+ /** Collection to create. */
137
140
  collection: Collection$1;
138
141
  }
139
142
  interface CreateCollectionResponse$1 {
140
- /** The created Collection */
143
+ /** Created collection. */
141
144
  collection?: Collection$1;
142
145
  }
143
146
  interface GetCollectionRequest$1 {
144
- /** Id of the Collection to retrieve */
147
+ /** ID of the collection to retrieve. */
145
148
  collectionId: string;
146
- /** Include page url */
149
+ /** Whether to include the collection's page URL and relative path in the response. */
147
150
  includePageUrl?: boolean | null;
148
151
  }
149
152
  interface GetCollectionResponse$1 {
150
- /** The retrieved Collection */
153
+ /** The requested collection. */
151
154
  collection?: Collection$1;
152
155
  }
153
156
  interface ListCollectionsRequest$1 {
154
- /** Maximum limit per response is 100, in first request cursor is None */
157
+ /** Maximum limit per response is 100, in first request cursor is None ? */
155
158
  paging?: CursorPaging$7;
156
- /** Include page url */
159
+ /** Whether to include the collection's page URL and relative path in the response. */
157
160
  includePageUrl?: boolean | null;
158
161
  }
159
162
  interface CursorPaging$7 {
@@ -168,9 +171,9 @@ interface CursorPaging$7 {
168
171
  cursor?: string | null;
169
172
  }
170
173
  interface ListCollectionsResponse$1 {
171
- /** Retrieved Collections */
174
+ /** List of collections. */
172
175
  collections?: Collection$1[];
173
- /** Paging metadata */
176
+ /** Paging metadata. */
174
177
  metadata?: PagingMetadataV2$9;
175
178
  }
176
179
  interface PagingMetadataV2$9 {
@@ -192,25 +195,25 @@ interface Cursors$9 {
192
195
  prev?: string | null;
193
196
  }
194
197
  interface UpdateCollectionRequest$1 {
195
- /** Collection to be updated, may be partial */
198
+ /** Collection to update. */
196
199
  collection: Collection$1;
197
200
  }
198
201
  interface UpdateCollectionResponse$1 {
199
- /** The updated Collection */
202
+ /** Updated collection. */
200
203
  collection?: Collection$1;
201
204
  }
202
205
  interface DeleteCollectionRequest$1 {
203
- /** Id of the Collection to delete */
206
+ /** ID of the collection to delete. */
204
207
  collectionId: string;
205
208
  }
206
209
  interface DeleteCollectionResponse$1 {
207
- /** Id of the Deleted Collection */
210
+ /** ID of the deleted collection. */
208
211
  collectionId?: string;
209
212
  }
210
213
  interface QueryCollectionsRequest$1 {
211
- /** WQL expression */
214
+ /** Query options. */
212
215
  query: QueryV2$5;
213
- /** Include page url */
216
+ /** Whether to include the collection's page URL and relative path in the response. */
214
217
  includePageUrl?: boolean | null;
215
218
  }
216
219
  interface QueryV2$5 extends QueryV2PagingMethodOneOf$5 {
@@ -259,9 +262,9 @@ interface Paging$7 {
259
262
  offset?: number | null;
260
263
  }
261
264
  interface QueryCollectionsResponse$1 {
262
- /** The retrieved Collections */
265
+ /** List of collections. */
263
266
  collections?: Collection$1[];
264
- /** Paging metadata */
267
+ /** Paging metadata. */
265
268
  metadata?: PagingMetadataV2$9;
266
269
  }
267
270
  interface CommonImageNonNullableFields$3 {
@@ -324,50 +327,53 @@ interface QueryCollectionsResponseNonNullableFields$1 {
324
327
  collections: CollectionNonNullableFields$1[];
325
328
  }
326
329
 
327
- /** Collection is the main entity of CollectionsService */
328
330
  interface Collection {
329
331
  /**
330
- * Collection ID
332
+ * Collection ID.
331
333
  * @readonly
332
334
  */
333
335
  _id?: string | null;
334
336
  /**
335
- * 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
337
+ * Revision number, which increments by 1 each time the collection is updated. To prevent conflicting changes, the existing revision must be passed when updating the collection object.
336
338
  * @readonly
337
339
  */
338
340
  revision?: string | null;
339
- /** Title of Collection */
341
+ /** Collection title. */
340
342
  title?: string | null;
341
- /** Description of Collection */
343
+ /** Collection description. */
342
344
  description?: string | null;
343
- /** Url of Collection */
345
+ /** Collection slug. */
344
346
  slug?: string | null;
345
- /** Collection's cover photo */
347
+ /** Collection cover image. */
346
348
  coverImage?: Image$6;
347
- /** Indicates if the collection is hidden from Portfolio */
349
+ /** Whether the collection is hidden from the portfolio. */
348
350
  hidden?: boolean | null;
349
- /** if not present in an update it means the collection will be added as currentTimestamp - as the last collection */
351
+ /**
352
+ * Index that determines which position a media item is displayed in the gallery. <br />
353
+ *
354
+ * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
355
+ */
350
356
  sortOrder?: number | null;
351
357
  /**
352
- * Represents the time this Collection was created
358
+ * Date and time the collection was created.
353
359
  * @readonly
354
360
  */
355
361
  _createdDate?: Date;
356
362
  /**
357
- * Represents the time this Collection was last updated
363
+ * Date and time the collection was updated.
358
364
  * @readonly
359
365
  */
360
366
  _updatedDate?: Date;
361
367
  /**
362
- * Url and relative url of Collection - in order to receive this field in READ requests you will need to pass the `include_page_url` field as part of request
368
+ * Collection's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
363
369
  * @readonly
364
370
  */
365
371
  url?: string;
366
- /** SEO data for Collection */
372
+ /** Collection SEO data. */
367
373
  seoData?: SeoSchema$4;
368
374
  }
369
375
  interface Image$6 {
370
- /** Image info - Wix Media Image. */
376
+ /** Information about the Wix Media image. */
371
377
  imageInfo?: string;
372
378
  /** Focal point of the image. */
373
379
  focalPoint?: Point$6;
@@ -436,27 +442,27 @@ interface Settings$4 {
436
442
  keywords?: Keyword$4[];
437
443
  }
438
444
  interface CreateCollectionRequest {
439
- /** Collection to be created */
445
+ /** Collection to create. */
440
446
  collection: Collection;
441
447
  }
442
448
  interface CreateCollectionResponse {
443
- /** The created Collection */
449
+ /** Created collection. */
444
450
  collection?: Collection;
445
451
  }
446
452
  interface GetCollectionRequest {
447
- /** Id of the Collection to retrieve */
453
+ /** ID of the collection to retrieve. */
448
454
  collectionId: string;
449
- /** Include page url */
455
+ /** Whether to include the collection's page URL and relative path in the response. */
450
456
  includePageUrl?: boolean | null;
451
457
  }
452
458
  interface GetCollectionResponse {
453
- /** The retrieved Collection */
459
+ /** The requested collection. */
454
460
  collection?: Collection;
455
461
  }
456
462
  interface ListCollectionsRequest {
457
- /** Maximum limit per response is 100, in first request cursor is None */
463
+ /** Maximum limit per response is 100, in first request cursor is None ? */
458
464
  paging?: CursorPaging$6;
459
- /** Include page url */
465
+ /** Whether to include the collection's page URL and relative path in the response. */
460
466
  includePageUrl?: boolean | null;
461
467
  }
462
468
  interface CursorPaging$6 {
@@ -471,9 +477,9 @@ interface CursorPaging$6 {
471
477
  cursor?: string | null;
472
478
  }
473
479
  interface ListCollectionsResponse {
474
- /** Retrieved Collections */
480
+ /** List of collections. */
475
481
  collections?: Collection[];
476
- /** Paging metadata */
482
+ /** Paging metadata. */
477
483
  metadata?: PagingMetadataV2$8;
478
484
  }
479
485
  interface PagingMetadataV2$8 {
@@ -495,25 +501,25 @@ interface Cursors$8 {
495
501
  prev?: string | null;
496
502
  }
497
503
  interface UpdateCollectionRequest {
498
- /** Collection to be updated, may be partial */
504
+ /** Collection to update. */
499
505
  collection: Collection;
500
506
  }
501
507
  interface UpdateCollectionResponse {
502
- /** The updated Collection */
508
+ /** Updated collection. */
503
509
  collection?: Collection;
504
510
  }
505
511
  interface DeleteCollectionRequest {
506
- /** Id of the Collection to delete */
512
+ /** ID of the collection to delete. */
507
513
  collectionId: string;
508
514
  }
509
515
  interface DeleteCollectionResponse {
510
- /** Id of the Deleted Collection */
516
+ /** ID of the deleted collection. */
511
517
  collectionId?: string;
512
518
  }
513
519
  interface QueryCollectionsRequest {
514
- /** WQL expression */
520
+ /** Query options. */
515
521
  query: QueryV2$4;
516
- /** Include page url */
522
+ /** Whether to include the collection's page URL and relative path in the response. */
517
523
  includePageUrl?: boolean | null;
518
524
  }
519
525
  interface QueryV2$4 extends QueryV2PagingMethodOneOf$4 {
@@ -562,9 +568,9 @@ interface Paging$6 {
562
568
  offset?: number | null;
563
569
  }
564
570
  interface QueryCollectionsResponse {
565
- /** The retrieved Collections */
571
+ /** List of collections. */
566
572
  collections?: Collection[];
567
- /** Paging metadata */
573
+ /** Paging metadata. */
568
574
  metadata?: PagingMetadataV2$8;
569
575
  }
570
576
  interface PointNonNullableFields$6 {
@@ -653,35 +659,34 @@ declare namespace meta$5 {
653
659
 
654
660
  interface PortfolioSettings$1 {
655
661
  /**
656
- * The revision of the portfolio settings
662
+ * Revision number. Increments by 1 each time the portfolio settings object is updated. To prevent conflicting changes, the existing revision must be passed when updating the portfolio settings object.
657
663
  * @readonly
658
664
  */
659
665
  revision?: string | null;
660
- /** The project item settings */
666
+ /** Portfolio's project item settings. */
661
667
  projectItemSettings?: ProjectItemSettings$1;
662
- /** The media settings */
668
+ /** Portfolio's media settings. */
663
669
  mediaSettings?: MediaSettings$1;
664
670
  /**
665
- * Represents the time this Collection was created
671
+ * Date and time the portfolio settings were created.
666
672
  * @readonly
667
673
  */
668
674
  createdDate?: Date;
669
675
  /**
670
- * Represents the time this Collection was last updated
676
+ * Date and time the portfolio settings were updated.
671
677
  * @readonly
672
678
  */
673
679
  updatedDate?: Date;
674
680
  }
675
681
  interface ProjectItemSettings$1 {
676
- /** The direction to add items */
677
682
  addItemDirection?: AddItemDirection$1;
678
- /** The default item name */
683
+ /** The default item name ? */
679
684
  defaultItemName?: DefaultItemName$1;
680
685
  }
681
686
  declare enum AddItemDirection$1 {
682
- /** Add items to the start of the gallery */
687
+ /** Add new items to the start of the gallery. */
683
688
  GALLERY_START = "GALLERY_START",
684
- /** Add items to the end of the gallery */
689
+ /** Add new items to the end of the gallery. */
685
690
  GALLERY_END = "GALLERY_END"
686
691
  }
687
692
  declare enum DefaultItemName$1 {
@@ -695,25 +700,25 @@ interface MediaSettings$1 {
695
700
  folderId?: string | null;
696
701
  }
697
702
  interface CreatePortfolioSettingsRequest$1 {
698
- /** The portfolio settings to create */
703
+ /** The portfolio settings to create. */
699
704
  portfolioSettings: PortfolioSettings$1;
700
705
  }
701
706
  interface CreatePortfolioSettingsResponse$1 {
702
- /** The created portfolio settings */
707
+ /** Newly created portfolio settings. */
703
708
  portfolioSettings?: PortfolioSettings$1;
704
709
  }
705
710
  interface GetPortfolioSettingsRequest$1 {
706
711
  }
707
712
  interface GetPortfolioSettingsResponse$1 {
708
- /** The portfolio settings */
713
+ /** Portfolio settings. */
709
714
  portfolioSettings?: PortfolioSettings$1;
710
715
  }
711
716
  interface UpdatePortfolioSettingsRequest$1 {
712
- /** The portfolio settings to update */
717
+ /** The portfolio settings to update. */
713
718
  portfolioSettings: PortfolioSettings$1;
714
719
  }
715
720
  interface UpdatePortfolioSettingsResponse$1 {
716
- /** The updated portfolio settings */
721
+ /** Updated portfolio settings. */
717
722
  updatedPortfolioSettings?: PortfolioSettings$1;
718
723
  }
719
724
  interface ProjectItemSettingsNonNullableFields$1 {
@@ -735,35 +740,34 @@ interface UpdatePortfolioSettingsResponseNonNullableFields$1 {
735
740
 
736
741
  interface PortfolioSettings {
737
742
  /**
738
- * The revision of the portfolio settings
743
+ * Revision number. Increments by 1 each time the portfolio settings object is updated. To prevent conflicting changes, the existing revision must be passed when updating the portfolio settings object.
739
744
  * @readonly
740
745
  */
741
746
  revision?: string | null;
742
- /** The project item settings */
747
+ /** Portfolio's project item settings. */
743
748
  projectItemSettings?: ProjectItemSettings;
744
- /** The media settings */
749
+ /** Portfolio's media settings. */
745
750
  mediaSettings?: MediaSettings;
746
751
  /**
747
- * Represents the time this Collection was created
752
+ * Date and time the portfolio settings were created.
748
753
  * @readonly
749
754
  */
750
755
  _createdDate?: Date;
751
756
  /**
752
- * Represents the time this Collection was last updated
757
+ * Date and time the portfolio settings were updated.
753
758
  * @readonly
754
759
  */
755
760
  _updatedDate?: Date;
756
761
  }
757
762
  interface ProjectItemSettings {
758
- /** The direction to add items */
759
763
  addItemDirection?: AddItemDirection;
760
- /** The default item name */
764
+ /** The default item name ? */
761
765
  defaultItemName?: DefaultItemName;
762
766
  }
763
767
  declare enum AddItemDirection {
764
- /** Add items to the start of the gallery */
768
+ /** Add new items to the start of the gallery. */
765
769
  GALLERY_START = "GALLERY_START",
766
- /** Add items to the end of the gallery */
770
+ /** Add new items to the end of the gallery. */
767
771
  GALLERY_END = "GALLERY_END"
768
772
  }
769
773
  declare enum DefaultItemName {
@@ -777,25 +781,25 @@ interface MediaSettings {
777
781
  folderId?: string | null;
778
782
  }
779
783
  interface CreatePortfolioSettingsRequest {
780
- /** The portfolio settings to create */
784
+ /** The portfolio settings to create. */
781
785
  portfolioSettings: PortfolioSettings;
782
786
  }
783
787
  interface CreatePortfolioSettingsResponse {
784
- /** The created portfolio settings */
788
+ /** Newly created portfolio settings. */
785
789
  portfolioSettings?: PortfolioSettings;
786
790
  }
787
791
  interface GetPortfolioSettingsRequest {
788
792
  }
789
793
  interface GetPortfolioSettingsResponse {
790
- /** The portfolio settings */
794
+ /** Portfolio settings. */
791
795
  portfolioSettings?: PortfolioSettings;
792
796
  }
793
797
  interface UpdatePortfolioSettingsRequest {
794
- /** The portfolio settings to update */
798
+ /** The portfolio settings to update. */
795
799
  portfolioSettings: PortfolioSettings;
796
800
  }
797
801
  interface UpdatePortfolioSettingsResponse {
798
- /** The updated portfolio settings */
802
+ /** Updated portfolio settings. */
799
803
  updatedPortfolioSettings?: PortfolioSettings;
800
804
  }
801
805
  interface ProjectItemSettingsNonNullableFields {
@@ -838,14 +842,11 @@ declare namespace meta$4 {
838
842
 
839
843
  /** ProjectItem is the main entity of ProjectItemsService */
840
844
  interface Item$1 extends ItemMetadataOneOf$1 {
841
- /** Information about the image. */
845
+ /** Information about the Wix Media image. */
842
846
  image?: Image$5;
843
- /** Information about the video. */
847
+ /** Information about the Wix Media video. */
844
848
  video?: Video$5;
845
- /**
846
- * Id of the Project the items are part of
847
- * Project must exist before adding items to it. You can create a project using the [ProjectService](https://dev.wix.com/docs/rest/business-solutions/portfolio/project)
848
- */
849
+ /** Project ID. */
849
850
  projectId?: string | null;
850
851
  /**
851
852
  * Item ID.
@@ -853,7 +854,7 @@ interface Item$1 extends ItemMetadataOneOf$1 {
853
854
  */
854
855
  id?: string | null;
855
856
  /**
856
- * Index that determines which position a media item is displayed in the gallery. <br />
857
+ * Sort order of the project item within the specified project. <br />
857
858
  *
858
859
  * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
859
860
  */
@@ -881,14 +882,14 @@ interface Item$1 extends ItemMetadataOneOf$1 {
881
882
  * @readonly
882
883
  */
883
884
  updatedDate?: Date;
884
- /** Link from the item. */
885
+ /** Project item link. */
885
886
  link?: Link$1;
886
887
  }
887
888
  /** @oneof */
888
889
  interface ItemMetadataOneOf$1 {
889
- /** Information about the image. */
890
+ /** Information about the Wix Media image. */
890
891
  image?: Image$5;
891
- /** Information about the video. */
892
+ /** Information about the Wix Media video. */
892
893
  video?: Video$5;
893
894
  }
894
895
  declare enum Type$1 {
@@ -900,7 +901,7 @@ declare enum Type$1 {
900
901
  VIDEO = "VIDEO"
901
902
  }
902
903
  interface Image$5 {
903
- /** Image info - Wix Media Image. */
904
+ /** Information about the Wix Media image. */
904
905
  imageInfo?: CommonImage$2;
905
906
  /** Focal point of the image. */
906
907
  focalPoint?: Point$5;
@@ -934,7 +935,7 @@ interface Point$5 {
934
935
  y?: number;
935
936
  }
936
937
  interface Video$5 {
937
- /** Video info - Wix Media Image. */
938
+ /** Information about the Wix Media video. */
938
939
  videoInfo?: VideoV2$2;
939
940
  /** Manually defined Video duration in milliseconds. */
940
941
  durationInMillis?: number | null;
@@ -978,28 +979,29 @@ interface Link$1 {
978
979
  target?: string | null;
979
980
  }
980
981
  interface CreateProjectItemRequest$1 {
981
- /** Item to be created */
982
+ /** Project item to create. */
982
983
  item: Item$1;
983
984
  }
984
985
  interface CreateProjectItemResponse$1 {
985
- /** The created item */
986
+ /** Newly created project item. */
986
987
  item?: Item$1;
987
988
  }
988
989
  interface BulkCreateProjectItemsRequest$1 {
989
- /** items to be created. */
990
+ /** Project items to create. */
990
991
  items: Item$1[];
992
+ /** Whether to include the created project items in the response. Set to `true` to receive the project items in the response. */
991
993
  returnFullEntity?: boolean | null;
992
994
  }
993
995
  interface BulkCreateProjectItemsResponse$1 {
994
- /** Array with all created items results. */
996
+ /** Project items created by bulk action. */
995
997
  results?: BulkCreateProjectItemResult$1[];
996
- /** Holds metadata of the entire bulk create operation */
998
+ /** Bulk action metadata. */
997
999
  bulkActionMetadata?: BulkActionMetadata$3;
998
1000
  }
999
1001
  interface BulkCreateProjectItemResult$1 {
1000
- /** Holds information about an item in bulk create - id, index in original request array, action successful, error (if failed) */
1002
+ /** Information about successful action or error for failure. */
1001
1003
  itemMetadata?: ItemMetadata$3;
1002
- /** Created item */
1004
+ /** Newly created project item. */
1003
1005
  item?: Item$1;
1004
1006
  }
1005
1007
  interface ItemMetadata$3 {
@@ -1029,17 +1031,17 @@ interface BulkActionMetadata$3 {
1029
1031
  undetailedFailures?: number;
1030
1032
  }
1031
1033
  interface GetProjectItemRequest$1 {
1032
- /** Id of the ProjectItem to retrieve */
1034
+ /** Project item ID. */
1033
1035
  itemId: string;
1034
1036
  }
1035
1037
  interface GetProjectItemResponse$1 {
1036
- /** The retrieved ProjectItem */
1038
+ /** Project item. */
1037
1039
  item?: Item$1;
1038
1040
  }
1039
1041
  interface ListProjectItemsRequest$1 {
1040
- /** Id of the Project the item is part of */
1042
+ /** Project ID. */
1041
1043
  projectId: string;
1042
- /** limit and offset for ProjectItems - maximum limit is 200 per request, default is 50 */
1044
+ /** Maximum number of items to return in the results. */
1043
1045
  paging?: Paging$5;
1044
1046
  }
1045
1047
  interface Paging$5 {
@@ -1049,14 +1051,14 @@ interface Paging$5 {
1049
1051
  offset?: number | null;
1050
1052
  }
1051
1053
  interface ListProjectItemsResponse$1 {
1052
- /** ProjectItems retrieved */
1054
+ /** Project items. */
1053
1055
  items?: Item$1[];
1054
1056
  /**
1055
- * Paging metadata
1057
+ * Paging metadata.
1056
1058
  * @deprecated
1057
1059
  */
1058
1060
  pagingMetadataV2?: PagingMetadataV2$7;
1059
- /** Paging metadata */
1061
+ /** Paging metadata. */
1060
1062
  metadata?: PagingMetadataV2$7;
1061
1063
  }
1062
1064
  interface PagingMetadataV2$7 {
@@ -1078,17 +1080,17 @@ interface Cursors$7 {
1078
1080
  prev?: string | null;
1079
1081
  }
1080
1082
  interface UpdateProjectItemRequest$1 {
1081
- /** ProjectItem to be updated, may be partial */
1083
+ /** The project item to update. */
1082
1084
  item: Item$1;
1083
1085
  }
1084
1086
  interface UpdateProjectItemResponse$1 {
1085
- /** The updated ProjectItem */
1087
+ /** The updated project item. */
1086
1088
  item?: Item$1;
1087
1089
  }
1088
1090
  interface BulkUpdateProjectItemsRequest$1 {
1089
1091
  /** items to be updated. */
1090
1092
  items?: MaskedItem$1[];
1091
- /** Return full entity after update */
1093
+ /** Whether to include the updated project items in the response. Set to `true` to receive the project items in the response. */
1092
1094
  returnFullEntity?: boolean | null;
1093
1095
  }
1094
1096
  interface MaskedItem$1 {
@@ -1096,53 +1098,53 @@ interface MaskedItem$1 {
1096
1098
  item?: Item$1;
1097
1099
  }
1098
1100
  interface BulkUpdateProjectItemsResponse$1 {
1099
- /** Array with all updated items results. */
1101
+ /** Project items updated by bulk action. */
1100
1102
  results?: BulkUpdateProjectItemResult$1[];
1101
- /** Holds metadata of the entire bulk update operation */
1103
+ /** Bulk action metadata. */
1102
1104
  bulkActionMetadata?: BulkActionMetadata$3;
1103
1105
  }
1104
1106
  interface BulkUpdateProjectItemResult$1 {
1105
- /** Holds information about an item in bulk update - id, index in original request array, action successful, error (if failed). */
1107
+ /** Information about successful action or error for failure. */
1106
1108
  itemMetadata?: ItemMetadata$3;
1107
- /** Updated item */
1109
+ /** Updated project item. */
1108
1110
  item?: Item$1;
1109
1111
  }
1110
1112
  interface DeleteProjectItemRequest$1 {
1111
- /** Id of the Item to delete */
1113
+ /** ID of the project item to delete. */
1112
1114
  itemId: string;
1113
1115
  }
1114
1116
  interface DeleteProjectItemResponse$1 {
1115
- /** Id of the Project the item is part of */
1117
+ /** Project ID. */
1116
1118
  projectId?: string;
1117
- /** Id of deleted item */
1119
+ /** ID of the deleted project item. */
1118
1120
  itemId?: string;
1119
1121
  }
1120
1122
  interface BulkDeleteProjectItemsRequest$1 {
1121
- /** Ids of the items to be deleted */
1123
+ /** Project item IDs. */
1122
1124
  itemIds: string[];
1123
1125
  }
1124
1126
  interface BulkDeleteProjectItemsResponse$1 {
1125
- /** Array with all deleted items results */
1127
+ /** Project items deleted by bulk action. */
1126
1128
  results?: BulkDeleteProjectItemResult$1[];
1127
- /** Holds metadata of the entire bulk delete operation */
1129
+ /** Bulk action metadata. */
1128
1130
  bulkActionMetadata?: BulkActionMetadata$3;
1129
1131
  }
1130
1132
  interface BulkDeleteProjectItemResult$1 {
1131
- /** Holds information about an item in bulk delete - id, index in original request array, action successful, error (if failed) */
1133
+ /** Information about successful action or error for failure. */
1132
1134
  itemMetadata?: ItemMetadata$3;
1133
- /** Id of the ProjectItem */
1135
+ /** Project item ID. */
1134
1136
  itemId?: string;
1135
1137
  }
1136
1138
  interface DuplicateProjectItemsRequest$1 {
1137
- /** Id of Project to duplicate */
1139
+ /** ID of the project containing the items to duplicate. */
1138
1140
  originProjectId: string;
1139
- /** Target project ID to duplicate to (same instance as request) */
1141
+ /** ID of the project where the duplicated items will be added. */
1140
1142
  targetProjectId: string;
1141
1143
  }
1142
1144
  interface DuplicateProjectItemsResponse$1 {
1143
- /** Id of target project */
1145
+ /** Project ID where the duplicated items have been added. */
1144
1146
  projectId?: string;
1145
- /** Result metadata */
1147
+ /** Bulk action metadata. */
1146
1148
  bulkActionMetadata?: BulkActionMetadata$3;
1147
1149
  }
1148
1150
  interface CommonImageNonNullableFields$2 {
@@ -1253,14 +1255,11 @@ interface DuplicateProjectItemsResponseNonNullableFields$1 {
1253
1255
 
1254
1256
  /** ProjectItem is the main entity of ProjectItemsService */
1255
1257
  interface Item extends ItemMetadataOneOf {
1256
- /** Information about the image. */
1258
+ /** Information about the Wix Media image. */
1257
1259
  image?: Image$4;
1258
- /** Information about the video. */
1260
+ /** Information about the Wix Media video. */
1259
1261
  video?: Video$4;
1260
- /**
1261
- * Id of the Project the items are part of
1262
- * Project must exist before adding items to it. You can create a project using the [ProjectService](https://dev.wix.com/docs/rest/business-solutions/portfolio/project)
1263
- */
1262
+ /** Project ID. */
1264
1263
  projectId?: string | null;
1265
1264
  /**
1266
1265
  * Item ID.
@@ -1268,7 +1267,7 @@ interface Item extends ItemMetadataOneOf {
1268
1267
  */
1269
1268
  _id?: string | null;
1270
1269
  /**
1271
- * Index that determines which position a media item is displayed in the gallery. <br />
1270
+ * Sort order of the project item within the specified project. <br />
1272
1271
  *
1273
1272
  * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
1274
1273
  */
@@ -1296,14 +1295,14 @@ interface Item extends ItemMetadataOneOf {
1296
1295
  * @readonly
1297
1296
  */
1298
1297
  _updatedDate?: Date;
1299
- /** Link from the item. */
1298
+ /** Project item link. */
1300
1299
  link?: Link;
1301
1300
  }
1302
1301
  /** @oneof */
1303
1302
  interface ItemMetadataOneOf {
1304
- /** Information about the image. */
1303
+ /** Information about the Wix Media image. */
1305
1304
  image?: Image$4;
1306
- /** Information about the video. */
1305
+ /** Information about the Wix Media video. */
1307
1306
  video?: Video$4;
1308
1307
  }
1309
1308
  declare enum Type {
@@ -1315,7 +1314,7 @@ declare enum Type {
1315
1314
  VIDEO = "VIDEO"
1316
1315
  }
1317
1316
  interface Image$4 {
1318
- /** Image info - Wix Media Image. */
1317
+ /** Information about the Wix Media image. */
1319
1318
  imageInfo?: string;
1320
1319
  /** Focal point of the image. */
1321
1320
  focalPoint?: Point$4;
@@ -1332,7 +1331,7 @@ interface Point$4 {
1332
1331
  y?: number;
1333
1332
  }
1334
1333
  interface Video$4 {
1335
- /** Video info - Wix Media Image. */
1334
+ /** Information about the Wix Media video. */
1336
1335
  videoInfo?: string;
1337
1336
  /** Manually defined Video duration in milliseconds. */
1338
1337
  durationInMillis?: number | null;
@@ -1350,28 +1349,29 @@ interface Link {
1350
1349
  target?: string | null;
1351
1350
  }
1352
1351
  interface CreateProjectItemRequest {
1353
- /** Item to be created */
1352
+ /** Project item to create. */
1354
1353
  item: Item;
1355
1354
  }
1356
1355
  interface CreateProjectItemResponse {
1357
- /** The created item */
1356
+ /** Newly created project item. */
1358
1357
  item?: Item;
1359
1358
  }
1360
1359
  interface BulkCreateProjectItemsRequest {
1361
- /** items to be created. */
1360
+ /** Project items to create. */
1362
1361
  items: Item[];
1362
+ /** Whether to include the created project items in the response. Set to `true` to receive the project items in the response. */
1363
1363
  returnFullEntity?: boolean | null;
1364
1364
  }
1365
1365
  interface BulkCreateProjectItemsResponse {
1366
- /** Array with all created items results. */
1366
+ /** Project items created by bulk action. */
1367
1367
  results?: BulkCreateProjectItemResult[];
1368
- /** Holds metadata of the entire bulk create operation */
1368
+ /** Bulk action metadata. */
1369
1369
  bulkActionMetadata?: BulkActionMetadata$2;
1370
1370
  }
1371
1371
  interface BulkCreateProjectItemResult {
1372
- /** Holds information about an item in bulk create - id, index in original request array, action successful, error (if failed) */
1372
+ /** Information about successful action or error for failure. */
1373
1373
  itemMetadata?: ItemMetadata$2;
1374
- /** Created item */
1374
+ /** Newly created project item. */
1375
1375
  item?: Item;
1376
1376
  }
1377
1377
  interface ItemMetadata$2 {
@@ -1401,17 +1401,17 @@ interface BulkActionMetadata$2 {
1401
1401
  undetailedFailures?: number;
1402
1402
  }
1403
1403
  interface GetProjectItemRequest {
1404
- /** Id of the ProjectItem to retrieve */
1404
+ /** Project item ID. */
1405
1405
  itemId: string;
1406
1406
  }
1407
1407
  interface GetProjectItemResponse {
1408
- /** The retrieved ProjectItem */
1408
+ /** Project item. */
1409
1409
  item?: Item;
1410
1410
  }
1411
1411
  interface ListProjectItemsRequest {
1412
- /** Id of the Project the item is part of */
1412
+ /** Project ID. */
1413
1413
  projectId: string;
1414
- /** limit and offset for ProjectItems - maximum limit is 200 per request, default is 50 */
1414
+ /** Maximum number of items to return in the results. */
1415
1415
  paging?: Paging$4;
1416
1416
  }
1417
1417
  interface Paging$4 {
@@ -1421,14 +1421,14 @@ interface Paging$4 {
1421
1421
  offset?: number | null;
1422
1422
  }
1423
1423
  interface ListProjectItemsResponse {
1424
- /** ProjectItems retrieved */
1424
+ /** Project items. */
1425
1425
  items?: Item[];
1426
1426
  /**
1427
- * Paging metadata
1427
+ * Paging metadata.
1428
1428
  * @deprecated
1429
1429
  */
1430
1430
  pagingMetadataV2?: PagingMetadataV2$6;
1431
- /** Paging metadata */
1431
+ /** Paging metadata. */
1432
1432
  metadata?: PagingMetadataV2$6;
1433
1433
  }
1434
1434
  interface PagingMetadataV2$6 {
@@ -1450,17 +1450,17 @@ interface Cursors$6 {
1450
1450
  prev?: string | null;
1451
1451
  }
1452
1452
  interface UpdateProjectItemRequest {
1453
- /** ProjectItem to be updated, may be partial */
1453
+ /** The project item to update. */
1454
1454
  item: Item;
1455
1455
  }
1456
1456
  interface UpdateProjectItemResponse {
1457
- /** The updated ProjectItem */
1457
+ /** The updated project item. */
1458
1458
  item?: Item;
1459
1459
  }
1460
1460
  interface BulkUpdateProjectItemsRequest {
1461
1461
  /** items to be updated. */
1462
1462
  items?: MaskedItem[];
1463
- /** Return full entity after update */
1463
+ /** Whether to include the updated project items in the response. Set to `true` to receive the project items in the response. */
1464
1464
  returnFullEntity?: boolean | null;
1465
1465
  }
1466
1466
  interface MaskedItem {
@@ -1468,53 +1468,53 @@ interface MaskedItem {
1468
1468
  item?: Item;
1469
1469
  }
1470
1470
  interface BulkUpdateProjectItemsResponse {
1471
- /** Array with all updated items results. */
1471
+ /** Project items updated by bulk action. */
1472
1472
  results?: BulkUpdateProjectItemResult[];
1473
- /** Holds metadata of the entire bulk update operation */
1473
+ /** Bulk action metadata. */
1474
1474
  bulkActionMetadata?: BulkActionMetadata$2;
1475
1475
  }
1476
1476
  interface BulkUpdateProjectItemResult {
1477
- /** Holds information about an item in bulk update - id, index in original request array, action successful, error (if failed). */
1477
+ /** Information about successful action or error for failure. */
1478
1478
  itemMetadata?: ItemMetadata$2;
1479
- /** Updated item */
1479
+ /** Updated project item. */
1480
1480
  item?: Item;
1481
1481
  }
1482
1482
  interface DeleteProjectItemRequest {
1483
- /** Id of the Item to delete */
1483
+ /** ID of the project item to delete. */
1484
1484
  itemId: string;
1485
1485
  }
1486
1486
  interface DeleteProjectItemResponse {
1487
- /** Id of the Project the item is part of */
1487
+ /** Project ID. */
1488
1488
  projectId?: string;
1489
- /** Id of deleted item */
1489
+ /** ID of the deleted project item. */
1490
1490
  itemId?: string;
1491
1491
  }
1492
1492
  interface BulkDeleteProjectItemsRequest {
1493
- /** Ids of the items to be deleted */
1493
+ /** Project item IDs. */
1494
1494
  itemIds: string[];
1495
1495
  }
1496
1496
  interface BulkDeleteProjectItemsResponse {
1497
- /** Array with all deleted items results */
1497
+ /** Project items deleted by bulk action. */
1498
1498
  results?: BulkDeleteProjectItemResult[];
1499
- /** Holds metadata of the entire bulk delete operation */
1499
+ /** Bulk action metadata. */
1500
1500
  bulkActionMetadata?: BulkActionMetadata$2;
1501
1501
  }
1502
1502
  interface BulkDeleteProjectItemResult {
1503
- /** Holds information about an item in bulk delete - id, index in original request array, action successful, error (if failed) */
1503
+ /** Information about successful action or error for failure. */
1504
1504
  itemMetadata?: ItemMetadata$2;
1505
- /** Id of the ProjectItem */
1505
+ /** Project item ID. */
1506
1506
  itemId?: string;
1507
1507
  }
1508
1508
  interface DuplicateProjectItemsRequest {
1509
- /** Id of Project to duplicate */
1509
+ /** ID of the project containing the items to duplicate. */
1510
1510
  originProjectId: string;
1511
- /** Target project ID to duplicate to (same instance as request) */
1511
+ /** ID of the project where the duplicated items will be added. */
1512
1512
  targetProjectId: string;
1513
1513
  }
1514
1514
  interface DuplicateProjectItemsResponse {
1515
- /** Id of target project */
1515
+ /** Project ID where the duplicated items have been added. */
1516
1516
  projectId?: string;
1517
- /** Result metadata */
1517
+ /** Bulk action metadata. */
1518
1518
  bulkActionMetadata?: BulkActionMetadata$2;
1519
1519
  }
1520
1520
  interface PointNonNullableFields$4 {
@@ -1645,59 +1645,60 @@ declare namespace meta$3 {
1645
1645
  export { type __PublicMethodMetaInfo$3 as __PublicMethodMetaInfo, meta$3_bulkCreateProjectItems as bulkCreateProjectItems, meta$3_bulkDeleteProjectItems as bulkDeleteProjectItems, meta$3_bulkUpdateProjectItems as bulkUpdateProjectItems, meta$3_createProjectItem as createProjectItem, meta$3_deleteProjectItem as deleteProjectItem, meta$3_duplicateProjectItems as duplicateProjectItems, meta$3_getProjectItem as getProjectItem, meta$3_listProjectItems as listProjectItems, meta$3_updateProjectItem as updateProjectItem };
1646
1646
  }
1647
1647
 
1648
- /** Project is the main entity of ProjectsService */
1649
1648
  interface Project$3 extends ProjectCoverOneOf$3 {
1650
- /** project's cover photo */
1649
+ /** Project cover image. */
1651
1650
  coverImage?: Image$3;
1652
- /** project's cover video */
1651
+ /** Project cover video. */
1653
1652
  coverVideo?: Video$3;
1654
1653
  /**
1655
- * Project ID
1654
+ * Project ID.
1656
1655
  * @readonly
1657
1656
  */
1658
1657
  id?: string | null;
1659
1658
  /**
1660
- * 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
1659
+ * Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object.
1661
1660
  * @readonly
1662
1661
  */
1663
1662
  revision?: string | null;
1663
+ /** Project title. */
1664
1664
  title?: string | null;
1665
+ /** Project description. */
1665
1666
  description?: string | null;
1666
- /** indicates if the project should be hidden from Portfolio */
1667
+ /** Whether the project is hidden from the portfolio. */
1667
1668
  hidden?: boolean | null;
1668
- /** Collections must exist to be added to a project. Can be created/updated/deleted using [Collection Service](https://dev.wix.com/docs/rest/business-solutions/portfolio/collection) */
1669
+ /** IDs of the collections that include the project. */
1669
1670
  collectionIds?: string[];
1670
- /** Custom project details */
1671
+ /** Project details. */
1671
1672
  details?: ProjectDetail$3[];
1672
- /** Project's slug */
1673
+ /** Project slug. */
1673
1674
  slug?: string | null;
1674
1675
  /**
1675
- * Represents the time this Project was created
1676
+ * Date and time the project was created.
1676
1677
  * @readonly
1677
1678
  */
1678
1679
  createdDate?: Date;
1679
1680
  /**
1680
- * Represents the time this Project was last updated
1681
+ * Date and time the project was updated.
1681
1682
  * @readonly
1682
1683
  */
1683
1684
  updatedDate?: Date;
1684
1685
  /**
1685
- * Url and relative url of Project - in order to receive this field in READ requests you will need to pass the `include_page_url` field as part of request
1686
+ * Project's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
1686
1687
  * @readonly
1687
1688
  */
1688
1689
  url?: PageUrlV2$1;
1689
- /** SEO data for the project */
1690
+ /** Project SEO data. */
1690
1691
  seoData?: SeoSchema$3;
1691
1692
  }
1692
1693
  /** @oneof */
1693
1694
  interface ProjectCoverOneOf$3 {
1694
- /** project's cover photo */
1695
+ /** Project cover image. */
1695
1696
  coverImage?: Image$3;
1696
- /** project's cover video */
1697
+ /** Project cover video. */
1697
1698
  coverVideo?: Video$3;
1698
1699
  }
1699
1700
  interface Image$3 {
1700
- /** Image info - Wix Media Image. */
1701
+ /** Information about the Wix Media image. */
1701
1702
  imageInfo?: CommonImage$1;
1702
1703
  /** Focal point of the image. */
1703
1704
  focalPoint?: Point$3;
@@ -1731,7 +1732,7 @@ interface Point$3 {
1731
1732
  y?: number;
1732
1733
  }
1733
1734
  interface Video$3 {
1734
- /** Video info - Wix Media Image. */
1735
+ /** Information about the Wix Media video. */
1735
1736
  videoInfo?: VideoV2$1;
1736
1737
  /** Manually defined Video duration in milliseconds. */
1737
1738
  durationInMillis?: number | null;
@@ -1762,21 +1763,30 @@ interface VideoResolution$1 {
1762
1763
  /** Video filename. */
1763
1764
  filename?: string | null;
1764
1765
  }
1766
+ /**
1767
+ * Project label.
1768
+ * One of:
1769
+ * + `text`
1770
+ * + `link`
1771
+ */
1765
1772
  interface ProjectDetail$3 extends ProjectDetailValueOneOf$3 {
1773
+ /** Project label in plain text format. */
1766
1774
  text?: string;
1767
- /** Details link */
1775
+ /** Project label in link format. */
1768
1776
  link?: DetailsLink$3;
1769
1777
  label?: string;
1770
1778
  }
1771
1779
  /** @oneof */
1772
1780
  interface ProjectDetailValueOneOf$3 {
1781
+ /** Project label in plain text format. */
1773
1782
  text?: string;
1774
- /** Details link */
1783
+ /** Project label in link format. */
1775
1784
  link?: DetailsLink$3;
1776
1785
  }
1777
1786
  interface DetailsLink$3 {
1787
+ /** Display text of the link. */
1778
1788
  text?: string | null;
1779
- /** link to external source */
1789
+ /** Target URL of the link. */
1780
1790
  url?: string | null;
1781
1791
  /**
1782
1792
  * Whether the link opens in a new tab or window. One of:
@@ -1869,27 +1879,27 @@ interface ProjectSlug$1 {
1869
1879
  slug?: string;
1870
1880
  }
1871
1881
  interface CreateProjectRequest$1 {
1872
- /** Project to be created */
1882
+ /** Project to create. */
1873
1883
  project: Project$3;
1874
1884
  }
1875
1885
  interface CreateProjectResponse$1 {
1876
- /** The created Project */
1886
+ /** Created project. */
1877
1887
  project?: Project$3;
1878
1888
  }
1879
1889
  interface GetProjectRequest$1 {
1880
- /** Id of the Project to retrieve */
1890
+ /** ID of the project to retrieve. */
1881
1891
  projectId: string;
1882
1892
  /** Include page url */
1883
1893
  includePageUrl?: boolean | null;
1884
1894
  }
1885
1895
  interface GetProjectResponse$1 {
1886
- /** The retrieved Project */
1896
+ /** The requested project. */
1887
1897
  project?: Project$3;
1888
1898
  }
1889
1899
  interface ListProjectsRequest$1 {
1890
- /** Projects limit per response is maximum 100, In the first request the cursor is None */
1900
+ /** Projects limit per response is maximum 100, In the first request the cursor is None ? */
1891
1901
  paging?: CursorPaging$5;
1892
- /** Include page url */
1902
+ /** Include page url ? */
1893
1903
  includePageUrl?: boolean | null;
1894
1904
  }
1895
1905
  interface CursorPaging$5 {
@@ -1904,9 +1914,9 @@ interface CursorPaging$5 {
1904
1914
  cursor?: string | null;
1905
1915
  }
1906
1916
  interface ListProjectsResponse$1 {
1907
- /** The retrieved Projects */
1917
+ /** List of projects. */
1908
1918
  projects?: Project$3[];
1909
- /** Paging metadata */
1919
+ /** Paging metadata ? */
1910
1920
  metadata?: PagingMetadataV2$5;
1911
1921
  }
1912
1922
  interface PagingMetadataV2$5 {
@@ -1928,33 +1938,33 @@ interface Cursors$5 {
1928
1938
  prev?: string | null;
1929
1939
  }
1930
1940
  interface UpdateProjectRequest$1 {
1931
- /** Project to be updated, may be partial */
1941
+ /** Project to update. */
1932
1942
  project: Project$3;
1933
1943
  }
1934
1944
  interface UpdateProjectResponse$1 {
1935
- /** The updated Project */
1945
+ /** Updated project. */
1936
1946
  project?: Project$3;
1937
1947
  }
1938
1948
  interface BulkUpdateProjectsRequest$1 {
1939
- /** projects to be updated. */
1949
+ /** Projects to update. */
1940
1950
  projects?: MaskedProject$1[];
1941
- /** Flag to return full entity in response */
1951
+ /** Whether to include the updated projects in the response. Set to `true`` to receive the projects in the response. */
1942
1952
  returnFullEntity?: boolean | null;
1943
1953
  }
1944
1954
  interface MaskedProject$1 {
1945
- /** Project to be updated */
1955
+ /** Project to update. */
1946
1956
  project?: Project$3;
1947
1957
  }
1948
1958
  interface BulkUpdateProjectsResponse$1 {
1949
- /** Array with all updated items results. */
1959
+ /** Items created by bulk action. */
1950
1960
  results?: BulkUpdateProjectsResult$1[];
1951
- /** Holds metadata of the entire bulk update operation */
1961
+ /** Bulk action metadata. */
1952
1962
  bulkActionMetadata?: BulkActionMetadata$1;
1953
1963
  }
1954
1964
  interface BulkUpdateProjectsResult$1 {
1955
- /** Holds information about an item in bulk update - id, index in original request array, action successful, error (if failed). */
1965
+ /** Item metadata. */
1956
1966
  itemMetadata?: ItemMetadata$1;
1957
- /** Updated Project */
1967
+ /** Updated project. */
1958
1968
  project?: Project$3;
1959
1969
  }
1960
1970
  interface ItemMetadata$1 {
@@ -1984,17 +1994,17 @@ interface BulkActionMetadata$1 {
1984
1994
  undetailedFailures?: number;
1985
1995
  }
1986
1996
  interface DeleteProjectRequest$1 {
1987
- /** Id of the Project to delete */
1997
+ /** ID of the project to delete. */
1988
1998
  projectId: string;
1989
1999
  }
1990
2000
  interface DeleteProjectResponse$1 {
1991
- /** Id of the deleted Project */
2001
+ /** ID of the deleted project. */
1992
2002
  projectId?: string;
1993
2003
  }
1994
2004
  interface QueryProjectsRequest$1 {
1995
- /** WQL expression */
2005
+ /** Query options. */
1996
2006
  query: QueryV2$3;
1997
- /** Include page url */
2007
+ /** Include page url ? */
1998
2008
  includePageUrl?: boolean | null;
1999
2009
  }
2000
2010
  interface QueryV2$3 extends QueryV2PagingMethodOneOf$3 {
@@ -2043,9 +2053,9 @@ interface Paging$3 {
2043
2053
  offset?: number | null;
2044
2054
  }
2045
2055
  interface QueryProjectsResponse$1 {
2046
- /** The retrieved Projects */
2056
+ /** List of projects. */
2047
2057
  projects?: Project$3[];
2048
- /** Paging metadata */
2058
+ /** Paging metadata ? */
2049
2059
  metadata?: PagingMetadataV2$5;
2050
2060
  }
2051
2061
  interface UpdateProjectOrderInCollectionRequest$3 {
@@ -2213,59 +2223,60 @@ interface QueryProjectWithCollectionInfoResponseNonNullableFields$1 {
2213
2223
  projects: ProjectInCollectionNonNullableFields$3[];
2214
2224
  }
2215
2225
 
2216
- /** Project is the main entity of ProjectsService */
2217
2226
  interface Project$2 extends ProjectCoverOneOf$2 {
2218
- /** project's cover photo */
2227
+ /** Project cover image. */
2219
2228
  coverImage?: Image$2;
2220
- /** project's cover video */
2229
+ /** Project cover video. */
2221
2230
  coverVideo?: Video$2;
2222
2231
  /**
2223
- * Project ID
2232
+ * Project ID.
2224
2233
  * @readonly
2225
2234
  */
2226
2235
  _id?: string | null;
2227
2236
  /**
2228
- * 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
2237
+ * Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object.
2229
2238
  * @readonly
2230
2239
  */
2231
2240
  revision?: string | null;
2241
+ /** Project title. */
2232
2242
  title?: string | null;
2243
+ /** Project description. */
2233
2244
  description?: string | null;
2234
- /** indicates if the project should be hidden from Portfolio */
2245
+ /** Whether the project is hidden from the portfolio. */
2235
2246
  hidden?: boolean | null;
2236
- /** Collections must exist to be added to a project. Can be created/updated/deleted using [Collection Service](https://dev.wix.com/docs/rest/business-solutions/portfolio/collection) */
2247
+ /** IDs of the collections that include the project. */
2237
2248
  collectionIds?: string[];
2238
- /** Custom project details */
2249
+ /** Project details. */
2239
2250
  details?: ProjectDetail$2[];
2240
- /** Project's slug */
2251
+ /** Project slug. */
2241
2252
  slug?: string | null;
2242
2253
  /**
2243
- * Represents the time this Project was created
2254
+ * Date and time the project was created.
2244
2255
  * @readonly
2245
2256
  */
2246
2257
  _createdDate?: Date;
2247
2258
  /**
2248
- * Represents the time this Project was last updated
2259
+ * Date and time the project was updated.
2249
2260
  * @readonly
2250
2261
  */
2251
2262
  _updatedDate?: Date;
2252
2263
  /**
2253
- * Url and relative url of Project - in order to receive this field in READ requests you will need to pass the `include_page_url` field as part of request
2264
+ * Project's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
2254
2265
  * @readonly
2255
2266
  */
2256
2267
  url?: string;
2257
- /** SEO data for the project */
2268
+ /** Project SEO data. */
2258
2269
  seoData?: SeoSchema$2;
2259
2270
  }
2260
2271
  /** @oneof */
2261
2272
  interface ProjectCoverOneOf$2 {
2262
- /** project's cover photo */
2273
+ /** Project cover image. */
2263
2274
  coverImage?: Image$2;
2264
- /** project's cover video */
2275
+ /** Project cover video. */
2265
2276
  coverVideo?: Video$2;
2266
2277
  }
2267
2278
  interface Image$2 {
2268
- /** Image info - Wix Media Image. */
2279
+ /** Information about the Wix Media image. */
2269
2280
  imageInfo?: string;
2270
2281
  /** Focal point of the image. */
2271
2282
  focalPoint?: Point$2;
@@ -2282,26 +2293,35 @@ interface Point$2 {
2282
2293
  y?: number;
2283
2294
  }
2284
2295
  interface Video$2 {
2285
- /** Video info - Wix Media Image. */
2296
+ /** Information about the Wix Media video. */
2286
2297
  videoInfo?: string;
2287
2298
  /** Manually defined Video duration in milliseconds. */
2288
2299
  durationInMillis?: number | null;
2289
2300
  }
2301
+ /**
2302
+ * Project label.
2303
+ * One of:
2304
+ * + `text`
2305
+ * + `link`
2306
+ */
2290
2307
  interface ProjectDetail$2 extends ProjectDetailValueOneOf$2 {
2308
+ /** Project label in plain text format. */
2291
2309
  text?: string;
2292
- /** Details link */
2310
+ /** Project label in link format. */
2293
2311
  link?: DetailsLink$2;
2294
2312
  label?: string;
2295
2313
  }
2296
2314
  /** @oneof */
2297
2315
  interface ProjectDetailValueOneOf$2 {
2316
+ /** Project label in plain text format. */
2298
2317
  text?: string;
2299
- /** Details link */
2318
+ /** Project label in link format. */
2300
2319
  link?: DetailsLink$2;
2301
2320
  }
2302
2321
  interface DetailsLink$2 {
2322
+ /** Display text of the link. */
2303
2323
  text?: string | null;
2304
- /** link to external source */
2324
+ /** Target URL of the link. */
2305
2325
  url?: string | null;
2306
2326
  /**
2307
2327
  * Whether the link opens in a new tab or window. One of:
@@ -2388,27 +2408,27 @@ interface ProjectSlug {
2388
2408
  slug?: string;
2389
2409
  }
2390
2410
  interface CreateProjectRequest {
2391
- /** Project to be created */
2411
+ /** Project to create. */
2392
2412
  project: Project$2;
2393
2413
  }
2394
2414
  interface CreateProjectResponse {
2395
- /** The created Project */
2415
+ /** Created project. */
2396
2416
  project?: Project$2;
2397
2417
  }
2398
2418
  interface GetProjectRequest {
2399
- /** Id of the Project to retrieve */
2419
+ /** ID of the project to retrieve. */
2400
2420
  projectId: string;
2401
2421
  /** Include page url */
2402
2422
  includePageUrl?: boolean | null;
2403
2423
  }
2404
2424
  interface GetProjectResponse {
2405
- /** The retrieved Project */
2425
+ /** The requested project. */
2406
2426
  project?: Project$2;
2407
2427
  }
2408
2428
  interface ListProjectsRequest {
2409
- /** Projects limit per response is maximum 100, In the first request the cursor is None */
2429
+ /** Projects limit per response is maximum 100, In the first request the cursor is None ? */
2410
2430
  paging?: CursorPaging$4;
2411
- /** Include page url */
2431
+ /** Include page url ? */
2412
2432
  includePageUrl?: boolean | null;
2413
2433
  }
2414
2434
  interface CursorPaging$4 {
@@ -2423,9 +2443,9 @@ interface CursorPaging$4 {
2423
2443
  cursor?: string | null;
2424
2444
  }
2425
2445
  interface ListProjectsResponse {
2426
- /** The retrieved Projects */
2446
+ /** List of projects. */
2427
2447
  projects?: Project$2[];
2428
- /** Paging metadata */
2448
+ /** Paging metadata ? */
2429
2449
  metadata?: PagingMetadataV2$4;
2430
2450
  }
2431
2451
  interface PagingMetadataV2$4 {
@@ -2447,33 +2467,33 @@ interface Cursors$4 {
2447
2467
  prev?: string | null;
2448
2468
  }
2449
2469
  interface UpdateProjectRequest {
2450
- /** Project to be updated, may be partial */
2470
+ /** Project to update. */
2451
2471
  project: Project$2;
2452
2472
  }
2453
2473
  interface UpdateProjectResponse {
2454
- /** The updated Project */
2474
+ /** Updated project. */
2455
2475
  project?: Project$2;
2456
2476
  }
2457
2477
  interface BulkUpdateProjectsRequest {
2458
- /** projects to be updated. */
2478
+ /** Projects to update. */
2459
2479
  projects?: MaskedProject[];
2460
- /** Flag to return full entity in response */
2480
+ /** Whether to include the updated projects in the response. Set to `true`` to receive the projects in the response. */
2461
2481
  returnFullEntity?: boolean | null;
2462
2482
  }
2463
2483
  interface MaskedProject {
2464
- /** Project to be updated */
2484
+ /** Project to update. */
2465
2485
  project?: Project$2;
2466
2486
  }
2467
2487
  interface BulkUpdateProjectsResponse {
2468
- /** Array with all updated items results. */
2488
+ /** Items created by bulk action. */
2469
2489
  results?: BulkUpdateProjectsResult[];
2470
- /** Holds metadata of the entire bulk update operation */
2490
+ /** Bulk action metadata. */
2471
2491
  bulkActionMetadata?: BulkActionMetadata;
2472
2492
  }
2473
2493
  interface BulkUpdateProjectsResult {
2474
- /** Holds information about an item in bulk update - id, index in original request array, action successful, error (if failed). */
2494
+ /** Item metadata. */
2475
2495
  itemMetadata?: ItemMetadata;
2476
- /** Updated Project */
2496
+ /** Updated project. */
2477
2497
  project?: Project$2;
2478
2498
  }
2479
2499
  interface ItemMetadata {
@@ -2503,17 +2523,17 @@ interface BulkActionMetadata {
2503
2523
  undetailedFailures?: number;
2504
2524
  }
2505
2525
  interface DeleteProjectRequest {
2506
- /** Id of the Project to delete */
2526
+ /** ID of the project to delete. */
2507
2527
  projectId: string;
2508
2528
  }
2509
2529
  interface DeleteProjectResponse {
2510
- /** Id of the deleted Project */
2530
+ /** ID of the deleted project. */
2511
2531
  projectId?: string;
2512
2532
  }
2513
2533
  interface QueryProjectsRequest {
2514
- /** WQL expression */
2534
+ /** Query options. */
2515
2535
  query: QueryV2$2;
2516
- /** Include page url */
2536
+ /** Include page url ? */
2517
2537
  includePageUrl?: boolean | null;
2518
2538
  }
2519
2539
  interface QueryV2$2 extends QueryV2PagingMethodOneOf$2 {
@@ -2562,9 +2582,9 @@ interface Paging$2 {
2562
2582
  offset?: number | null;
2563
2583
  }
2564
2584
  interface QueryProjectsResponse {
2565
- /** The retrieved Projects */
2585
+ /** List of projects. */
2566
2586
  projects?: Project$2[];
2567
- /** Paging metadata */
2587
+ /** Paging metadata ? */
2568
2588
  metadata?: PagingMetadataV2$4;
2569
2589
  }
2570
2590
  interface UpdateProjectOrderInCollectionRequest$2 {
@@ -2764,59 +2784,60 @@ interface ProjectInCollection$1 {
2764
2784
  /** The sort order of the project in the given Collection */
2765
2785
  sortOrder?: number | null;
2766
2786
  }
2767
- /** Project is the main entity of ProjectsService */
2768
2787
  interface Project$1 extends ProjectCoverOneOf$1 {
2769
- /** project's cover photo */
2788
+ /** Project cover image. */
2770
2789
  coverImage?: Image$1;
2771
- /** project's cover video */
2790
+ /** Project cover video. */
2772
2791
  coverVideo?: Video$1;
2773
2792
  /**
2774
- * Project ID
2793
+ * Project ID.
2775
2794
  * @readonly
2776
2795
  */
2777
2796
  id?: string | null;
2778
2797
  /**
2779
- * 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
2798
+ * Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object.
2780
2799
  * @readonly
2781
2800
  */
2782
2801
  revision?: string | null;
2802
+ /** Project title. */
2783
2803
  title?: string | null;
2804
+ /** Project description. */
2784
2805
  description?: string | null;
2785
- /** indicates if the project should be hidden from Portfolio */
2806
+ /** Whether the project is hidden from the portfolio. */
2786
2807
  hidden?: boolean | null;
2787
- /** Collections must exist to be added to a project. Can be created/updated/deleted using [Collection Service](https://dev.wix.com/docs/rest/business-solutions/portfolio/collection) */
2808
+ /** IDs of the collections that include the project. */
2788
2809
  collectionIds?: string[];
2789
- /** Custom project details */
2810
+ /** Project details. */
2790
2811
  details?: ProjectDetail$1[];
2791
- /** Project's slug */
2812
+ /** Project slug. */
2792
2813
  slug?: string | null;
2793
2814
  /**
2794
- * Represents the time this Project was created
2815
+ * Date and time the project was created.
2795
2816
  * @readonly
2796
2817
  */
2797
2818
  createdDate?: Date;
2798
2819
  /**
2799
- * Represents the time this Project was last updated
2820
+ * Date and time the project was updated.
2800
2821
  * @readonly
2801
2822
  */
2802
2823
  updatedDate?: Date;
2803
2824
  /**
2804
- * Url and relative url of Project - in order to receive this field in READ requests you will need to pass the `include_page_url` field as part of request
2825
+ * Project's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
2805
2826
  * @readonly
2806
2827
  */
2807
2828
  url?: PageUrlV2;
2808
- /** SEO data for the project */
2829
+ /** Project SEO data. */
2809
2830
  seoData?: SeoSchema$1;
2810
2831
  }
2811
2832
  /** @oneof */
2812
2833
  interface ProjectCoverOneOf$1 {
2813
- /** project's cover photo */
2834
+ /** Project cover image. */
2814
2835
  coverImage?: Image$1;
2815
- /** project's cover video */
2836
+ /** Project cover video. */
2816
2837
  coverVideo?: Video$1;
2817
2838
  }
2818
2839
  interface Image$1 {
2819
- /** Image info - Wix Media Image. */
2840
+ /** Information about the Wix Media image. */
2820
2841
  imageInfo?: CommonImage;
2821
2842
  /** Focal point of the image. */
2822
2843
  focalPoint?: Point$1;
@@ -2850,7 +2871,7 @@ interface Point$1 {
2850
2871
  y?: number;
2851
2872
  }
2852
2873
  interface Video$1 {
2853
- /** Video info - Wix Media Image. */
2874
+ /** Information about the Wix Media video. */
2854
2875
  videoInfo?: VideoV2;
2855
2876
  /** Manually defined Video duration in milliseconds. */
2856
2877
  durationInMillis?: number | null;
@@ -2881,21 +2902,30 @@ interface VideoResolution {
2881
2902
  /** Video filename. */
2882
2903
  filename?: string | null;
2883
2904
  }
2905
+ /**
2906
+ * Project label.
2907
+ * One of:
2908
+ * + `text`
2909
+ * + `link`
2910
+ */
2884
2911
  interface ProjectDetail$1 extends ProjectDetailValueOneOf$1 {
2912
+ /** Project label in plain text format. */
2885
2913
  text?: string;
2886
- /** Details link */
2914
+ /** Project label in link format. */
2887
2915
  link?: DetailsLink$1;
2888
2916
  label?: string;
2889
2917
  }
2890
2918
  /** @oneof */
2891
2919
  interface ProjectDetailValueOneOf$1 {
2920
+ /** Project label in plain text format. */
2892
2921
  text?: string;
2893
- /** Details link */
2922
+ /** Project label in link format. */
2894
2923
  link?: DetailsLink$1;
2895
2924
  }
2896
2925
  interface DetailsLink$1 {
2926
+ /** Display text of the link. */
2897
2927
  text?: string | null;
2898
- /** link to external source */
2928
+ /** Target URL of the link. */
2899
2929
  url?: string | null;
2900
2930
  /**
2901
2931
  * Whether the link opens in a new tab or window. One of:
@@ -3157,59 +3187,60 @@ interface ProjectInCollection {
3157
3187
  /** The sort order of the project in the given Collection */
3158
3188
  sortOrder?: number | null;
3159
3189
  }
3160
- /** Project is the main entity of ProjectsService */
3161
3190
  interface Project extends ProjectCoverOneOf {
3162
- /** project's cover photo */
3191
+ /** Project cover image. */
3163
3192
  coverImage?: Image;
3164
- /** project's cover video */
3193
+ /** Project cover video. */
3165
3194
  coverVideo?: Video;
3166
3195
  /**
3167
- * Project ID
3196
+ * Project ID.
3168
3197
  * @readonly
3169
3198
  */
3170
3199
  _id?: string | null;
3171
3200
  /**
3172
- * 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
3201
+ * Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object.
3173
3202
  * @readonly
3174
3203
  */
3175
3204
  revision?: string | null;
3205
+ /** Project title. */
3176
3206
  title?: string | null;
3207
+ /** Project description. */
3177
3208
  description?: string | null;
3178
- /** indicates if the project should be hidden from Portfolio */
3209
+ /** Whether the project is hidden from the portfolio. */
3179
3210
  hidden?: boolean | null;
3180
- /** Collections must exist to be added to a project. Can be created/updated/deleted using [Collection Service](https://dev.wix.com/docs/rest/business-solutions/portfolio/collection) */
3211
+ /** IDs of the collections that include the project. */
3181
3212
  collectionIds?: string[];
3182
- /** Custom project details */
3213
+ /** Project details. */
3183
3214
  details?: ProjectDetail[];
3184
- /** Project's slug */
3215
+ /** Project slug. */
3185
3216
  slug?: string | null;
3186
3217
  /**
3187
- * Represents the time this Project was created
3218
+ * Date and time the project was created.
3188
3219
  * @readonly
3189
3220
  */
3190
3221
  _createdDate?: Date;
3191
3222
  /**
3192
- * Represents the time this Project was last updated
3223
+ * Date and time the project was updated.
3193
3224
  * @readonly
3194
3225
  */
3195
3226
  _updatedDate?: Date;
3196
3227
  /**
3197
- * Url and relative url of Project - in order to receive this field in READ requests you will need to pass the `include_page_url` field as part of request
3228
+ * Project's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
3198
3229
  * @readonly
3199
3230
  */
3200
3231
  url?: string;
3201
- /** SEO data for the project */
3232
+ /** Project SEO data. */
3202
3233
  seoData?: SeoSchema;
3203
3234
  }
3204
3235
  /** @oneof */
3205
3236
  interface ProjectCoverOneOf {
3206
- /** project's cover photo */
3237
+ /** Project cover image. */
3207
3238
  coverImage?: Image;
3208
- /** project's cover video */
3239
+ /** Project cover video. */
3209
3240
  coverVideo?: Video;
3210
3241
  }
3211
3242
  interface Image {
3212
- /** Image info - Wix Media Image. */
3243
+ /** Information about the Wix Media image. */
3213
3244
  imageInfo?: string;
3214
3245
  /** Focal point of the image. */
3215
3246
  focalPoint?: Point;
@@ -3226,26 +3257,35 @@ interface Point {
3226
3257
  y?: number;
3227
3258
  }
3228
3259
  interface Video {
3229
- /** Video info - Wix Media Image. */
3260
+ /** Information about the Wix Media video. */
3230
3261
  videoInfo?: string;
3231
3262
  /** Manually defined Video duration in milliseconds. */
3232
3263
  durationInMillis?: number | null;
3233
3264
  }
3265
+ /**
3266
+ * Project label.
3267
+ * One of:
3268
+ * + `text`
3269
+ * + `link`
3270
+ */
3234
3271
  interface ProjectDetail extends ProjectDetailValueOneOf {
3272
+ /** Project label in plain text format. */
3235
3273
  text?: string;
3236
- /** Details link */
3274
+ /** Project label in link format. */
3237
3275
  link?: DetailsLink;
3238
3276
  label?: string;
3239
3277
  }
3240
3278
  /** @oneof */
3241
3279
  interface ProjectDetailValueOneOf {
3280
+ /** Project label in plain text format. */
3242
3281
  text?: string;
3243
- /** Details link */
3282
+ /** Project label in link format. */
3244
3283
  link?: DetailsLink;
3245
3284
  }
3246
3285
  interface DetailsLink {
3286
+ /** Display text of the link. */
3247
3287
  text?: string | null;
3248
- /** link to external source */
3288
+ /** Target URL of the link. */
3249
3289
  url?: string | null;
3250
3290
  /**
3251
3291
  * Whether the link opens in a new tab or window. One of: