@wix/portfolio 1.0.113 → 1.0.115

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/portfolio",
3
- "version": "1.0.113",
3
+ "version": "1.0.115",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -21,11 +21,11 @@
21
21
  "type-bundles"
22
22
  ],
23
23
  "dependencies": {
24
- "@wix/portfolio_collections": "1.0.36",
25
- "@wix/portfolio_portfolio-settings": "1.0.22",
26
- "@wix/portfolio_project-in-collections": "1.0.39",
27
- "@wix/portfolio_project-items": "1.0.41",
28
- "@wix/portfolio_projects": "1.0.53",
24
+ "@wix/portfolio_collections": "1.0.37",
25
+ "@wix/portfolio_portfolio-settings": "1.0.23",
26
+ "@wix/portfolio_project-in-collections": "1.0.40",
27
+ "@wix/portfolio_project-items": "1.0.43",
28
+ "@wix/portfolio_projects": "1.0.54",
29
29
  "@wix/portfolio_synced-project": "1.0.18"
30
30
  },
31
31
  "devDependencies": {
@@ -51,5 +51,5 @@
51
51
  "fqdn": ""
52
52
  }
53
53
  },
54
- "falconPackageHash": "d77e1260e2c76584d7a77f2a82d6fc75133fdaa563a89825f6baf862"
54
+ "falconPackageHash": "3b983eee8e48307c914f3e35308293108252d4f9ca4e48f6a1b653b7"
55
55
  }
@@ -487,13 +487,15 @@ interface Collection {
487
487
  * @readonly
488
488
  */
489
489
  revision?: string | null;
490
+ /** Collection title. */
490
491
  title?: string | null;
492
+ /** Collection description. */
491
493
  description?: string | null;
492
494
  /** Collection slug. */
493
495
  slug?: string | null;
494
496
  /** Collection cover image. */
495
497
  coverImage?: Image$3;
496
- /** Whether the collection is hidden from the portfolio. */
498
+ /** Whether the collection is hidden from the portfolio. Default: `false` */
497
499
  hidden?: boolean | null;
498
500
  /**
499
501
  * Index that determines which position a media item is displayed in the gallery. <br />
@@ -793,7 +795,12 @@ interface CreateCollectionResponse {
793
795
  interface GetCollectionRequest {
794
796
  /** ID of the collection to retrieve. */
795
797
  collectionId: string;
796
- /** Whether to include the collection's page URL and relative path in the response. */
798
+ /**
799
+ * Whether to include the collection's page URL and relative path in the response.
800
+ * One of:
801
+ * + `true`
802
+ * + `false`
803
+ */
797
804
  includePageUrl?: boolean | null;
798
805
  }
799
806
  interface GetCollectionResponse {
@@ -801,9 +808,13 @@ interface GetCollectionResponse {
801
808
  collection?: Collection;
802
809
  }
803
810
  interface ListCollectionsRequest {
804
- /** Maximum limit per response is 100, in first request cursor is None ? */
805
811
  paging?: CursorPaging$4;
806
- /** Whether to include the collection's page URL and relative path in the response. */
812
+ /**
813
+ * Whether to include the collection's page URL and relative path in the response.
814
+ * One of:
815
+ * + `true`
816
+ * + `false`
817
+ */
807
818
  includePageUrl?: boolean | null;
808
819
  }
809
820
  interface CursorPaging$4 {
@@ -965,13 +976,22 @@ interface QueryCollectionsResponseNonNullableFields {
965
976
  collections: CollectionNonNullableFields[];
966
977
  }
967
978
  interface GetCollectionOptions {
968
- /** Whether to include the collection's page URL and relative path in the response. */
979
+ /**
980
+ * Whether to include the collection's page URL and relative path in the response.
981
+ * One of:
982
+ * + `true`
983
+ * + `false`
984
+ */
969
985
  includePageUrl?: boolean | null;
970
986
  }
971
987
  interface ListCollectionsOptions {
972
- /** Maximum limit per response is 100, in first request cursor is None ? */
973
988
  paging?: CursorPaging$4;
974
- /** Whether to include the collection's page URL and relative path in the response. */
989
+ /**
990
+ * Whether to include the collection's page URL and relative path in the response.
991
+ * One of:
992
+ * + `true`
993
+ * + `false`
994
+ */
975
995
  includePageUrl?: boolean | null;
976
996
  }
977
997
  interface UpdateCollection {
@@ -985,13 +1005,15 @@ interface UpdateCollection {
985
1005
  * @readonly
986
1006
  */
987
1007
  revision?: string | null;
1008
+ /** Collection title. */
988
1009
  title?: string | null;
1010
+ /** Collection description. */
989
1011
  description?: string | null;
990
1012
  /** Collection slug. */
991
1013
  slug?: string | null;
992
1014
  /** Collection cover image. */
993
1015
  coverImage?: Image$3;
994
- /** Whether the collection is hidden from the portfolio. */
1016
+ /** Whether the collection is hidden from the portfolio. Default: `false` */
995
1017
  hidden?: boolean | null;
996
1018
  /**
997
1019
  * Index that determines which position a media item is displayed in the gallery. <br />
@@ -1220,20 +1242,21 @@ interface PortfolioSettings {
1220
1242
  _updatedDate?: Date | null;
1221
1243
  }
1222
1244
  interface ProjectItemSettings {
1245
+ /** The direction in which to add new project items to a gallery. Default: `GALLERY_START` */
1223
1246
  addItemDirection?: AddItemDirection;
1224
- /** The default item name ? */
1247
+ /** Default title assigned to a project item if no title is provided. Default: `FILE_NAME` */
1225
1248
  defaultItemName?: DefaultItemName;
1226
1249
  }
1227
1250
  declare enum AddItemDirection {
1228
- /** Add new items to the start of the gallery. */
1251
+ /** Add new project items to the start of the gallery. */
1229
1252
  GALLERY_START = "GALLERY_START",
1230
- /** Add new items to the end of the gallery. */
1253
+ /** Add new project items to the end of the gallery. */
1231
1254
  GALLERY_END = "GALLERY_END"
1232
1255
  }
1233
1256
  declare enum DefaultItemName {
1234
- /** Use and show title of project item the same as file name. */
1257
+ /** File name assigned as the title. */
1235
1258
  FILE_NAME = "FILE_NAME",
1236
- /** Use and show title of project item as empty. */
1259
+ /** No title assigned. */
1237
1260
  EMPTY = "EMPTY"
1238
1261
  }
1239
1262
  interface MediaSettings {
@@ -1397,6 +1420,10 @@ declare function createPortfolioSettings$1(httpClient: HttpClient): CreatePortfo
1397
1420
  interface CreatePortfolioSettingsSignature {
1398
1421
  /**
1399
1422
  * Creates a site's portfolio settings.
1423
+ *
1424
+ * > **Note:**
1425
+ * >
1426
+ * > This method is intended for creating portfolio settings. If settings already exist, the request will return an error. To update existing settings, call [Update Portfolio Settings](https://dev.wix.com/docs/rest/business-solutions/portfolio/portfolio-settings/update-portfolio-settings).
1400
1427
  * @param - The portfolio settings to create.
1401
1428
  * @returns Newly created portfolio settings.
1402
1429
  */
@@ -1447,7 +1474,6 @@ declare namespace context$4 {
1447
1474
  export { type ActionEvent$4 as ActionEvent, context$4_AddItemDirection as AddItemDirection, type context$4_CreatePortfolioSettingsRequest as CreatePortfolioSettingsRequest, type context$4_CreatePortfolioSettingsResponse as CreatePortfolioSettingsResponse, type context$4_CreatePortfolioSettingsResponseNonNullableFields as CreatePortfolioSettingsResponseNonNullableFields, context$4_DefaultItemName as DefaultItemName, type DomainEvent$4 as DomainEvent, type DomainEventBodyOneOf$4 as DomainEventBodyOneOf, type EntityCreatedEvent$4 as EntityCreatedEvent, type EntityDeletedEvent$4 as EntityDeletedEvent, type EntityUpdatedEvent$4 as EntityUpdatedEvent, type context$4_GetPortfolioSettingsRequest as GetPortfolioSettingsRequest, type context$4_GetPortfolioSettingsResponse as GetPortfolioSettingsResponse, type context$4_GetPortfolioSettingsResponseNonNullableFields as GetPortfolioSettingsResponseNonNullableFields, type IdentificationData$4 as IdentificationData, type IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf, type context$4_MediaSettings as MediaSettings, type MessageEnvelope$4 as MessageEnvelope, type context$4_PortfolioSettings as PortfolioSettings, type context$4_PortfolioSettingsNonNullableFields as PortfolioSettingsNonNullableFields, type context$4_ProjectItemSettings as ProjectItemSettings, type RestoreInfo$4 as RestoreInfo, type context$4_SiteMenuSettings as SiteMenuSettings, type context$4_UpdatePortfolioSettingsRequest as UpdatePortfolioSettingsRequest, type context$4_UpdatePortfolioSettingsResponse as UpdatePortfolioSettingsResponse, type context$4_UpdatePortfolioSettingsResponseNonNullableFields as UpdatePortfolioSettingsResponseNonNullableFields, WebhookIdentityType$4 as WebhookIdentityType, context$4_createPortfolioSettings as createPortfolioSettings, context$4_getPortfolioSettings as getPortfolioSettings, context$4_updatePortfolioSettings as updatePortfolioSettings };
1448
1475
  }
1449
1476
 
1450
- /** ProjectItem is the main entity of ProjectItemsService */
1451
1477
  interface Item extends ItemMetadataOneOf {
1452
1478
  /** Information about the Wix Media image. */
1453
1479
  image?: Image$2;
@@ -1578,6 +1604,130 @@ interface Link {
1578
1604
  */
1579
1605
  target?: string | null;
1580
1606
  }
1607
+ interface GenerateTokenForProjectItemsRequest {
1608
+ /** Media ids of requested project items */
1609
+ mediaIds?: string[];
1610
+ }
1611
+ interface GenerateTokenForProjectItemsResponse {
1612
+ /** Generated media tokens for project items */
1613
+ mediaTokens?: ProjectItemMediaToken[];
1614
+ }
1615
+ interface ProjectItemMediaToken {
1616
+ /** Media id of project item */
1617
+ mediaId?: string;
1618
+ /** Generated media token for project item */
1619
+ mediaToken?: string;
1620
+ }
1621
+ interface DomainEvent$3 extends DomainEventBodyOneOf$3 {
1622
+ createdEvent?: EntityCreatedEvent$3;
1623
+ updatedEvent?: EntityUpdatedEvent$3;
1624
+ deletedEvent?: EntityDeletedEvent$3;
1625
+ actionEvent?: ActionEvent$3;
1626
+ /**
1627
+ * Unique event ID.
1628
+ * Allows clients to ignore duplicate webhooks.
1629
+ */
1630
+ _id?: string;
1631
+ /**
1632
+ * Assumes actions are also always typed to an entity_type
1633
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1634
+ */
1635
+ entityFqdn?: string;
1636
+ /**
1637
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1638
+ * This is although the created/updated/deleted notion is duplication of the oneof types
1639
+ * Example: created/updated/deleted/started/completed/email_opened
1640
+ */
1641
+ slug?: string;
1642
+ /** ID of the entity associated with the event. */
1643
+ entityId?: string;
1644
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1645
+ eventTime?: Date | null;
1646
+ /**
1647
+ * Whether the event was triggered as a result of a privacy regulation application
1648
+ * (for example, GDPR).
1649
+ */
1650
+ triggeredByAnonymizeRequest?: boolean | null;
1651
+ /** If present, indicates the action that triggered the event. */
1652
+ originatedFrom?: string | null;
1653
+ /**
1654
+ * A sequence number defining the order of updates to the underlying entity.
1655
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
1656
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1657
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1658
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
1659
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1660
+ */
1661
+ entityEventSequence?: string | null;
1662
+ }
1663
+ /** @oneof */
1664
+ interface DomainEventBodyOneOf$3 {
1665
+ createdEvent?: EntityCreatedEvent$3;
1666
+ updatedEvent?: EntityUpdatedEvent$3;
1667
+ deletedEvent?: EntityDeletedEvent$3;
1668
+ actionEvent?: ActionEvent$3;
1669
+ }
1670
+ interface EntityCreatedEvent$3 {
1671
+ entity?: string;
1672
+ }
1673
+ interface RestoreInfo$3 {
1674
+ deletedDate?: Date | null;
1675
+ }
1676
+ interface EntityUpdatedEvent$3 {
1677
+ /**
1678
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1679
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1680
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1681
+ */
1682
+ currentEntity?: string;
1683
+ }
1684
+ interface EntityDeletedEvent$3 {
1685
+ /** Entity that was deleted */
1686
+ deletedEntity?: string | null;
1687
+ }
1688
+ interface ActionEvent$3 {
1689
+ body?: string;
1690
+ }
1691
+ interface MessageEnvelope$3 {
1692
+ /** App instance ID. */
1693
+ instanceId?: string | null;
1694
+ /** Event type. */
1695
+ eventType?: string;
1696
+ /** The identification type and identity data. */
1697
+ identity?: IdentificationData$3;
1698
+ /** Stringify payload. */
1699
+ data?: string;
1700
+ }
1701
+ interface IdentificationData$3 extends IdentificationDataIdOneOf$3 {
1702
+ /** ID of a site visitor that has not logged in to the site. */
1703
+ anonymousVisitorId?: string;
1704
+ /** ID of a site visitor that has logged in to the site. */
1705
+ memberId?: string;
1706
+ /** ID of a Wix user (site owner, contributor, etc.). */
1707
+ wixUserId?: string;
1708
+ /** ID of an app. */
1709
+ appId?: string;
1710
+ /** @readonly */
1711
+ identityType?: WebhookIdentityType$3;
1712
+ }
1713
+ /** @oneof */
1714
+ interface IdentificationDataIdOneOf$3 {
1715
+ /** ID of a site visitor that has not logged in to the site. */
1716
+ anonymousVisitorId?: string;
1717
+ /** ID of a site visitor that has logged in to the site. */
1718
+ memberId?: string;
1719
+ /** ID of a Wix user (site owner, contributor, etc.). */
1720
+ wixUserId?: string;
1721
+ /** ID of an app. */
1722
+ appId?: string;
1723
+ }
1724
+ declare enum WebhookIdentityType$3 {
1725
+ UNKNOWN = "UNKNOWN",
1726
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1727
+ MEMBER = "MEMBER",
1728
+ WIX_USER = "WIX_USER",
1729
+ APP = "APP"
1730
+ }
1581
1731
  interface InvalidateCache$1 extends InvalidateCacheGetByOneOf$1 {
1582
1732
  /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
1583
1733
  metaSiteId?: string;
@@ -1863,76 +2013,6 @@ interface CreateProjectGalleryResponse {
1863
2013
  /** Id of created gallery */
1864
2014
  galleryId?: string;
1865
2015
  }
1866
- interface DomainEvent$3 extends DomainEventBodyOneOf$3 {
1867
- createdEvent?: EntityCreatedEvent$3;
1868
- updatedEvent?: EntityUpdatedEvent$3;
1869
- deletedEvent?: EntityDeletedEvent$3;
1870
- actionEvent?: ActionEvent$3;
1871
- /**
1872
- * Unique event ID.
1873
- * Allows clients to ignore duplicate webhooks.
1874
- */
1875
- _id?: string;
1876
- /**
1877
- * Assumes actions are also always typed to an entity_type
1878
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1879
- */
1880
- entityFqdn?: string;
1881
- /**
1882
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1883
- * This is although the created/updated/deleted notion is duplication of the oneof types
1884
- * Example: created/updated/deleted/started/completed/email_opened
1885
- */
1886
- slug?: string;
1887
- /** ID of the entity associated with the event. */
1888
- entityId?: string;
1889
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1890
- eventTime?: Date | null;
1891
- /**
1892
- * Whether the event was triggered as a result of a privacy regulation application
1893
- * (for example, GDPR).
1894
- */
1895
- triggeredByAnonymizeRequest?: boolean | null;
1896
- /** If present, indicates the action that triggered the event. */
1897
- originatedFrom?: string | null;
1898
- /**
1899
- * A sequence number defining the order of updates to the underlying entity.
1900
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
1901
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1902
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1903
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
1904
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1905
- */
1906
- entityEventSequence?: string | null;
1907
- }
1908
- /** @oneof */
1909
- interface DomainEventBodyOneOf$3 {
1910
- createdEvent?: EntityCreatedEvent$3;
1911
- updatedEvent?: EntityUpdatedEvent$3;
1912
- deletedEvent?: EntityDeletedEvent$3;
1913
- actionEvent?: ActionEvent$3;
1914
- }
1915
- interface EntityCreatedEvent$3 {
1916
- entity?: string;
1917
- }
1918
- interface RestoreInfo$3 {
1919
- deletedDate?: Date | null;
1920
- }
1921
- interface EntityUpdatedEvent$3 {
1922
- /**
1923
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1924
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1925
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1926
- */
1927
- currentEntity?: string;
1928
- }
1929
- interface EntityDeletedEvent$3 {
1930
- /** Entity that was deleted */
1931
- deletedEntity?: string | null;
1932
- }
1933
- interface ActionEvent$3 {
1934
- body?: string;
1935
- }
1936
2016
  interface Empty$2 {
1937
2017
  }
1938
2018
  interface DeletedProjectRestored$1 {
@@ -1953,60 +2033,6 @@ interface DuplicateProjectItemsResponse {
1953
2033
  /** Bulk action metadata. */
1954
2034
  bulkActionMetadata?: BulkActionMetadata$1;
1955
2035
  }
1956
- interface MessageEnvelope$3 {
1957
- /** App instance ID. */
1958
- instanceId?: string | null;
1959
- /** Event type. */
1960
- eventType?: string;
1961
- /** The identification type and identity data. */
1962
- identity?: IdentificationData$3;
1963
- /** Stringify payload. */
1964
- data?: string;
1965
- }
1966
- interface IdentificationData$3 extends IdentificationDataIdOneOf$3 {
1967
- /** ID of a site visitor that has not logged in to the site. */
1968
- anonymousVisitorId?: string;
1969
- /** ID of a site visitor that has logged in to the site. */
1970
- memberId?: string;
1971
- /** ID of a Wix user (site owner, contributor, etc.). */
1972
- wixUserId?: string;
1973
- /** ID of an app. */
1974
- appId?: string;
1975
- /** @readonly */
1976
- identityType?: WebhookIdentityType$3;
1977
- }
1978
- /** @oneof */
1979
- interface IdentificationDataIdOneOf$3 {
1980
- /** ID of a site visitor that has not logged in to the site. */
1981
- anonymousVisitorId?: string;
1982
- /** ID of a site visitor that has logged in to the site. */
1983
- memberId?: string;
1984
- /** ID of a Wix user (site owner, contributor, etc.). */
1985
- wixUserId?: string;
1986
- /** ID of an app. */
1987
- appId?: string;
1988
- }
1989
- declare enum WebhookIdentityType$3 {
1990
- UNKNOWN = "UNKNOWN",
1991
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1992
- MEMBER = "MEMBER",
1993
- WIX_USER = "WIX_USER",
1994
- APP = "APP"
1995
- }
1996
- interface GenerateTokenForProjectItemsRequest {
1997
- /** Media ids of requested project items */
1998
- mediaIds?: string[];
1999
- }
2000
- interface GenerateTokenForProjectItemsResponse {
2001
- /** Generated media tokens for project items */
2002
- mediaTokens?: ProjectItemMediaToken[];
2003
- }
2004
- interface ProjectItemMediaToken {
2005
- /** Media id of project item */
2006
- mediaId?: string;
2007
- /** Generated media token for project item */
2008
- mediaToken?: string;
2009
- }
2010
2036
  interface PointNonNullableFields$2 {
2011
2037
  x: number;
2012
2038
  y: number;
@@ -2336,7 +2362,7 @@ interface Project$1 extends ProjectCoverOneOf$1 {
2336
2362
  title?: string | null;
2337
2363
  /** Project description. */
2338
2364
  description?: string | null;
2339
- /** Whether the project is hidden from the portfolio. */
2365
+ /** Whether the project is hidden from the portfolio. Default: `false` */
2340
2366
  hidden?: boolean | null;
2341
2367
  /** IDs of the collections that include the project. */
2342
2368
  collectionIds?: string[];
@@ -2435,6 +2461,7 @@ interface ProjectDetail$1 extends ProjectDetailValueOneOf$1 {
2435
2461
  text?: string;
2436
2462
  /** Project label in link format. */
2437
2463
  link?: DetailsLink$1;
2464
+ /** Project label. */
2438
2465
  label?: string;
2439
2466
  }
2440
2467
  /** @oneof */
@@ -2973,7 +3000,12 @@ interface GetProjectResponse {
2973
3000
  interface ListProjectsRequest {
2974
3001
  /** Projects limit per response is maximum 100, In the first request the cursor is None ? */
2975
3002
  paging?: CursorPaging$2;
2976
- /** Whether to include the project's relative path and full URL in the response. Default: `false` */
3003
+ /**
3004
+ * Whether to include the project's relative path and full URL in the response.
3005
+ * One of:
3006
+ * + `true`
3007
+ * + `false`
3008
+ */
2977
3009
  includePageUrl?: boolean | null;
2978
3010
  }
2979
3011
  interface CursorPaging$2 {
@@ -3416,7 +3448,12 @@ interface GetProjectOptions {
3416
3448
  interface ListProjectsOptions {
3417
3449
  /** Projects limit per response is maximum 100, In the first request the cursor is None ? */
3418
3450
  paging?: CursorPaging$2;
3419
- /** Whether to include the project's relative path and full URL in the response. Default: `false` */
3451
+ /**
3452
+ * Whether to include the project's relative path and full URL in the response.
3453
+ * One of:
3454
+ * + `true`
3455
+ * + `false`
3456
+ */
3420
3457
  includePageUrl?: boolean | null;
3421
3458
  }
3422
3459
  interface UpdateProject {
@@ -3438,7 +3475,7 @@ interface UpdateProject {
3438
3475
  title?: string | null;
3439
3476
  /** Project description. */
3440
3477
  description?: string | null;
3441
- /** Whether the project is hidden from the portfolio. */
3478
+ /** Whether the project is hidden from the portfolio. Default: `false` */
3442
3479
  hidden?: boolean | null;
3443
3480
  /** IDs of the collections that include the project. */
3444
3481
  collectionIds?: string[];
@@ -3677,7 +3714,9 @@ type _publicOnProjectDeletedType = typeof onProjectDeleted$1;
3677
3714
  declare const onProjectDeleted: ReturnType<typeof createEventModule$1<_publicOnProjectDeletedType>>;
3678
3715
 
3679
3716
  type _publicOnProjectUpdatedType = typeof onProjectUpdated$1;
3680
- /** */
3717
+ /**
3718
+ * Triggered when a project is updated.
3719
+ */
3681
3720
  declare const onProjectUpdated: ReturnType<typeof createEventModule$1<_publicOnProjectUpdatedType>>;
3682
3721
 
3683
3722
  type context$2_App = App;
@@ -3790,7 +3829,7 @@ interface Project extends ProjectCoverOneOf {
3790
3829
  title?: string | null;
3791
3830
  /** Project description. */
3792
3831
  description?: string | null;
3793
- /** Whether the project is hidden from the portfolio. */
3832
+ /** Whether the project is hidden from the portfolio. Default: `false` */
3794
3833
  hidden?: boolean | null;
3795
3834
  /** IDs of the collections that include the project. */
3796
3835
  collectionIds?: string[];
@@ -3889,6 +3928,7 @@ interface ProjectDetail extends ProjectDetailValueOneOf {
3889
3928
  text?: string;
3890
3929
  /** Project label in link format. */
3891
3930
  link?: DetailsLink;
3931
+ /** Project label. */
3892
3932
  label?: string;
3893
3933
  }
3894
3934
  /** @oneof */
@@ -4322,7 +4362,7 @@ interface UpdateProjectOrderInCollectionIdentifiers {
4322
4362
  declare function updateProjectOrderInCollection$1(httpClient: HttpClient): UpdateProjectOrderInCollectionSignature;
4323
4363
  interface UpdateProjectOrderInCollectionSignature {
4324
4364
  /**
4325
- * Updates the order of a project within the specified collection.
4365
+ * Updates the order of a project within a specified collection.
4326
4366
  * @param - Sort order of the project within the specified collection.
4327
4367
  */
4328
4368
  (identifiers: UpdateProjectOrderInCollectionIdentifiers, sortOrder: number | null): Promise<UpdateProjectOrderInCollectionResponse & UpdateProjectOrderInCollectionResponseNonNullableFields>;
@@ -4334,7 +4374,9 @@ declare function createEventModule<T extends EventDefinition<any, string>>(event
4334
4374
  declare const updateProjectOrderInCollection: MaybeContext<BuildRESTFunction<typeof updateProjectOrderInCollection$1> & typeof updateProjectOrderInCollection$1>;
4335
4375
 
4336
4376
  type _publicOnProjectInCollectionProjectOrderInCollectionUpdatedEventType = typeof onProjectInCollectionProjectOrderInCollectionUpdatedEvent$1;
4337
- /** */
4377
+ /**
4378
+ * Triggered when the order of a project within a specified collection is updated.
4379
+ */
4338
4380
  declare const onProjectInCollectionProjectOrderInCollectionUpdatedEvent: ReturnType<typeof createEventModule<_publicOnProjectInCollectionProjectOrderInCollectionUpdatedEventType>>;
4339
4381
 
4340
4382
  type context$1_BaseEventMetadata = BaseEventMetadata;
@@ -487,13 +487,15 @@ interface Collection {
487
487
  * @readonly
488
488
  */
489
489
  revision?: string | null;
490
+ /** Collection title. */
490
491
  title?: string | null;
492
+ /** Collection description. */
491
493
  description?: string | null;
492
494
  /** Collection slug. */
493
495
  slug?: string | null;
494
496
  /** Collection cover image. */
495
497
  coverImage?: Image$3;
496
- /** Whether the collection is hidden from the portfolio. */
498
+ /** Whether the collection is hidden from the portfolio. Default: `false` */
497
499
  hidden?: boolean | null;
498
500
  /**
499
501
  * Index that determines which position a media item is displayed in the gallery. <br />
@@ -793,7 +795,12 @@ interface CreateCollectionResponse {
793
795
  interface GetCollectionRequest {
794
796
  /** ID of the collection to retrieve. */
795
797
  collectionId: string;
796
- /** Whether to include the collection's page URL and relative path in the response. */
798
+ /**
799
+ * Whether to include the collection's page URL and relative path in the response.
800
+ * One of:
801
+ * + `true`
802
+ * + `false`
803
+ */
797
804
  includePageUrl?: boolean | null;
798
805
  }
799
806
  interface GetCollectionResponse {
@@ -801,9 +808,13 @@ interface GetCollectionResponse {
801
808
  collection?: Collection;
802
809
  }
803
810
  interface ListCollectionsRequest {
804
- /** Maximum limit per response is 100, in first request cursor is None ? */
805
811
  paging?: CursorPaging$4;
806
- /** Whether to include the collection's page URL and relative path in the response. */
812
+ /**
813
+ * Whether to include the collection's page URL and relative path in the response.
814
+ * One of:
815
+ * + `true`
816
+ * + `false`
817
+ */
807
818
  includePageUrl?: boolean | null;
808
819
  }
809
820
  interface CursorPaging$4 {
@@ -965,13 +976,22 @@ interface QueryCollectionsResponseNonNullableFields {
965
976
  collections: CollectionNonNullableFields[];
966
977
  }
967
978
  interface GetCollectionOptions {
968
- /** Whether to include the collection's page URL and relative path in the response. */
979
+ /**
980
+ * Whether to include the collection's page URL and relative path in the response.
981
+ * One of:
982
+ * + `true`
983
+ * + `false`
984
+ */
969
985
  includePageUrl?: boolean | null;
970
986
  }
971
987
  interface ListCollectionsOptions {
972
- /** Maximum limit per response is 100, in first request cursor is None ? */
973
988
  paging?: CursorPaging$4;
974
- /** Whether to include the collection's page URL and relative path in the response. */
989
+ /**
990
+ * Whether to include the collection's page URL and relative path in the response.
991
+ * One of:
992
+ * + `true`
993
+ * + `false`
994
+ */
975
995
  includePageUrl?: boolean | null;
976
996
  }
977
997
  interface UpdateCollection {
@@ -985,13 +1005,15 @@ interface UpdateCollection {
985
1005
  * @readonly
986
1006
  */
987
1007
  revision?: string | null;
1008
+ /** Collection title. */
988
1009
  title?: string | null;
1010
+ /** Collection description. */
989
1011
  description?: string | null;
990
1012
  /** Collection slug. */
991
1013
  slug?: string | null;
992
1014
  /** Collection cover image. */
993
1015
  coverImage?: Image$3;
994
- /** Whether the collection is hidden from the portfolio. */
1016
+ /** Whether the collection is hidden from the portfolio. Default: `false` */
995
1017
  hidden?: boolean | null;
996
1018
  /**
997
1019
  * Index that determines which position a media item is displayed in the gallery. <br />
@@ -1220,20 +1242,21 @@ interface PortfolioSettings {
1220
1242
  _updatedDate?: Date | null;
1221
1243
  }
1222
1244
  interface ProjectItemSettings {
1245
+ /** The direction in which to add new project items to a gallery. Default: `GALLERY_START` */
1223
1246
  addItemDirection?: AddItemDirection;
1224
- /** The default item name ? */
1247
+ /** Default title assigned to a project item if no title is provided. Default: `FILE_NAME` */
1225
1248
  defaultItemName?: DefaultItemName;
1226
1249
  }
1227
1250
  declare enum AddItemDirection {
1228
- /** Add new items to the start of the gallery. */
1251
+ /** Add new project items to the start of the gallery. */
1229
1252
  GALLERY_START = "GALLERY_START",
1230
- /** Add new items to the end of the gallery. */
1253
+ /** Add new project items to the end of the gallery. */
1231
1254
  GALLERY_END = "GALLERY_END"
1232
1255
  }
1233
1256
  declare enum DefaultItemName {
1234
- /** Use and show title of project item the same as file name. */
1257
+ /** File name assigned as the title. */
1235
1258
  FILE_NAME = "FILE_NAME",
1236
- /** Use and show title of project item as empty. */
1259
+ /** No title assigned. */
1237
1260
  EMPTY = "EMPTY"
1238
1261
  }
1239
1262
  interface MediaSettings {
@@ -1397,6 +1420,10 @@ declare function createPortfolioSettings$1(httpClient: HttpClient): CreatePortfo
1397
1420
  interface CreatePortfolioSettingsSignature {
1398
1421
  /**
1399
1422
  * Creates a site's portfolio settings.
1423
+ *
1424
+ * > **Note:**
1425
+ * >
1426
+ * > This method is intended for creating portfolio settings. If settings already exist, the request will return an error. To update existing settings, call [Update Portfolio Settings](https://dev.wix.com/docs/rest/business-solutions/portfolio/portfolio-settings/update-portfolio-settings).
1400
1427
  * @param - The portfolio settings to create.
1401
1428
  * @returns Newly created portfolio settings.
1402
1429
  */
@@ -1447,7 +1474,6 @@ declare namespace index_d$4 {
1447
1474
  export { type ActionEvent$4 as ActionEvent, index_d$4_AddItemDirection as AddItemDirection, type index_d$4_CreatePortfolioSettingsRequest as CreatePortfolioSettingsRequest, type index_d$4_CreatePortfolioSettingsResponse as CreatePortfolioSettingsResponse, type index_d$4_CreatePortfolioSettingsResponseNonNullableFields as CreatePortfolioSettingsResponseNonNullableFields, index_d$4_DefaultItemName as DefaultItemName, type DomainEvent$4 as DomainEvent, type DomainEventBodyOneOf$4 as DomainEventBodyOneOf, type EntityCreatedEvent$4 as EntityCreatedEvent, type EntityDeletedEvent$4 as EntityDeletedEvent, type EntityUpdatedEvent$4 as EntityUpdatedEvent, type index_d$4_GetPortfolioSettingsRequest as GetPortfolioSettingsRequest, type index_d$4_GetPortfolioSettingsResponse as GetPortfolioSettingsResponse, type index_d$4_GetPortfolioSettingsResponseNonNullableFields as GetPortfolioSettingsResponseNonNullableFields, type IdentificationData$4 as IdentificationData, type IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf, type index_d$4_MediaSettings as MediaSettings, type MessageEnvelope$4 as MessageEnvelope, type index_d$4_PortfolioSettings as PortfolioSettings, type index_d$4_PortfolioSettingsNonNullableFields as PortfolioSettingsNonNullableFields, type index_d$4_ProjectItemSettings as ProjectItemSettings, type RestoreInfo$4 as RestoreInfo, type index_d$4_SiteMenuSettings as SiteMenuSettings, type index_d$4_UpdatePortfolioSettingsRequest as UpdatePortfolioSettingsRequest, type index_d$4_UpdatePortfolioSettingsResponse as UpdatePortfolioSettingsResponse, type index_d$4_UpdatePortfolioSettingsResponseNonNullableFields as UpdatePortfolioSettingsResponseNonNullableFields, WebhookIdentityType$4 as WebhookIdentityType, index_d$4_createPortfolioSettings as createPortfolioSettings, index_d$4_getPortfolioSettings as getPortfolioSettings, index_d$4_updatePortfolioSettings as updatePortfolioSettings };
1448
1475
  }
1449
1476
 
1450
- /** ProjectItem is the main entity of ProjectItemsService */
1451
1477
  interface Item extends ItemMetadataOneOf {
1452
1478
  /** Information about the Wix Media image. */
1453
1479
  image?: Image$2;
@@ -1578,6 +1604,130 @@ interface Link {
1578
1604
  */
1579
1605
  target?: string | null;
1580
1606
  }
1607
+ interface GenerateTokenForProjectItemsRequest {
1608
+ /** Media ids of requested project items */
1609
+ mediaIds?: string[];
1610
+ }
1611
+ interface GenerateTokenForProjectItemsResponse {
1612
+ /** Generated media tokens for project items */
1613
+ mediaTokens?: ProjectItemMediaToken[];
1614
+ }
1615
+ interface ProjectItemMediaToken {
1616
+ /** Media id of project item */
1617
+ mediaId?: string;
1618
+ /** Generated media token for project item */
1619
+ mediaToken?: string;
1620
+ }
1621
+ interface DomainEvent$3 extends DomainEventBodyOneOf$3 {
1622
+ createdEvent?: EntityCreatedEvent$3;
1623
+ updatedEvent?: EntityUpdatedEvent$3;
1624
+ deletedEvent?: EntityDeletedEvent$3;
1625
+ actionEvent?: ActionEvent$3;
1626
+ /**
1627
+ * Unique event ID.
1628
+ * Allows clients to ignore duplicate webhooks.
1629
+ */
1630
+ _id?: string;
1631
+ /**
1632
+ * Assumes actions are also always typed to an entity_type
1633
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1634
+ */
1635
+ entityFqdn?: string;
1636
+ /**
1637
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1638
+ * This is although the created/updated/deleted notion is duplication of the oneof types
1639
+ * Example: created/updated/deleted/started/completed/email_opened
1640
+ */
1641
+ slug?: string;
1642
+ /** ID of the entity associated with the event. */
1643
+ entityId?: string;
1644
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1645
+ eventTime?: Date | null;
1646
+ /**
1647
+ * Whether the event was triggered as a result of a privacy regulation application
1648
+ * (for example, GDPR).
1649
+ */
1650
+ triggeredByAnonymizeRequest?: boolean | null;
1651
+ /** If present, indicates the action that triggered the event. */
1652
+ originatedFrom?: string | null;
1653
+ /**
1654
+ * A sequence number defining the order of updates to the underlying entity.
1655
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
1656
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1657
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1658
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
1659
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1660
+ */
1661
+ entityEventSequence?: string | null;
1662
+ }
1663
+ /** @oneof */
1664
+ interface DomainEventBodyOneOf$3 {
1665
+ createdEvent?: EntityCreatedEvent$3;
1666
+ updatedEvent?: EntityUpdatedEvent$3;
1667
+ deletedEvent?: EntityDeletedEvent$3;
1668
+ actionEvent?: ActionEvent$3;
1669
+ }
1670
+ interface EntityCreatedEvent$3 {
1671
+ entity?: string;
1672
+ }
1673
+ interface RestoreInfo$3 {
1674
+ deletedDate?: Date | null;
1675
+ }
1676
+ interface EntityUpdatedEvent$3 {
1677
+ /**
1678
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1679
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1680
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1681
+ */
1682
+ currentEntity?: string;
1683
+ }
1684
+ interface EntityDeletedEvent$3 {
1685
+ /** Entity that was deleted */
1686
+ deletedEntity?: string | null;
1687
+ }
1688
+ interface ActionEvent$3 {
1689
+ body?: string;
1690
+ }
1691
+ interface MessageEnvelope$3 {
1692
+ /** App instance ID. */
1693
+ instanceId?: string | null;
1694
+ /** Event type. */
1695
+ eventType?: string;
1696
+ /** The identification type and identity data. */
1697
+ identity?: IdentificationData$3;
1698
+ /** Stringify payload. */
1699
+ data?: string;
1700
+ }
1701
+ interface IdentificationData$3 extends IdentificationDataIdOneOf$3 {
1702
+ /** ID of a site visitor that has not logged in to the site. */
1703
+ anonymousVisitorId?: string;
1704
+ /** ID of a site visitor that has logged in to the site. */
1705
+ memberId?: string;
1706
+ /** ID of a Wix user (site owner, contributor, etc.). */
1707
+ wixUserId?: string;
1708
+ /** ID of an app. */
1709
+ appId?: string;
1710
+ /** @readonly */
1711
+ identityType?: WebhookIdentityType$3;
1712
+ }
1713
+ /** @oneof */
1714
+ interface IdentificationDataIdOneOf$3 {
1715
+ /** ID of a site visitor that has not logged in to the site. */
1716
+ anonymousVisitorId?: string;
1717
+ /** ID of a site visitor that has logged in to the site. */
1718
+ memberId?: string;
1719
+ /** ID of a Wix user (site owner, contributor, etc.). */
1720
+ wixUserId?: string;
1721
+ /** ID of an app. */
1722
+ appId?: string;
1723
+ }
1724
+ declare enum WebhookIdentityType$3 {
1725
+ UNKNOWN = "UNKNOWN",
1726
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1727
+ MEMBER = "MEMBER",
1728
+ WIX_USER = "WIX_USER",
1729
+ APP = "APP"
1730
+ }
1581
1731
  interface InvalidateCache$1 extends InvalidateCacheGetByOneOf$1 {
1582
1732
  /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
1583
1733
  metaSiteId?: string;
@@ -1863,76 +2013,6 @@ interface CreateProjectGalleryResponse {
1863
2013
  /** Id of created gallery */
1864
2014
  galleryId?: string;
1865
2015
  }
1866
- interface DomainEvent$3 extends DomainEventBodyOneOf$3 {
1867
- createdEvent?: EntityCreatedEvent$3;
1868
- updatedEvent?: EntityUpdatedEvent$3;
1869
- deletedEvent?: EntityDeletedEvent$3;
1870
- actionEvent?: ActionEvent$3;
1871
- /**
1872
- * Unique event ID.
1873
- * Allows clients to ignore duplicate webhooks.
1874
- */
1875
- _id?: string;
1876
- /**
1877
- * Assumes actions are also always typed to an entity_type
1878
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1879
- */
1880
- entityFqdn?: string;
1881
- /**
1882
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1883
- * This is although the created/updated/deleted notion is duplication of the oneof types
1884
- * Example: created/updated/deleted/started/completed/email_opened
1885
- */
1886
- slug?: string;
1887
- /** ID of the entity associated with the event. */
1888
- entityId?: string;
1889
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1890
- eventTime?: Date | null;
1891
- /**
1892
- * Whether the event was triggered as a result of a privacy regulation application
1893
- * (for example, GDPR).
1894
- */
1895
- triggeredByAnonymizeRequest?: boolean | null;
1896
- /** If present, indicates the action that triggered the event. */
1897
- originatedFrom?: string | null;
1898
- /**
1899
- * A sequence number defining the order of updates to the underlying entity.
1900
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
1901
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1902
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1903
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
1904
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1905
- */
1906
- entityEventSequence?: string | null;
1907
- }
1908
- /** @oneof */
1909
- interface DomainEventBodyOneOf$3 {
1910
- createdEvent?: EntityCreatedEvent$3;
1911
- updatedEvent?: EntityUpdatedEvent$3;
1912
- deletedEvent?: EntityDeletedEvent$3;
1913
- actionEvent?: ActionEvent$3;
1914
- }
1915
- interface EntityCreatedEvent$3 {
1916
- entity?: string;
1917
- }
1918
- interface RestoreInfo$3 {
1919
- deletedDate?: Date | null;
1920
- }
1921
- interface EntityUpdatedEvent$3 {
1922
- /**
1923
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1924
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1925
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1926
- */
1927
- currentEntity?: string;
1928
- }
1929
- interface EntityDeletedEvent$3 {
1930
- /** Entity that was deleted */
1931
- deletedEntity?: string | null;
1932
- }
1933
- interface ActionEvent$3 {
1934
- body?: string;
1935
- }
1936
2016
  interface Empty$2 {
1937
2017
  }
1938
2018
  interface DeletedProjectRestored$1 {
@@ -1953,60 +2033,6 @@ interface DuplicateProjectItemsResponse {
1953
2033
  /** Bulk action metadata. */
1954
2034
  bulkActionMetadata?: BulkActionMetadata$1;
1955
2035
  }
1956
- interface MessageEnvelope$3 {
1957
- /** App instance ID. */
1958
- instanceId?: string | null;
1959
- /** Event type. */
1960
- eventType?: string;
1961
- /** The identification type and identity data. */
1962
- identity?: IdentificationData$3;
1963
- /** Stringify payload. */
1964
- data?: string;
1965
- }
1966
- interface IdentificationData$3 extends IdentificationDataIdOneOf$3 {
1967
- /** ID of a site visitor that has not logged in to the site. */
1968
- anonymousVisitorId?: string;
1969
- /** ID of a site visitor that has logged in to the site. */
1970
- memberId?: string;
1971
- /** ID of a Wix user (site owner, contributor, etc.). */
1972
- wixUserId?: string;
1973
- /** ID of an app. */
1974
- appId?: string;
1975
- /** @readonly */
1976
- identityType?: WebhookIdentityType$3;
1977
- }
1978
- /** @oneof */
1979
- interface IdentificationDataIdOneOf$3 {
1980
- /** ID of a site visitor that has not logged in to the site. */
1981
- anonymousVisitorId?: string;
1982
- /** ID of a site visitor that has logged in to the site. */
1983
- memberId?: string;
1984
- /** ID of a Wix user (site owner, contributor, etc.). */
1985
- wixUserId?: string;
1986
- /** ID of an app. */
1987
- appId?: string;
1988
- }
1989
- declare enum WebhookIdentityType$3 {
1990
- UNKNOWN = "UNKNOWN",
1991
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1992
- MEMBER = "MEMBER",
1993
- WIX_USER = "WIX_USER",
1994
- APP = "APP"
1995
- }
1996
- interface GenerateTokenForProjectItemsRequest {
1997
- /** Media ids of requested project items */
1998
- mediaIds?: string[];
1999
- }
2000
- interface GenerateTokenForProjectItemsResponse {
2001
- /** Generated media tokens for project items */
2002
- mediaTokens?: ProjectItemMediaToken[];
2003
- }
2004
- interface ProjectItemMediaToken {
2005
- /** Media id of project item */
2006
- mediaId?: string;
2007
- /** Generated media token for project item */
2008
- mediaToken?: string;
2009
- }
2010
2036
  interface PointNonNullableFields$2 {
2011
2037
  x: number;
2012
2038
  y: number;
@@ -2336,7 +2362,7 @@ interface Project$1 extends ProjectCoverOneOf$1 {
2336
2362
  title?: string | null;
2337
2363
  /** Project description. */
2338
2364
  description?: string | null;
2339
- /** Whether the project is hidden from the portfolio. */
2365
+ /** Whether the project is hidden from the portfolio. Default: `false` */
2340
2366
  hidden?: boolean | null;
2341
2367
  /** IDs of the collections that include the project. */
2342
2368
  collectionIds?: string[];
@@ -2435,6 +2461,7 @@ interface ProjectDetail$1 extends ProjectDetailValueOneOf$1 {
2435
2461
  text?: string;
2436
2462
  /** Project label in link format. */
2437
2463
  link?: DetailsLink$1;
2464
+ /** Project label. */
2438
2465
  label?: string;
2439
2466
  }
2440
2467
  /** @oneof */
@@ -2973,7 +3000,12 @@ interface GetProjectResponse {
2973
3000
  interface ListProjectsRequest {
2974
3001
  /** Projects limit per response is maximum 100, In the first request the cursor is None ? */
2975
3002
  paging?: CursorPaging$2;
2976
- /** Whether to include the project's relative path and full URL in the response. Default: `false` */
3003
+ /**
3004
+ * Whether to include the project's relative path and full URL in the response.
3005
+ * One of:
3006
+ * + `true`
3007
+ * + `false`
3008
+ */
2977
3009
  includePageUrl?: boolean | null;
2978
3010
  }
2979
3011
  interface CursorPaging$2 {
@@ -3416,7 +3448,12 @@ interface GetProjectOptions {
3416
3448
  interface ListProjectsOptions {
3417
3449
  /** Projects limit per response is maximum 100, In the first request the cursor is None ? */
3418
3450
  paging?: CursorPaging$2;
3419
- /** Whether to include the project's relative path and full URL in the response. Default: `false` */
3451
+ /**
3452
+ * Whether to include the project's relative path and full URL in the response.
3453
+ * One of:
3454
+ * + `true`
3455
+ * + `false`
3456
+ */
3420
3457
  includePageUrl?: boolean | null;
3421
3458
  }
3422
3459
  interface UpdateProject {
@@ -3438,7 +3475,7 @@ interface UpdateProject {
3438
3475
  title?: string | null;
3439
3476
  /** Project description. */
3440
3477
  description?: string | null;
3441
- /** Whether the project is hidden from the portfolio. */
3478
+ /** Whether the project is hidden from the portfolio. Default: `false` */
3442
3479
  hidden?: boolean | null;
3443
3480
  /** IDs of the collections that include the project. */
3444
3481
  collectionIds?: string[];
@@ -3677,7 +3714,9 @@ type _publicOnProjectDeletedType = typeof onProjectDeleted$1;
3677
3714
  declare const onProjectDeleted: ReturnType<typeof createEventModule$1<_publicOnProjectDeletedType>>;
3678
3715
 
3679
3716
  type _publicOnProjectUpdatedType = typeof onProjectUpdated$1;
3680
- /** */
3717
+ /**
3718
+ * Triggered when a project is updated.
3719
+ */
3681
3720
  declare const onProjectUpdated: ReturnType<typeof createEventModule$1<_publicOnProjectUpdatedType>>;
3682
3721
 
3683
3722
  type index_d$2_App = App;
@@ -3790,7 +3829,7 @@ interface Project extends ProjectCoverOneOf {
3790
3829
  title?: string | null;
3791
3830
  /** Project description. */
3792
3831
  description?: string | null;
3793
- /** Whether the project is hidden from the portfolio. */
3832
+ /** Whether the project is hidden from the portfolio. Default: `false` */
3794
3833
  hidden?: boolean | null;
3795
3834
  /** IDs of the collections that include the project. */
3796
3835
  collectionIds?: string[];
@@ -3889,6 +3928,7 @@ interface ProjectDetail extends ProjectDetailValueOneOf {
3889
3928
  text?: string;
3890
3929
  /** Project label in link format. */
3891
3930
  link?: DetailsLink;
3931
+ /** Project label. */
3892
3932
  label?: string;
3893
3933
  }
3894
3934
  /** @oneof */
@@ -4322,7 +4362,7 @@ interface UpdateProjectOrderInCollectionIdentifiers {
4322
4362
  declare function updateProjectOrderInCollection$1(httpClient: HttpClient): UpdateProjectOrderInCollectionSignature;
4323
4363
  interface UpdateProjectOrderInCollectionSignature {
4324
4364
  /**
4325
- * Updates the order of a project within the specified collection.
4365
+ * Updates the order of a project within a specified collection.
4326
4366
  * @param - Sort order of the project within the specified collection.
4327
4367
  */
4328
4368
  (identifiers: UpdateProjectOrderInCollectionIdentifiers, sortOrder: number | null): Promise<UpdateProjectOrderInCollectionResponse & UpdateProjectOrderInCollectionResponseNonNullableFields>;
@@ -4334,7 +4374,9 @@ declare function createEventModule<T extends EventDefinition<any, string>>(event
4334
4374
  declare const updateProjectOrderInCollection: MaybeContext<BuildRESTFunction<typeof updateProjectOrderInCollection$1> & typeof updateProjectOrderInCollection$1>;
4335
4375
 
4336
4376
  type _publicOnProjectInCollectionProjectOrderInCollectionUpdatedEventType = typeof onProjectInCollectionProjectOrderInCollectionUpdatedEvent$1;
4337
- /** */
4377
+ /**
4378
+ * Triggered when the order of a project within a specified collection is updated.
4379
+ */
4338
4380
  declare const onProjectInCollectionProjectOrderInCollectionUpdatedEvent: ReturnType<typeof createEventModule<_publicOnProjectInCollectionProjectOrderInCollectionUpdatedEventType>>;
4339
4381
 
4340
4382
  type index_d$1_BaseEventMetadata = BaseEventMetadata;
@@ -9,13 +9,15 @@ interface Collection$1 {
9
9
  * @readonly
10
10
  */
11
11
  revision?: string | null;
12
+ /** Collection title. */
12
13
  title?: string | null;
14
+ /** Collection description. */
13
15
  description?: string | null;
14
16
  /** Collection slug. */
15
17
  slug?: string | null;
16
18
  /** Collection cover image. */
17
19
  coverImage?: Image$7;
18
- /** Whether the collection is hidden from the portfolio. */
20
+ /** Whether the collection is hidden from the portfolio. Default: `false` */
19
21
  hidden?: boolean | null;
20
22
  /**
21
23
  * Index that determines which position a media item is displayed in the gallery. <br />
@@ -144,7 +146,12 @@ interface CreateCollectionResponse$1 {
144
146
  interface GetCollectionRequest$1 {
145
147
  /** ID of the collection to retrieve. */
146
148
  collectionId: string;
147
- /** Whether to include the collection's page URL and relative path in the response. */
149
+ /**
150
+ * Whether to include the collection's page URL and relative path in the response.
151
+ * One of:
152
+ * + `true`
153
+ * + `false`
154
+ */
148
155
  includePageUrl?: boolean | null;
149
156
  }
150
157
  interface GetCollectionResponse$1 {
@@ -152,9 +159,13 @@ interface GetCollectionResponse$1 {
152
159
  collection?: Collection$1;
153
160
  }
154
161
  interface ListCollectionsRequest$1 {
155
- /** Maximum limit per response is 100, in first request cursor is None ? */
156
162
  paging?: CursorPaging$5;
157
- /** Whether to include the collection's page URL and relative path in the response. */
163
+ /**
164
+ * Whether to include the collection's page URL and relative path in the response.
165
+ * One of:
166
+ * + `true`
167
+ * + `false`
168
+ */
158
169
  includePageUrl?: boolean | null;
159
170
  }
160
171
  interface CursorPaging$5 {
@@ -336,13 +347,15 @@ interface Collection {
336
347
  * @readonly
337
348
  */
338
349
  revision?: string | null;
350
+ /** Collection title. */
339
351
  title?: string | null;
352
+ /** Collection description. */
340
353
  description?: string | null;
341
354
  /** Collection slug. */
342
355
  slug?: string | null;
343
356
  /** Collection cover image. */
344
357
  coverImage?: Image$6;
345
- /** Whether the collection is hidden from the portfolio. */
358
+ /** Whether the collection is hidden from the portfolio. Default: `false` */
346
359
  hidden?: boolean | null;
347
360
  /**
348
361
  * Index that determines which position a media item is displayed in the gallery. <br />
@@ -448,7 +461,12 @@ interface CreateCollectionResponse {
448
461
  interface GetCollectionRequest {
449
462
  /** ID of the collection to retrieve. */
450
463
  collectionId: string;
451
- /** Whether to include the collection's page URL and relative path in the response. */
464
+ /**
465
+ * Whether to include the collection's page URL and relative path in the response.
466
+ * One of:
467
+ * + `true`
468
+ * + `false`
469
+ */
452
470
  includePageUrl?: boolean | null;
453
471
  }
454
472
  interface GetCollectionResponse {
@@ -456,9 +474,13 @@ interface GetCollectionResponse {
456
474
  collection?: Collection;
457
475
  }
458
476
  interface ListCollectionsRequest {
459
- /** Maximum limit per response is 100, in first request cursor is None ? */
460
477
  paging?: CursorPaging$4;
461
- /** Whether to include the collection's page URL and relative path in the response. */
478
+ /**
479
+ * Whether to include the collection's page URL and relative path in the response.
480
+ * One of:
481
+ * + `true`
482
+ * + `false`
483
+ */
462
484
  includePageUrl?: boolean | null;
463
485
  }
464
486
  interface CursorPaging$4 {
@@ -675,20 +697,21 @@ interface PortfolioSettings$1 {
675
697
  updatedDate?: Date | null;
676
698
  }
677
699
  interface ProjectItemSettings$1 {
700
+ /** The direction in which to add new project items to a gallery. Default: `GALLERY_START` */
678
701
  addItemDirection?: AddItemDirection$1;
679
- /** The default item name ? */
702
+ /** Default title assigned to a project item if no title is provided. Default: `FILE_NAME` */
680
703
  defaultItemName?: DefaultItemName$1;
681
704
  }
682
705
  declare enum AddItemDirection$1 {
683
- /** Add new items to the start of the gallery. */
706
+ /** Add new project items to the start of the gallery. */
684
707
  GALLERY_START = "GALLERY_START",
685
- /** Add new items to the end of the gallery. */
708
+ /** Add new project items to the end of the gallery. */
686
709
  GALLERY_END = "GALLERY_END"
687
710
  }
688
711
  declare enum DefaultItemName$1 {
689
- /** Use and show title of project item the same as file name. */
712
+ /** File name assigned as the title. */
690
713
  FILE_NAME = "FILE_NAME",
691
- /** Use and show title of project item as empty. */
714
+ /** No title assigned. */
692
715
  EMPTY = "EMPTY"
693
716
  }
694
717
  interface MediaSettings$1 {
@@ -756,20 +779,21 @@ interface PortfolioSettings {
756
779
  _updatedDate?: Date | null;
757
780
  }
758
781
  interface ProjectItemSettings {
782
+ /** The direction in which to add new project items to a gallery. Default: `GALLERY_START` */
759
783
  addItemDirection?: AddItemDirection;
760
- /** The default item name ? */
784
+ /** Default title assigned to a project item if no title is provided. Default: `FILE_NAME` */
761
785
  defaultItemName?: DefaultItemName;
762
786
  }
763
787
  declare enum AddItemDirection {
764
- /** Add new items to the start of the gallery. */
788
+ /** Add new project items to the start of the gallery. */
765
789
  GALLERY_START = "GALLERY_START",
766
- /** Add new items to the end of the gallery. */
790
+ /** Add new project items to the end of the gallery. */
767
791
  GALLERY_END = "GALLERY_END"
768
792
  }
769
793
  declare enum DefaultItemName {
770
- /** Use and show title of project item the same as file name. */
794
+ /** File name assigned as the title. */
771
795
  FILE_NAME = "FILE_NAME",
772
- /** Use and show title of project item as empty. */
796
+ /** No title assigned. */
773
797
  EMPTY = "EMPTY"
774
798
  }
775
799
  interface MediaSettings {
@@ -836,7 +860,6 @@ declare namespace meta$4 {
836
860
  export { type __PublicMethodMetaInfo$4 as __PublicMethodMetaInfo, meta$4_createPortfolioSettings as createPortfolioSettings, meta$4_getPortfolioSettings as getPortfolioSettings, meta$4_updatePortfolioSettings as updatePortfolioSettings };
837
861
  }
838
862
 
839
- /** ProjectItem is the main entity of ProjectItemsService */
840
863
  interface Item$1 extends ItemMetadataOneOf$1 {
841
864
  /** Information about the Wix Media image. */
842
865
  image?: Image$5;
@@ -1249,7 +1272,6 @@ interface DuplicateProjectItemsResponseNonNullableFields$1 {
1249
1272
  bulkActionMetadata?: BulkActionMetadataNonNullableFields$3;
1250
1273
  }
1251
1274
 
1252
- /** ProjectItem is the main entity of ProjectItemsService */
1253
1275
  interface Item extends ItemMetadataOneOf {
1254
1276
  /** Information about the Wix Media image. */
1255
1277
  image?: Image$4;
@@ -1660,7 +1682,7 @@ interface Project$3 extends ProjectCoverOneOf$3 {
1660
1682
  title?: string | null;
1661
1683
  /** Project description. */
1662
1684
  description?: string | null;
1663
- /** Whether the project is hidden from the portfolio. */
1685
+ /** Whether the project is hidden from the portfolio. Default: `false` */
1664
1686
  hidden?: boolean | null;
1665
1687
  /** IDs of the collections that include the project. */
1666
1688
  collectionIds?: string[];
@@ -1770,6 +1792,7 @@ interface ProjectDetail$3 extends ProjectDetailValueOneOf$3 {
1770
1792
  text?: string;
1771
1793
  /** Project label in link format. */
1772
1794
  link?: DetailsLink$3;
1795
+ /** Project label. */
1773
1796
  label?: string;
1774
1797
  }
1775
1798
  /** @oneof */
@@ -1875,7 +1898,12 @@ interface GetProjectResponse$1 {
1875
1898
  interface ListProjectsRequest$1 {
1876
1899
  /** Projects limit per response is maximum 100, In the first request the cursor is None ? */
1877
1900
  paging?: CursorPaging$3;
1878
- /** Whether to include the project's relative path and full URL in the response. Default: `false` */
1901
+ /**
1902
+ * Whether to include the project's relative path and full URL in the response.
1903
+ * One of:
1904
+ * + `true`
1905
+ * + `false`
1906
+ */
1879
1907
  includePageUrl?: boolean | null;
1880
1908
  }
1881
1909
  interface CursorPaging$3 {
@@ -2218,7 +2246,7 @@ interface Project$2 extends ProjectCoverOneOf$2 {
2218
2246
  title?: string | null;
2219
2247
  /** Project description. */
2220
2248
  description?: string | null;
2221
- /** Whether the project is hidden from the portfolio. */
2249
+ /** Whether the project is hidden from the portfolio. Default: `false` */
2222
2250
  hidden?: boolean | null;
2223
2251
  /** IDs of the collections that include the project. */
2224
2252
  collectionIds?: string[];
@@ -2285,6 +2313,7 @@ interface ProjectDetail$2 extends ProjectDetailValueOneOf$2 {
2285
2313
  text?: string;
2286
2314
  /** Project label in link format. */
2287
2315
  link?: DetailsLink$2;
2316
+ /** Project label. */
2288
2317
  label?: string;
2289
2318
  }
2290
2319
  /** @oneof */
@@ -2384,7 +2413,12 @@ interface GetProjectResponse {
2384
2413
  interface ListProjectsRequest {
2385
2414
  /** Projects limit per response is maximum 100, In the first request the cursor is None ? */
2386
2415
  paging?: CursorPaging$2;
2387
- /** Whether to include the project's relative path and full URL in the response. Default: `false` */
2416
+ /**
2417
+ * Whether to include the project's relative path and full URL in the response.
2418
+ * One of:
2419
+ * + `true`
2420
+ * + `false`
2421
+ */
2388
2422
  includePageUrl?: boolean | null;
2389
2423
  }
2390
2424
  interface CursorPaging$2 {
@@ -2763,7 +2797,7 @@ interface Project$1 extends ProjectCoverOneOf$1 {
2763
2797
  title?: string | null;
2764
2798
  /** Project description. */
2765
2799
  description?: string | null;
2766
- /** Whether the project is hidden from the portfolio. */
2800
+ /** Whether the project is hidden from the portfolio. Default: `false` */
2767
2801
  hidden?: boolean | null;
2768
2802
  /** IDs of the collections that include the project. */
2769
2803
  collectionIds?: string[];
@@ -2873,6 +2907,7 @@ interface ProjectDetail$1 extends ProjectDetailValueOneOf$1 {
2873
2907
  text?: string;
2874
2908
  /** Project label in link format. */
2875
2909
  link?: DetailsLink$1;
2910
+ /** Project label. */
2876
2911
  label?: string;
2877
2912
  }
2878
2913
  /** @oneof */
@@ -3086,7 +3121,7 @@ interface Project extends ProjectCoverOneOf {
3086
3121
  title?: string | null;
3087
3122
  /** Project description. */
3088
3123
  description?: string | null;
3089
- /** Whether the project is hidden from the portfolio. */
3124
+ /** Whether the project is hidden from the portfolio. Default: `false` */
3090
3125
  hidden?: boolean | null;
3091
3126
  /** IDs of the collections that include the project. */
3092
3127
  collectionIds?: string[];
@@ -3153,6 +3188,7 @@ interface ProjectDetail extends ProjectDetailValueOneOf {
3153
3188
  text?: string;
3154
3189
  /** Project label in link format. */
3155
3190
  link?: DetailsLink;
3191
+ /** Project label. */
3156
3192
  label?: string;
3157
3193
  }
3158
3194
  /** @oneof */