@wix/portfolio 1.0.95 → 1.0.97

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

@@ -408,50 +408,53 @@ type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
     host: Host;
 } ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
 
-/** Collection is the main entity of CollectionsService */
 interface Collection {
     /**
-     * Collection ID
+     * Collection 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 collection is updated. To prevent conflicting changes, the existing revision must be passed when updating the collection object.
      * @readonly
      */
     revision?: string | null;
-    /** Title of Collection */
+    /** Collection title. */
     title?: string | null;
-    /** Description of Collection */
+    /** Collection description. */
     description?: string | null;
-    /** Url of Collection */
+    /** Collection slug. */
     slug?: string | null;
-    /** Collection's cover photo */
+    /** Collection cover image. */
     coverImage?: Image$3;
-    /** Indicates if the collection is hidden from Portfolio */
+    /** Whether the collection is hidden from the portfolio. */
     hidden?: boolean | null;
-    /** if not present in an update it means the collection will be added as currentTimestamp - as the last collection */
+    /**
+     * Index that determines which position a media item is displayed in the gallery. <br />
+     *
+     * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
+     */
     sortOrder?: number | null;
     /**
-     * Represents the time this Collection was created
+     * Date and time the collection was created.
      * @readonly
      */
     _createdDate?: Date;
     /**
-     * Represents the time this Collection was last updated
+     * Date and time the collection was updated.
      * @readonly
      */
     _updatedDate?: Date;
     /**
-     * Url and relative url of Collection - in order to receive this field in READ requests you will need to pass the `include_page_url` field as part of request
+     * Collection'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 Collection */
+    /** Collection SEO data. */
     seoData?: SeoSchema$2;
 }
 interface Image$3 {
-    /** Image info - Wix Media Image. */
+    /** Information about the Wix Media image. */
     imageInfo?: string;
     /** Focal point of the image. */
     focalPoint?: Point$3;
@@ -674,27 +677,27 @@ interface File$2 {
     fileName?: string;
 }
 interface CreateCollectionRequest {
-    /** Collection to be created */
+    /** Collection to create. */
     collection: Collection;
 }
 interface CreateCollectionResponse {
-    /** The created Collection */
+    /** Created collection. */
     collection?: Collection;
 }
 interface GetCollectionRequest {
-    /** Id of the Collection to retrieve */
+    /** ID of the collection to retrieve. */
     collectionId: string;
-    /** Include page url */
+    /** Whether to include the collection's page URL and relative path in the response. */
     includePageUrl?: boolean | null;
 }
 interface GetCollectionResponse {
-    /** The retrieved Collection */
+    /** The requested collection. */
     collection?: Collection;
 }
 interface ListCollectionsRequest {
-    /** Maximum limit per response is 100, in first request cursor is None */
+    /** Maximum limit per response is 100, in first request cursor is None ? */
     paging?: CursorPaging$4;
-    /** Include page url */
+    /** Whether to include the collection's page URL and relative path in the response. */
     includePageUrl?: boolean | null;
 }
 interface CursorPaging$4 {
@@ -709,9 +712,9 @@ interface CursorPaging$4 {
     cursor?: string | null;
 }
 interface ListCollectionsResponse {
-    /** Retrieved Collections */
+    /** List of collections. */
     collections?: Collection[];
-    /** Paging metadata */
+    /** Paging metadata. */
     metadata?: PagingMetadataV2$4;
 }
 interface PagingMetadataV2$4 {
@@ -733,25 +736,25 @@ interface Cursors$4 {
     prev?: string | null;
 }
 interface UpdateCollectionRequest {
-    /** Collection to be updated, may be partial */
+    /** Collection to update. */
     collection: Collection;
 }
 interface UpdateCollectionResponse {
-    /** The updated Collection */
+    /** Updated collection. */
     collection?: Collection;
 }
 interface DeleteCollectionRequest {
-    /** Id of the Collection to delete */
+    /** ID of the collection to delete. */
     collectionId: string;
 }
 interface DeleteCollectionResponse {
-    /** Id of the Deleted Collection */
+    /** ID of the deleted collection. */
     collectionId?: string;
 }
 interface QueryCollectionsRequest {
-    /** WQL expression */
+    /** Query options. */
     query: QueryV2$3;
-    /** Include page url */
+    /** Whether to include the collection's page URL and relative path in the response. */
     includePageUrl?: boolean | null;
 }
 interface QueryV2$3 extends QueryV2PagingMethodOneOf$3 {
@@ -800,9 +803,9 @@ interface Paging$3 {
     offset?: number | null;
 }
 interface QueryCollectionsResponse {
-    /** The retrieved Collections */
+    /** List of collections. */
     collections?: Collection[];
-    /** Paging metadata */
+    /** Paging metadata. */
     metadata?: PagingMetadataV2$4;
 }
 interface MessageEnvelope$5 {
@@ -953,58 +956,62 @@ interface CollectionDeletedEnvelope {
     metadata: EventMetadata$3;
 }
 interface GetCollectionOptions {
-    /** Include page url */
+    /** Whether to include the collection's page URL and relative path in the response. */
     includePageUrl?: boolean | null;
 }
 interface ListCollectionsOptions {
-    /** Maximum limit per response is 100, in first request cursor is None */
+    /** Maximum limit per response is 100, in first request cursor is None ? */
     paging?: CursorPaging$4;
-    /** Include page url */
+    /** Whether to include the collection's page URL and relative path in the response. */
     includePageUrl?: boolean | null;
 }
 interface UpdateCollection {
     /**
-     * Collection ID
+     * Collection 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 collection is updated. To prevent conflicting changes, the existing revision must be passed when updating the collection object.
      * @readonly
      */
     revision?: string | null;
-    /** Title of Collection */
+    /** Collection title. */
     title?: string | null;
-    /** Description of Collection */
+    /** Collection description. */
     description?: string | null;
-    /** Url of Collection */
+    /** Collection slug. */
     slug?: string | null;
-    /** Collection's cover photo */
+    /** Collection cover image. */
     coverImage?: Image$3;
-    /** Indicates if the collection is hidden from Portfolio */
+    /** Whether the collection is hidden from the portfolio. */
     hidden?: boolean | null;
-    /** if not present in an update it means the collection will be added as currentTimestamp - as the last collection */
+    /**
+     * Index that determines which position a media item is displayed in the gallery. <br />
+     *
+     * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
+     */
     sortOrder?: number | null;
     /**
-     * Represents the time this Collection was created
+     * Date and time the collection was created.
      * @readonly
      */
     _createdDate?: Date;
     /**
-     * Represents the time this Collection was last updated
+     * Date and time the collection was updated.
      * @readonly
      */
     _updatedDate?: Date;
     /**
-     * Url and relative url of Collection - in order to receive this field in READ requests you will need to pass the `include_page_url` field as part of request
+     * Collection'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 Collection */
+    /** Collection SEO data. */
     seoData?: SeoSchema$2;
 }
 interface QueryCollectionsOptions {
-    /** Include page url */
+    /** Whether to include the collection's page URL and relative path in the response. */
     includePageUrl?: boolean | null | undefined;
 }
 interface QueryCursorResult$2 {
@@ -1088,50 +1095,54 @@ interface CollectionsQueryBuilder {
 declare function createCollection$1(httpClient: HttpClient): CreateCollectionSignature;
 interface CreateCollectionSignature {
     /**
-     * Creates a new Collection
-     * @param - Collection to be created
-     * @returns The created Collection
+     * Creates a collection.
+     * @param - Collection to create.
+     * @returns Created collection.
      */
     (collection: Collection): Promise<Collection & CollectionNonNullableFields>;
 }
 declare function getCollection$1(httpClient: HttpClient): GetCollectionSignature;
 interface GetCollectionSignature {
     /**
-     * Get a Collection by id
-     * @param - Id of the Collection to retrieve
-     * @returns The retrieved Collection
+     * Retrieves a collection.
+     * @param - ID of the collection to retrieve.
+     * @returns The requested collection.
      */
     (collectionId: string, options?: GetCollectionOptions | undefined): Promise<Collection & CollectionNonNullableFields>;
 }
 declare function listCollections$1(httpClient: HttpClient): ListCollectionsSignature;
 interface ListCollectionsSignature {
     /**
-     * List all Collections in portfolio
+     * Retrieves a list all collections in a portfolio.
      */
     (options?: ListCollectionsOptions | undefined): Promise<ListCollectionsResponse & ListCollectionsResponseNonNullableFields>;
 }
 declare function updateCollection$1(httpClient: HttpClient): UpdateCollectionSignature;
 interface UpdateCollectionSignature {
     /**
-     * Update a Collection, supports partial update
-     * Pass the latest `revision` for a successful update
-     * @param - Collection ID
-     * @returns The updated Collection
+     * Updates a collection.
+     * @param - Collection ID.
+     * @returns Updated collection.
      */
     (_id: string | null, collection: UpdateCollection): Promise<Collection & CollectionNonNullableFields>;
 }
 declare function deleteCollection$1(httpClient: HttpClient): DeleteCollectionSignature;
 interface DeleteCollectionSignature {
     /**
-     * Delete a Collection
-     * @param - Id of the Collection to delete
+     * Deletes a collection.
+     * @param - ID of the collection to delete.
      */
     (collectionId: string): Promise<DeleteCollectionResponse & DeleteCollectionResponseNonNullableFields>;
 }
 declare function queryCollections$1(httpClient: HttpClient): QueryCollectionsSignature;
 interface QueryCollectionsSignature {
     /**
-     * Query Collections using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
+     * Retrieves a list of collections, given the provided paging, filtering, and sorting. Up to 100 collections can be returned per request.
+     *
+     * The default `sort` is `id` in `ASC`.
+     *
+     * For a detailed list of supported operations, see [Collections: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/portfolio/collections/sort-and-filter).
+     * To learn how to query collections, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
      */
     (options?: QueryCollectionsOptions | undefined): CollectionsQueryBuilder;
 }
@@ -1167,15 +1178,21 @@ declare const deleteCollection: MaybeContext<BuildRESTFunction<typeof deleteColl
 declare const queryCollections: MaybeContext<BuildRESTFunction<typeof queryCollections$1> & typeof queryCollections$1>;
 
 type _publicOnCollectionCreatedType = typeof onCollectionCreated$1;
-/** */
+/**
+ * Triggered when a collection is created.
+ */
 declare const onCollectionCreated: ReturnType<typeof createEventModule$3<_publicOnCollectionCreatedType>>;
 
 type _publicOnCollectionUpdatedType = typeof onCollectionUpdated$1;
-/** */
+/**
+ * Triggered when a collection is updated.
+ */
 declare const onCollectionUpdated: ReturnType<typeof createEventModule$3<_publicOnCollectionUpdatedType>>;
 
 type _publicOnCollectionDeletedType = typeof onCollectionDeleted$1;
-/** */
+/**
+ * Triggered when a collection is deleted.
+ */
 declare const onCollectionDeleted: ReturnType<typeof createEventModule$3<_publicOnCollectionDeletedType>>;
 
 type context$5_AdminRemoveMenuItemsResponse = AdminRemoveMenuItemsResponse;
@@ -1534,7 +1551,7 @@ declare enum Type {
     VIDEO = "VIDEO"
 }
 interface Image$2 {
-    /** Image info - Wix Media Image. */
+    /** Information about the Wix Media image. */
     imageInfo?: string;
     /** Focal point of the image. */
     focalPoint?: Point$2;
@@ -1569,7 +1586,7 @@ interface UnsharpMasking$2 {
     threshold?: number | null;
 }
 interface Video$2 {
-    /** Video info - Wix Media Image. */
+    /** Information about the Wix Media video. */
     videoInfo?: string;
     /** Manually defined Video duration in milliseconds. */
     durationInMillis?: number | null;
@@ -2444,59 +2461,60 @@ 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 {
-    /** Image info - Wix Media Image. */
+    /** Information about the Wix Media image. */
     imageInfo?: string;
     /** Focal point of the image. */
     focalPoint?: Point$1;
@@ -2531,7 +2549,7 @@ interface UnsharpMasking$1 {
     threshold?: number | null;
 }
 interface Video$1 {
-    /** Video info - Wix Media Image. */
+    /** Information about the Wix Media video. */
     videoInfo?: string;
     /** Manually defined Video duration in milliseconds. */
     durationInMillis?: number | null;
@@ -2550,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:
@@ -3070,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 {
@@ -3105,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 {
@@ -3129,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 {
@@ -3185,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 {
@@ -3244,9 +3271,9 @@ 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 {
@@ -3537,62 +3564,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 {
@@ -3698,57 +3727,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;
 }
@@ -3808,7 +3841,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;
@@ -3816,7 +3851,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;
@@ -3904,59 +3941,60 @@ interface ProjectInCollection {
     /** The sort order of the project in the given Collection */
     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 {
-    /** Image info - Wix Media Image. */
+    /** Information about the Wix Media image. */
     imageInfo?: string;
     /** Focal point of the image. */
     focalPoint?: Point;
@@ -3991,7 +4029,7 @@ interface UnsharpMasking {
     threshold?: number | null;
 }
 interface Video {
-    /** Video info - Wix Media Image. */
+    /** Information about the Wix Media video. */
     videoInfo?: string;
     /** Manually defined Video duration in milliseconds. */
     durationInMillis?: number | null;
@@ -4010,21 +4048,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: