@wix/portfolio 1.0.97 → 1.0.98

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/portfolio",
-  "version": "1.0.97",
+  "version": "1.0.98",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -20,9 +20,9 @@
   "dependencies": {
     "@wix/portfolio_collections": "1.0.30",
     "@wix/portfolio_portfolio-settings": "1.0.16",
-    "@wix/portfolio_project-in-collections": "1.0.30",
+    "@wix/portfolio_project-in-collections": "1.0.31",
     "@wix/portfolio_project-items": "1.0.34",
-    "@wix/portfolio_projects": "1.0.42",
+    "@wix/portfolio_projects": "1.0.43",
     "@wix/portfolio_synced-project": "1.0.13"
   },
   "devDependencies": {
@@ -48,5 +48,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "9f2217cb67488ec1cae6311af8e51128bf68024df90d601ebdbc768c"
+  "falconPackageHash": "24a1a280cf94c831cbaaeb0c73f0126dc3a0dee1e1ab54e6324c9b63"
 }

package/type-bundles/context.bundle.d.ts

@@ -3277,23 +3277,27 @@ interface QueryProjectsResponse {
     metadata?: PagingMetadataV2$2;
 }
 interface UpdateProjectOrderInCollectionRequest$1 {
-    /** Id of the Project to update its order */
+    /** ID of the project to update. */
     projectId: string;
-    /** Id of the collection in which the project will be re-ordered */
+    /** Collection ID. */
     collectionId: string;
-    /** The new sort order of the project in the given collection */
+    /** Sort order of the project within the specified collection. */
     sortOrder: number | null;
 }
 interface UpdateProjectOrderInCollectionResponse$1 {
-    /** project with new sort order set */
+    /** Updated project within the specified collection. */
     projectInCollection?: ProjectInCollection$1;
 }
 interface ProjectInCollection$1 {
-    /** Collection ID */
+    /** Collection ID. */
     collectionId?: string;
-    /** Project */
+    /** Project object. */
     project?: Project$1;
-    /** The sort order of the project in the given Collection */
+    /**
+     * Sort order of the project within the specified collection.  <br />
+     *
+     * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
+     */
     sortOrder?: number | null;
 }
 interface QueryProjectWithCollectionInfoRequest {
@@ -3707,9 +3711,9 @@ interface ProjectsQueryBuilder {
     find: () => Promise<ProjectsQueryResult>;
 }
 interface UpdateProjectOrderInCollectionIdentifiers$1 {
-    /** Id of the Project to update its order */
+    /** ID of the project to update. */
     projectId: string;
-    /** Id of the collection in which the project will be re-ordered */
+    /** Collection ID. */
     collectionId: string;
 }
 interface QueryProjectsWithCollectionInfoOptions {
@@ -3790,7 +3794,7 @@ interface UpdateProjectOrderInCollectionSignature$1 {
     /**
      * Deprecated - please use ProjectsInCollectionsService.UpdateProjectOrderInCollection instead
      * our Client still use it
-     * @param - The new sort order of the project in the given collection
+     * @param - Sort order of the project within the specified collection.
      * @deprecated
      */
     (identifiers: UpdateProjectOrderInCollectionIdentifiers$1, sortOrder: number | null): Promise<UpdateProjectOrderInCollectionResponse$1 & UpdateProjectOrderInCollectionResponseNonNullableFields$1>;
@@ -3934,11 +3938,15 @@ declare namespace context$2 {
 }
 
 interface ProjectInCollection {
-    /** Collection ID */
+    /** Collection ID. */
     collectionId?: string;
-    /** Project */
+    /** Project object. */
     project?: Project;
-    /** The sort order of the project in the given Collection */
+    /**
+     * Sort order of the project within the specified collection.  <br />
+     *
+     * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
+     */
     sortOrder?: number | null;
 }
 interface Project extends ProjectCoverOneOf {
@@ -4156,9 +4164,12 @@ interface Settings {
     keywords?: Keyword[];
 }
 interface QueryProjectInCollectionsRequest {
-    /** WQL expression */
+    /** Query options. */
     query: QueryV2;
-    /** Include the page URL */
+    /**
+     * Whether to include the project's relative path and full URL in the response.
+     * Default: `false`
+     */
     includePageUrl?: boolean | null;
 }
 interface QueryV2 extends QueryV2PagingMethodOneOf {
@@ -4218,9 +4229,9 @@ interface CursorPaging$1 {
     cursor?: string | null;
 }
 interface QueryProjectInCollectionsResponse {
-    /** The retrieved Projects in Collections context */
+    /** List of projects in collections. */
     projectInCollections?: ProjectInCollection[];
-    /** Paging metadata */
+    /** Paging metadata. */
     metadata?: PagingMetadataV2$1;
 }
 interface PagingMetadataV2$1 {
@@ -4242,23 +4253,23 @@ interface Cursors$1 {
     prev?: string | null;
 }
 interface UpdateProjectOrderInCollectionRequest {
-    /** Id of the Project to update its order */
+    /** ID of the project to update. */
     projectId: string;
-    /** Id of the collection in which the project will be re-ordered */
+    /** Collection ID. */
     collectionId: string;
-    /** The new sort order of the project in the given collection */
+    /** Sort order of the project within the specified collection. */
     sortOrder: number | null;
 }
 interface UpdateProjectOrderInCollectionResponse {
-    /** project with new sort order set */
+    /** Updated project within the specified collection. */
     projectInCollection?: ProjectInCollection;
 }
 interface ProjectOrderInCollectionUpdatedEvent {
-    /** Id of the Project to update its order */
+    /** ID of the project to update. */
     projectId?: string;
-    /** Id of the collection in which the project will be re-ordered */
+    /** Collection ID. */
     collectionId?: string;
-    /** The new sort order of the project in the given collection */
+    /** Sort order of the project within the specified collection. */
     sortOrder?: number | null;
 }
 interface DomainEvent$1 extends DomainEventBodyOneOf$1 {
@@ -4483,7 +4494,10 @@ interface ProjectInCollectionProjectOrderInCollectionUpdatedEnvelope {
     metadata: EventMetadata;
 }
 interface QueryProjectInCollectionsOptions {
-    /** Include the page URL */
+    /**
+     * Whether to include the project's relative path and full URL in the response.
+     * Default: `false`
+     */
     includePageUrl?: boolean | null | undefined;
 }
 interface QueryCursorResult {
@@ -4564,30 +4578,30 @@ interface ProjectInCollectionsQueryBuilder {
     find: () => Promise<ProjectInCollectionsQueryResult>;
 }
 interface UpdateProjectOrderInCollectionIdentifiers {
-    /** Id of the Project to update its order */
+    /** ID of the project to update. */
     projectId: string;
-    /** Id of the collection in which the project will be re-ordered */
+    /** Collection ID. */
     collectionId: string;
 }
 
 declare function queryProjectInCollections$1(httpClient: HttpClient): QueryProjectInCollectionsSignature;
 interface QueryProjectInCollectionsSignature {
     /**
-     * Query project in collection context using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
+     * Retrieves a list of projects in the specified collections given the provided paging, filtering, and sorting. Up to 100 projects can be returned per request.
      *
-     * Because project can be ordered different in each collection, use this when want to query the projects in a Collection ordered by the order in given collection
+     * The default `sort` is `project.id` in `ASC`.
      *
-     * Supported Fields for query and ordering: collectionId, project.id, sortOrder, project.hidden, project.slug
+     * For additional field support for filters and sorting, see [Projects In Collections: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/portfolio/project-in-collection/sort-and-filter).
      *
-     * If you want to Query project by Project properties please use ProjectsService.Query method - link [Query Projects](https://dev.wix.com/docs/rest/business-solutions/portfolio/project-v1/query-projects)
+     * To learn how to query projects in collections, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
      */
     (options?: QueryProjectInCollectionsOptions | undefined): ProjectInCollectionsQueryBuilder;
 }
 declare function updateProjectOrderInCollection$1(httpClient: HttpClient): UpdateProjectOrderInCollectionSignature;
 interface UpdateProjectOrderInCollectionSignature {
     /**
-     * Updates Project's order in a given Collection
-     * @param - The new sort order of the project in the given collection
+     * Updates the order of a project within the specified collection.
+     * @param - Sort order of the project within the specified collection.
      */
     (identifiers: UpdateProjectOrderInCollectionIdentifiers, sortOrder: number | null): Promise<UpdateProjectOrderInCollectionResponse & UpdateProjectOrderInCollectionResponseNonNullableFields>;
 }

package/type-bundles/index.bundle.d.ts

@@ -3277,23 +3277,27 @@ interface QueryProjectsResponse {
     metadata?: PagingMetadataV2$2;
 }
 interface UpdateProjectOrderInCollectionRequest$1 {
-    /** Id of the Project to update its order */
+    /** ID of the project to update. */
     projectId: string;
-    /** Id of the collection in which the project will be re-ordered */
+    /** Collection ID. */
     collectionId: string;
-    /** The new sort order of the project in the given collection */
+    /** Sort order of the project within the specified collection. */
     sortOrder: number | null;
 }
 interface UpdateProjectOrderInCollectionResponse$1 {
-    /** project with new sort order set */
+    /** Updated project within the specified collection. */
     projectInCollection?: ProjectInCollection$1;
 }
 interface ProjectInCollection$1 {
-    /** Collection ID */
+    /** Collection ID. */
     collectionId?: string;
-    /** Project */
+    /** Project object. */
     project?: Project$1;
-    /** The sort order of the project in the given Collection */
+    /**
+     * Sort order of the project within the specified collection.  <br />
+     *
+     * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
+     */
     sortOrder?: number | null;
 }
 interface QueryProjectWithCollectionInfoRequest {
@@ -3707,9 +3711,9 @@ interface ProjectsQueryBuilder {
     find: () => Promise<ProjectsQueryResult>;
 }
 interface UpdateProjectOrderInCollectionIdentifiers$1 {
-    /** Id of the Project to update its order */
+    /** ID of the project to update. */
     projectId: string;
-    /** Id of the collection in which the project will be re-ordered */
+    /** Collection ID. */
     collectionId: string;
 }
 interface QueryProjectsWithCollectionInfoOptions {
@@ -3790,7 +3794,7 @@ interface UpdateProjectOrderInCollectionSignature$1 {
     /**
      * Deprecated - please use ProjectsInCollectionsService.UpdateProjectOrderInCollection instead
      * our Client still use it
-     * @param - The new sort order of the project in the given collection
+     * @param - Sort order of the project within the specified collection.
      * @deprecated
      */
     (identifiers: UpdateProjectOrderInCollectionIdentifiers$1, sortOrder: number | null): Promise<UpdateProjectOrderInCollectionResponse$1 & UpdateProjectOrderInCollectionResponseNonNullableFields$1>;
@@ -3934,11 +3938,15 @@ declare namespace index_d$2 {
 }
 
 interface ProjectInCollection {
-    /** Collection ID */
+    /** Collection ID. */
     collectionId?: string;
-    /** Project */
+    /** Project object. */
     project?: Project;
-    /** The sort order of the project in the given Collection */
+    /**
+     * Sort order of the project within the specified collection.  <br />
+     *
+     * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
+     */
     sortOrder?: number | null;
 }
 interface Project extends ProjectCoverOneOf {
@@ -4156,9 +4164,12 @@ interface Settings {
     keywords?: Keyword[];
 }
 interface QueryProjectInCollectionsRequest {
-    /** WQL expression */
+    /** Query options. */
     query: QueryV2;
-    /** Include the page URL */
+    /**
+     * Whether to include the project's relative path and full URL in the response.
+     * Default: `false`
+     */
     includePageUrl?: boolean | null;
 }
 interface QueryV2 extends QueryV2PagingMethodOneOf {
@@ -4218,9 +4229,9 @@ interface CursorPaging$1 {
     cursor?: string | null;
 }
 interface QueryProjectInCollectionsResponse {
-    /** The retrieved Projects in Collections context */
+    /** List of projects in collections. */
     projectInCollections?: ProjectInCollection[];
-    /** Paging metadata */
+    /** Paging metadata. */
     metadata?: PagingMetadataV2$1;
 }
 interface PagingMetadataV2$1 {
@@ -4242,23 +4253,23 @@ interface Cursors$1 {
     prev?: string | null;
 }
 interface UpdateProjectOrderInCollectionRequest {
-    /** Id of the Project to update its order */
+    /** ID of the project to update. */
     projectId: string;
-    /** Id of the collection in which the project will be re-ordered */
+    /** Collection ID. */
     collectionId: string;
-    /** The new sort order of the project in the given collection */
+    /** Sort order of the project within the specified collection. */
     sortOrder: number | null;
 }
 interface UpdateProjectOrderInCollectionResponse {
-    /** project with new sort order set */
+    /** Updated project within the specified collection. */
     projectInCollection?: ProjectInCollection;
 }
 interface ProjectOrderInCollectionUpdatedEvent {
-    /** Id of the Project to update its order */
+    /** ID of the project to update. */
     projectId?: string;
-    /** Id of the collection in which the project will be re-ordered */
+    /** Collection ID. */
     collectionId?: string;
-    /** The new sort order of the project in the given collection */
+    /** Sort order of the project within the specified collection. */
     sortOrder?: number | null;
 }
 interface DomainEvent$1 extends DomainEventBodyOneOf$1 {
@@ -4483,7 +4494,10 @@ interface ProjectInCollectionProjectOrderInCollectionUpdatedEnvelope {
     metadata: EventMetadata;
 }
 interface QueryProjectInCollectionsOptions {
-    /** Include the page URL */
+    /**
+     * Whether to include the project's relative path and full URL in the response.
+     * Default: `false`
+     */
     includePageUrl?: boolean | null | undefined;
 }
 interface QueryCursorResult {
@@ -4564,30 +4578,30 @@ interface ProjectInCollectionsQueryBuilder {
     find: () => Promise<ProjectInCollectionsQueryResult>;
 }
 interface UpdateProjectOrderInCollectionIdentifiers {
-    /** Id of the Project to update its order */
+    /** ID of the project to update. */
     projectId: string;
-    /** Id of the collection in which the project will be re-ordered */
+    /** Collection ID. */
     collectionId: string;
 }
 
 declare function queryProjectInCollections$1(httpClient: HttpClient): QueryProjectInCollectionsSignature;
 interface QueryProjectInCollectionsSignature {
     /**
-     * Query project in collection context using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
+     * Retrieves a list of projects in the specified collections given the provided paging, filtering, and sorting. Up to 100 projects can be returned per request.
      *
-     * Because project can be ordered different in each collection, use this when want to query the projects in a Collection ordered by the order in given collection
+     * The default `sort` is `project.id` in `ASC`.
      *
-     * Supported Fields for query and ordering: collectionId, project.id, sortOrder, project.hidden, project.slug
+     * For additional field support for filters and sorting, see [Projects In Collections: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/portfolio/project-in-collection/sort-and-filter).
      *
-     * If you want to Query project by Project properties please use ProjectsService.Query method - link [Query Projects](https://dev.wix.com/docs/rest/business-solutions/portfolio/project-v1/query-projects)
+     * To learn how to query projects in collections, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
      */
     (options?: QueryProjectInCollectionsOptions | undefined): ProjectInCollectionsQueryBuilder;
 }
 declare function updateProjectOrderInCollection$1(httpClient: HttpClient): UpdateProjectOrderInCollectionSignature;
 interface UpdateProjectOrderInCollectionSignature {
     /**
-     * Updates Project's order in a given Collection
-     * @param - The new sort order of the project in the given collection
+     * Updates the order of a project within the specified collection.
+     * @param - Sort order of the project within the specified collection.
      */
     (identifiers: UpdateProjectOrderInCollectionIdentifiers, sortOrder: number | null): Promise<UpdateProjectOrderInCollectionResponse & UpdateProjectOrderInCollectionResponseNonNullableFields>;
 }

package/type-bundles/meta.bundle.d.ts

@@ -2059,23 +2059,27 @@ interface QueryProjectsResponse$1 {
     metadata?: PagingMetadataV2$5;
 }
 interface UpdateProjectOrderInCollectionRequest$3 {
-    /** Id of the Project to update its order */
+    /** ID of the project to update. */
     projectId: string;
-    /** Id of the collection in which the project will be re-ordered */
+    /** Collection ID. */
     collectionId: string;
-    /** The new sort order of the project in the given collection */
+    /** Sort order of the project within the specified collection. */
     sortOrder: number | null;
 }
 interface UpdateProjectOrderInCollectionResponse$3 {
-    /** project with new sort order set */
+    /** Updated project within the specified collection. */
     projectInCollection?: ProjectInCollection$3;
 }
 interface ProjectInCollection$3 {
-    /** Collection ID */
+    /** Collection ID. */
     collectionId?: string;
-    /** Project */
+    /** Project object. */
     project?: Project$3;
-    /** The sort order of the project in the given Collection */
+    /**
+     * Sort order of the project within the specified collection.  <br />
+     *
+     * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
+     */
     sortOrder?: number | null;
 }
 interface QueryProjectWithCollectionInfoRequest$1 {
@@ -2588,23 +2592,27 @@ interface QueryProjectsResponse {
     metadata?: PagingMetadataV2$4;
 }
 interface UpdateProjectOrderInCollectionRequest$2 {
-    /** Id of the Project to update its order */
+    /** ID of the project to update. */
     projectId: string;
-    /** Id of the collection in which the project will be re-ordered */
+    /** Collection ID. */
     collectionId: string;
-    /** The new sort order of the project in the given collection */
+    /** Sort order of the project within the specified collection. */
     sortOrder: number | null;
 }
 interface UpdateProjectOrderInCollectionResponse$2 {
-    /** project with new sort order set */
+    /** Updated project within the specified collection. */
     projectInCollection?: ProjectInCollection$2;
 }
 interface ProjectInCollection$2 {
-    /** Collection ID */
+    /** Collection ID. */
     collectionId?: string;
-    /** Project */
+    /** Project object. */
     project?: Project$2;
-    /** The sort order of the project in the given Collection */
+    /**
+     * Sort order of the project within the specified collection.  <br />
+     *
+     * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
+     */
     sortOrder?: number | null;
 }
 interface QueryProjectWithCollectionInfoRequest {
@@ -2777,11 +2785,15 @@ declare namespace meta$2 {
 }
 
 interface ProjectInCollection$1 {
-    /** Collection ID */
+    /** Collection ID. */
     collectionId?: string;
-    /** Project */
+    /** Project object. */
     project?: Project$1;
-    /** The sort order of the project in the given Collection */
+    /**
+     * Sort order of the project within the specified collection.  <br />
+     *
+     * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
+     */
     sortOrder?: number | null;
 }
 interface Project$1 extends ProjectCoverOneOf$1 {
@@ -2998,9 +3010,12 @@ interface Settings$1 {
     keywords?: Keyword$1[];
 }
 interface QueryProjectInCollectionsRequest$1 {
-    /** WQL expression */
+    /** Query options. */
     query: QueryV2$1;
-    /** Include the page URL */
+    /**
+     * Whether to include the project's relative path and full URL in the response.
+     * Default: `false`
+     */
     includePageUrl?: boolean | null;
 }
 interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
@@ -3060,9 +3075,9 @@ interface CursorPaging$3 {
     cursor?: string | null;
 }
 interface QueryProjectInCollectionsResponse$1 {
-    /** The retrieved Projects in Collections context */
+    /** List of projects in collections. */
     projectInCollections?: ProjectInCollection$1[];
-    /** Paging metadata */
+    /** Paging metadata. */
     metadata?: PagingMetadataV2$3;
 }
 interface PagingMetadataV2$3 {
@@ -3084,15 +3099,15 @@ interface Cursors$3 {
     prev?: string | null;
 }
 interface UpdateProjectOrderInCollectionRequest$1 {
-    /** Id of the Project to update its order */
+    /** ID of the project to update. */
     projectId: string;
-    /** Id of the collection in which the project will be re-ordered */
+    /** Collection ID. */
     collectionId: string;
-    /** The new sort order of the project in the given collection */
+    /** Sort order of the project within the specified collection. */
     sortOrder: number | null;
 }
 interface UpdateProjectOrderInCollectionResponse$1 {
-    /** project with new sort order set */
+    /** Updated project within the specified collection. */
     projectInCollection?: ProjectInCollection$1;
 }
 interface CommonImageNonNullableFields {
@@ -3180,11 +3195,15 @@ interface UpdateProjectOrderInCollectionResponseNonNullableFields$1 {
 }
 
 interface ProjectInCollection {
-    /** Collection ID */
+    /** Collection ID. */
     collectionId?: string;
-    /** Project */
+    /** Project object. */
     project?: Project;
-    /** The sort order of the project in the given Collection */
+    /**
+     * Sort order of the project within the specified collection.  <br />
+     *
+     * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
+     */
     sortOrder?: number | null;
 }
 interface Project extends ProjectCoverOneOf {
@@ -3352,9 +3371,12 @@ interface Settings {
     keywords?: Keyword[];
 }
 interface QueryProjectInCollectionsRequest {
-    /** WQL expression */
+    /** Query options. */
     query: QueryV2;
-    /** Include the page URL */
+    /**
+     * Whether to include the project's relative path and full URL in the response.
+     * Default: `false`
+     */
     includePageUrl?: boolean | null;
 }
 interface QueryV2 extends QueryV2PagingMethodOneOf {
@@ -3414,9 +3436,9 @@ interface CursorPaging$2 {
     cursor?: string | null;
 }
 interface QueryProjectInCollectionsResponse {
-    /** The retrieved Projects in Collections context */
+    /** List of projects in collections. */
     projectInCollections?: ProjectInCollection[];
-    /** Paging metadata */
+    /** Paging metadata. */
     metadata?: PagingMetadataV2$2;
 }
 interface PagingMetadataV2$2 {
@@ -3438,15 +3460,15 @@ interface Cursors$2 {
     prev?: string | null;
 }
 interface UpdateProjectOrderInCollectionRequest {
-    /** Id of the Project to update its order */
+    /** ID of the project to update. */
     projectId: string;
-    /** Id of the collection in which the project will be re-ordered */
+    /** Collection ID. */
     collectionId: string;
-    /** The new sort order of the project in the given collection */
+    /** Sort order of the project within the specified collection. */
     sortOrder: number | null;
 }
 interface UpdateProjectOrderInCollectionResponse {
-    /** project with new sort order set */
+    /** Updated project within the specified collection. */
     projectInCollection?: ProjectInCollection;
 }
 interface PointNonNullableFields {