@wix/portfolio 1.0.96 → 1.0.98

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

@@ -2461,55 +2461,56 @@ declare namespace context$3 {
   export { type ActionEvent$3 as ActionEvent, type App$1 as App, type ApplicationError$1 as ApplicationError, type BaseEventMetadata$2 as BaseEventMetadata, type BulkActionMetadata$1 as BulkActionMetadata, type context$3_BulkCreateProjectItemResult as BulkCreateProjectItemResult, type context$3_BulkCreateProjectItemsOptions as BulkCreateProjectItemsOptions, type context$3_BulkCreateProjectItemsRequest as BulkCreateProjectItemsRequest, type context$3_BulkCreateProjectItemsResponse as BulkCreateProjectItemsResponse, type context$3_BulkCreateProjectItemsResponseNonNullableFields as BulkCreateProjectItemsResponseNonNullableFields, type context$3_BulkDeleteProjectItemResult as BulkDeleteProjectItemResult, type context$3_BulkDeleteProjectItemsOptions as BulkDeleteProjectItemsOptions, type context$3_BulkDeleteProjectItemsRequest as BulkDeleteProjectItemsRequest, type context$3_BulkDeleteProjectItemsResponse as BulkDeleteProjectItemsResponse, type context$3_BulkDeleteProjectItemsResponseNonNullableFields as BulkDeleteProjectItemsResponseNonNullableFields, type context$3_BulkUpdateProjectItemResult as BulkUpdateProjectItemResult, type context$3_BulkUpdateProjectItemsOptions as BulkUpdateProjectItemsOptions, type context$3_BulkUpdateProjectItemsRequest as BulkUpdateProjectItemsRequest, type context$3_BulkUpdateProjectItemsResponse as BulkUpdateProjectItemsResponse, type context$3_BulkUpdateProjectItemsResponseNonNullableFields as BulkUpdateProjectItemsResponseNonNullableFields, type context$3_CreateProjectGalleryRequest as CreateProjectGalleryRequest, type context$3_CreateProjectGalleryResponse as CreateProjectGalleryResponse, type context$3_CreateProjectItemRequest as CreateProjectItemRequest, type context$3_CreateProjectItemResponse as CreateProjectItemResponse, type context$3_CreateProjectItemResponseNonNullableFields as CreateProjectItemResponseNonNullableFields, type CursorPaging$3 as CursorPaging, type Cursors$3 as Cursors, type context$3_DeleteProjectItemRequest as DeleteProjectItemRequest, type context$3_DeleteProjectItemResponse as DeleteProjectItemResponse, type context$3_DeleteProjectItemResponseNonNullableFields as DeleteProjectItemResponseNonNullableFields, type DeletedProjectRestored$1 as DeletedProjectRestored, type DomainEvent$3 as DomainEvent, type DomainEventBodyOneOf$3 as DomainEventBodyOneOf, type context$3_DuplicateProjectItemsOptions as DuplicateProjectItemsOptions, type context$3_DuplicateProjectItemsRequest as DuplicateProjectItemsRequest, type context$3_DuplicateProjectItemsResponse as DuplicateProjectItemsResponse, type context$3_DuplicateProjectItemsResponseNonNullableFields as DuplicateProjectItemsResponseNonNullableFields, type Empty$2 as Empty, type EntityCreatedEvent$3 as EntityCreatedEvent, type EntityDeletedEvent$3 as EntityDeletedEvent, type EntityUpdatedEvent$3 as EntityUpdatedEvent, type EventMetadata$2 as EventMetadata, type File$1 as File, type context$3_GenerateTokenForProjectItemsRequest as GenerateTokenForProjectItemsRequest, type context$3_GenerateTokenForProjectItemsResponse as GenerateTokenForProjectItemsResponse, type context$3_GetProjectItemRequest as GetProjectItemRequest, type context$3_GetProjectItemResponse as GetProjectItemResponse, type context$3_GetProjectItemResponseNonNullableFields as GetProjectItemResponseNonNullableFields, type IdentificationData$3 as IdentificationData, type IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf, type Image$2 as Image, ImageType$2 as ImageType, type InvalidateCache$1 as InvalidateCache, type InvalidateCacheGetByOneOf$1 as InvalidateCacheGetByOneOf, type context$3_Item as Item, type ItemMetadata$1 as ItemMetadata, type context$3_ItemMetadataOneOf as ItemMetadataOneOf, type context$3_ItemNonNullableFields as ItemNonNullableFields, type context$3_Link as Link, type context$3_ListProjectItemsOptions as ListProjectItemsOptions, type context$3_ListProjectItemsRequest as ListProjectItemsRequest, type context$3_ListProjectItemsResponse as ListProjectItemsResponse, type context$3_ListProjectItemsResponseNonNullableFields as ListProjectItemsResponseNonNullableFields, type context$3_MaskedItem as MaskedItem, type MessageEnvelope$3 as MessageEnvelope, type Page$1 as Page, type Paging$2 as Paging, type PagingMetadataV2$3 as PagingMetadataV2, type Point$2 as Point, type context$3_ProjectItemCreatedEnvelope as ProjectItemCreatedEnvelope, type context$3_ProjectItemDeletedEnvelope as ProjectItemDeletedEnvelope, type context$3_ProjectItemMediaToken as ProjectItemMediaToken, type context$3_ProjectItemUpdatedEnvelope as ProjectItemUpdatedEnvelope, type context$3_QueryProjectItemsRequest as QueryProjectItemsRequest, type context$3_QueryProjectItemsResponse as QueryProjectItemsResponse, type QueryV2$2 as QueryV2, type QueryV2PagingMethodOneOf$2 as QueryV2PagingMethodOneOf, type RestoreInfo$3 as RestoreInfo, SortOrder$2 as SortOrder, type Sorting$2 as Sorting, type context$3_Tags as Tags, context$3_Type as Type, type URI$1 as URI, type UnsharpMasking$2 as UnsharpMasking, type context$3_UpdateProjectItem as UpdateProjectItem, type context$3_UpdateProjectItemRequest as UpdateProjectItemRequest, type context$3_UpdateProjectItemResponse as UpdateProjectItemResponse, type context$3_UpdateProjectItemResponseNonNullableFields as UpdateProjectItemResponseNonNullableFields, type Video$2 as Video, type VideoResolution$2 as VideoResolution, WebhookIdentityType$3 as WebhookIdentityType, type context$3__publicOnProjectItemCreatedType as _publicOnProjectItemCreatedType, type context$3__publicOnProjectItemDeletedType as _publicOnProjectItemDeletedType, type context$3__publicOnProjectItemUpdatedType as _publicOnProjectItemUpdatedType, context$3_bulkCreateProjectItems as bulkCreateProjectItems, context$3_bulkDeleteProjectItems as bulkDeleteProjectItems, context$3_bulkUpdateProjectItems as bulkUpdateProjectItems, context$3_createProjectItem as createProjectItem, context$3_deleteProjectItem as deleteProjectItem, context$3_duplicateProjectItems as duplicateProjectItems, context$3_getProjectItem as getProjectItem, context$3_listProjectItems as listProjectItems, context$3_onProjectItemCreated as onProjectItemCreated, context$3_onProjectItemDeleted as onProjectItemDeleted, context$3_onProjectItemUpdated as onProjectItemUpdated, onProjectItemCreated$1 as publicOnProjectItemCreated, onProjectItemDeleted$1 as publicOnProjectItemDeleted, onProjectItemUpdated$1 as publicOnProjectItemUpdated, context$3_updateProjectItem as updateProjectItem };
 }
 
-/** Project is the main entity of ProjectsService */
 interface Project$1 extends ProjectCoverOneOf$1 {
-    /** project's cover photo */
+    /** Project cover image. */
     coverImage?: Image$1;
-    /** project's cover video */
+    /** Project cover video. */
     coverVideo?: Video$1;
     /**
-     * Project ID
+     * Project ID.
      * @readonly
      */
     _id?: string | null;
     /**
-     * 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
+     * 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.
      * @readonly
      */
     revision?: string | null;
+    /** Project title. */
     title?: string | null;
+    /** Project description. */
     description?: string | null;
-    /** indicates if the project should be hidden from Portfolio */
+    /** Whether the project is hidden from the portfolio. */
     hidden?: boolean | null;
-    /** 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) */
+    /** IDs of the collections that include the project. */
     collectionIds?: string[];
-    /** Custom project details */
+    /** Project details. */
     details?: ProjectDetail$1[];
-    /** Project's slug */
+    /** Project slug. */
     slug?: string | null;
     /**
-     * Represents the time this Project was created
+     * Date and time the project was created.
      * @readonly
      */
     _createdDate?: Date;
     /**
-     * Represents the time this Project was last updated
+     * Date and time the project was updated.
      * @readonly
      */
     _updatedDate?: Date;
     /**
-     * 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
+     * Project's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
      * @readonly
      */
     url?: string;
-    /** SEO data for the project */
+    /** Project SEO data. */
     seoData?: SeoSchema$1;
 }
 /** @oneof */
 interface ProjectCoverOneOf$1 {
-    /** project's cover photo */
+    /** Project cover image. */
     coverImage?: Image$1;
-    /** project's cover video */
+    /** Project cover video. */
     coverVideo?: Video$1;
 }
 interface Image$1 {
@@ -2567,21 +2568,30 @@ interface VideoResolution$1 {
     /** Video filename. */
     filename?: string | null;
 }
+/**
+ * Project label.
+ * One of:
+ * + `text`
+ * + `link`
+ */
 interface ProjectDetail$1 extends ProjectDetailValueOneOf$1 {
+    /** Project label in plain text format. */
     text?: string;
-    /** Details link */
+    /** Project label in link format. */
     link?: DetailsLink$1;
     label?: string;
 }
 /** @oneof */
 interface ProjectDetailValueOneOf$1 {
+    /** Project label in plain text format. */
     text?: string;
-    /** Details link */
+    /** Project label in link format. */
     link?: DetailsLink$1;
 }
 interface DetailsLink$1 {
+    /** Display text of the link. */
     text?: string | null;
-    /** link to external source */
+    /** Target URL of the link. */
     url?: string | null;
     /**
      * Whether the link opens in a new tab or window. One of:
@@ -3087,27 +3097,27 @@ interface DeletedProjectRestored {
     deletionTimestamp?: Date;
 }
 interface CreateProjectRequest {
-    /** Project to be created */
+    /** Project to create. */
     project: Project$1;
 }
 interface CreateProjectResponse {
-    /** The created Project */
+    /** Created project. */
     project?: Project$1;
 }
 interface GetProjectRequest {
-    /** Id of the Project to retrieve */
+    /** ID of the project to retrieve. */
     projectId: string;
     /** Include page url */
     includePageUrl?: boolean | null;
 }
 interface GetProjectResponse {
-    /** The retrieved Project */
+    /** The requested project. */
     project?: Project$1;
 }
 interface ListProjectsRequest {
-    /** Projects limit per response is maximum 100, In the first request the cursor is None */
+    /** Projects limit per response is maximum 100, In the first request the cursor is None ? */
     paging?: CursorPaging$2;
-    /** Include page url */
+    /** Include page url ? */
     includePageUrl?: boolean | null;
 }
 interface CursorPaging$2 {
@@ -3122,9 +3132,9 @@ interface CursorPaging$2 {
     cursor?: string | null;
 }
 interface ListProjectsResponse {
-    /** The retrieved Projects */
+    /** List of projects. */
     projects?: Project$1[];
-    /** Paging metadata */
+    /** Paging metadata ? */
     metadata?: PagingMetadataV2$2;
 }
 interface PagingMetadataV2$2 {
@@ -3146,33 +3156,33 @@ interface Cursors$2 {
     prev?: string | null;
 }
 interface UpdateProjectRequest {
-    /** Project to be updated, may be partial */
+    /** Project to update. */
     project: Project$1;
 }
 interface UpdateProjectResponse {
-    /** The updated Project */
+    /** Updated project. */
     project?: Project$1;
 }
 interface BulkUpdateProjectsRequest {
-    /** projects to be updated. */
+    /** Projects to update. */
     projects?: MaskedProject[];
-    /** Flag to return full entity in response */
+    /** Whether to include the updated projects in the response. Set to `true`` to receive the projects in the response. */
     returnFullEntity?: boolean | null;
 }
 interface MaskedProject {
-    /** Project to be updated */
+    /** Project to update. */
     project?: Project$1;
 }
 interface BulkUpdateProjectsResponse {
-    /** Array with all updated items results. */
+    /** Items created by bulk action. */
     results?: BulkUpdateProjectsResult[];
-    /** Holds metadata of the entire bulk update operation */
+    /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 interface BulkUpdateProjectsResult {
-    /** Holds information about an item in bulk update - id, index in original request array, action successful, error (if failed). */
+    /** Item metadata. */
     itemMetadata?: ItemMetadata;
-    /** Updated Project */
+    /** Updated project. */
     project?: Project$1;
 }
 interface ItemMetadata {
@@ -3202,17 +3212,17 @@ interface BulkActionMetadata {
     undetailedFailures?: number;
 }
 interface DeleteProjectRequest {
-    /** Id of the Project to delete */
+    /** ID of the project to delete. */
     projectId: string;
 }
 interface DeleteProjectResponse {
-    /** Id of the deleted Project */
+    /** ID of the deleted project. */
     projectId?: string;
 }
 interface QueryProjectsRequest {
-    /** WQL expression */
+    /** Query options. */
     query: QueryV2$1;
-    /** Include page url */
+    /** Include page url ? */
     includePageUrl?: boolean | null;
 }
 interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
@@ -3261,29 +3271,33 @@ interface Paging$1 {
     offset?: number | null;
 }
 interface QueryProjectsResponse {
-    /** The retrieved Projects */
+    /** List of projects. */
     projects?: Project$1[];
-    /** Paging metadata */
+    /** Paging metadata ? */
     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 {
@@ -3554,62 +3568,64 @@ interface GetProjectOptions {
     includePageUrl?: boolean | null;
 }
 interface ListProjectsOptions {
-    /** Projects limit per response is maximum 100, In the first request the cursor is None */
+    /** Projects limit per response is maximum 100, In the first request the cursor is None ? */
     paging?: CursorPaging$2;
-    /** Include page url */
+    /** Include page url ? */
     includePageUrl?: boolean | null;
 }
 interface UpdateProject {
-    /** project's cover photo */
+    /** Project cover image. */
     coverImage?: Image$1;
-    /** project's cover video */
+    /** Project cover video. */
     coverVideo?: Video$1;
     /**
-     * Project ID
+     * Project ID.
      * @readonly
      */
     _id?: string | null;
     /**
-     * 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
+     * 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.
      * @readonly
      */
     revision?: string | null;
+    /** Project title. */
     title?: string | null;
+    /** Project description. */
     description?: string | null;
-    /** indicates if the project should be hidden from Portfolio */
+    /** Whether the project is hidden from the portfolio. */
     hidden?: boolean | null;
-    /** 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) */
+    /** IDs of the collections that include the project. */
     collectionIds?: string[];
-    /** Custom project details */
+    /** Project details. */
     details?: ProjectDetail$1[];
-    /** Project's slug */
+    /** Project slug. */
     slug?: string | null;
     /**
-     * Represents the time this Project was created
+     * Date and time the project was created.
      * @readonly
      */
     _createdDate?: Date;
     /**
-     * Represents the time this Project was last updated
+     * Date and time the project was updated.
      * @readonly
      */
     _updatedDate?: Date;
     /**
-     * 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
+     * Project's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
      * @readonly
      */
     url?: string;
-    /** SEO data for the project */
+    /** Project SEO data. */
     seoData?: SeoSchema$1;
 }
 interface BulkUpdateProjectsOptions {
-    /** projects to be updated. */
+    /** Projects to update. */
     projects?: MaskedProject[];
-    /** Flag to return full entity in response */
+    /** Whether to include the updated projects in the response. Set to `true`` to receive the projects in the response. */
     returnFullEntity?: boolean | null;
 }
 interface QueryProjectsOptions {
-    /** Include page url */
+    /** Include page url ? */
     includePageUrl?: boolean | null | undefined;
 }
 interface QueryCursorResult$1 {
@@ -3695,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 {
@@ -3715,57 +3731,61 @@ interface GetProjectPageDataSignature {
 declare function createProject$1(httpClient: HttpClient): CreateProjectSignature;
 interface CreateProjectSignature {
     /**
-     * Creates a new Project
-     * @param - Project to be created
-     * @returns The created Project
+     * Creates a project.
+     * @param - Project to create.
+     * @returns Created project.
      */
     (project: Project$1): Promise<Project$1 & ProjectNonNullableFields$1>;
 }
 declare function getProject$1(httpClient: HttpClient): GetProjectSignature;
 interface GetProjectSignature {
     /**
-     * Get a Project by id
-     * @param - Id of the Project to retrieve
-     * @returns The retrieved Project
+     * Retrieves a project.
+     * @param - ID of the project to retrieve.
+     * @returns The requested project.
      */
     (projectId: string, options?: GetProjectOptions | undefined): Promise<Project$1 & ProjectNonNullableFields$1>;
 }
 declare function listProjects$1(httpClient: HttpClient): ListProjectsSignature;
 interface ListProjectsSignature {
     /**
-     * List all projects in portfolio by creation date
+     * Retrieves a list of all projects in a portfolio.
      */
     (options?: ListProjectsOptions | undefined): Promise<ListProjectsResponse & ListProjectsResponseNonNullableFields>;
 }
 declare function updateProject$1(httpClient: HttpClient): UpdateProjectSignature;
 interface UpdateProjectSignature {
     /**
-     * Update a Project, supports partial update
-     * Pass the latest `revision` for a successful update
-     * @param - Project ID
-     * @returns The updated Project
+     * Updates a project.
+     * @param - Project ID.
+     * @returns Updated project.
      */
     (_id: string | null, project: UpdateProject): Promise<Project$1 & ProjectNonNullableFields$1>;
 }
 declare function bulkUpdateProjects$1(httpClient: HttpClient): BulkUpdateProjectsSignature;
 interface BulkUpdateProjectsSignature {
     /**
-     * Update Projects in bulk
+     * Updates multiple projects.
      */
     (options?: BulkUpdateProjectsOptions | undefined): Promise<BulkUpdateProjectsResponse & BulkUpdateProjectsResponseNonNullableFields>;
 }
 declare function deleteProject$1(httpClient: HttpClient): DeleteProjectSignature;
 interface DeleteProjectSignature {
     /**
-     * Delete a Project
-     * @param - Id of the Project to delete
+     * Deletes a project.
+     * @param - ID of the project to delete.
      */
     (projectId: string): Promise<DeleteProjectResponse & DeleteProjectResponseNonNullableFields>;
 }
 declare function queryProjects$1(httpClient: HttpClient): QueryProjectsSignature;
 interface QueryProjectsSignature {
     /**
-     * Query Projects using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
+     * Retrieves a list of projects, given the provided paging, filtering, and sorting. Up to 100 projects can be returned per request.
+     *
+     * The default `sort` is `id` in `ASC`.
+     *
+     * For a detailed list of supported operations, see [Projects: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/sort-and-filter).
+     * To learn how to query projects, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
      */
     (options?: QueryProjectsOptions | undefined): ProjectsQueryBuilder;
 }
@@ -3774,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>;
@@ -3825,7 +3845,9 @@ declare const updateProjectOrderInCollection$2: MaybeContext<BuildRESTFunction<t
 declare const queryProjectsWithCollectionInfo: MaybeContext<BuildRESTFunction<typeof queryProjectsWithCollectionInfo$1> & typeof queryProjectsWithCollectionInfo$1>;
 
 type _publicOnProjectCreatedType = typeof onProjectCreated$1;
-/** */
+/**
+ * Triggered when a project is created.
+ */
 declare const onProjectCreated: ReturnType<typeof createEventModule$1<_publicOnProjectCreatedType>>;
 
 type _publicOnProjectUpdatedType = typeof onProjectUpdated$1;
@@ -3833,7 +3855,9 @@ type _publicOnProjectUpdatedType = typeof onProjectUpdated$1;
 declare const onProjectUpdated: ReturnType<typeof createEventModule$1<_publicOnProjectUpdatedType>>;
 
 type _publicOnProjectDeletedType = typeof onProjectDeleted$1;
-/** */
+/**
+ * Triggered when a project is deleted.
+ */
 declare const onProjectDeleted: ReturnType<typeof createEventModule$1<_publicOnProjectDeletedType>>;
 
 type context$2_App = App;
@@ -3914,62 +3938,67 @@ 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;
 }
-/** Project is the main entity of ProjectsService */
 interface Project extends ProjectCoverOneOf {
-    /** project's cover photo */
+    /** Project cover image. */
     coverImage?: Image;
-    /** project's cover video */
+    /** Project cover video. */
     coverVideo?: Video;
     /**
-     * Project ID
+     * Project ID.
      * @readonly
      */
     _id?: string | null;
     /**
-     * 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
+     * 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.
      * @readonly
      */
     revision?: string | null;
+    /** Project title. */
     title?: string | null;
+    /** Project description. */
     description?: string | null;
-    /** indicates if the project should be hidden from Portfolio */
+    /** Whether the project is hidden from the portfolio. */
     hidden?: boolean | null;
-    /** 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) */
+    /** IDs of the collections that include the project. */
     collectionIds?: string[];
-    /** Custom project details */
+    /** Project details. */
     details?: ProjectDetail[];
-    /** Project's slug */
+    /** Project slug. */
     slug?: string | null;
     /**
-     * Represents the time this Project was created
+     * Date and time the project was created.
      * @readonly
      */
     _createdDate?: Date;
     /**
-     * Represents the time this Project was last updated
+     * Date and time the project was updated.
      * @readonly
      */
     _updatedDate?: Date;
     /**
-     * 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
+     * Project's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
      * @readonly
      */
     url?: string;
-    /** SEO data for the project */
+    /** Project SEO data. */
     seoData?: SeoSchema;
 }
 /** @oneof */
 interface ProjectCoverOneOf {
-    /** project's cover photo */
+    /** Project cover image. */
     coverImage?: Image;
-    /** project's cover video */
+    /** Project cover video. */
     coverVideo?: Video;
 }
 interface Image {
@@ -4027,21 +4056,30 @@ interface VideoResolution {
     /** Video filename. */
     filename?: string | null;
 }
+/**
+ * Project label.
+ * One of:
+ * + `text`
+ * + `link`
+ */
 interface ProjectDetail extends ProjectDetailValueOneOf {
+    /** Project label in plain text format. */
     text?: string;
-    /** Details link */
+    /** Project label in link format. */
     link?: DetailsLink;
     label?: string;
 }
 /** @oneof */
 interface ProjectDetailValueOneOf {
+    /** Project label in plain text format. */
     text?: string;
-    /** Details link */
+    /** Project label in link format. */
     link?: DetailsLink;
 }
 interface DetailsLink {
+    /** Display text of the link. */
     text?: string | null;
-    /** link to external source */
+    /** Target URL of the link. */
     url?: string | null;
     /**
      * Whether the link opens in a new tab or window. One of:
@@ -4126,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 {
@@ -4188,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 {
@@ -4212,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 {
@@ -4453,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 {
@@ -4534,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>;
 }