@wix/portfolio 1.0.94 → 1.0.96

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

@@ -1645,56 +1645,55 @@ declare namespace meta$3 {
   export { type __PublicMethodMetaInfo$3 as __PublicMethodMetaInfo, meta$3_bulkCreateProjectItems as bulkCreateProjectItems, meta$3_bulkDeleteProjectItems as bulkDeleteProjectItems, meta$3_bulkUpdateProjectItems as bulkUpdateProjectItems, meta$3_createProjectItem as createProjectItem, meta$3_deleteProjectItem as deleteProjectItem, meta$3_duplicateProjectItems as duplicateProjectItems, meta$3_getProjectItem as getProjectItem, meta$3_listProjectItems as listProjectItems, meta$3_updateProjectItem as updateProjectItem };
 }
 
+/** Project is the main entity of ProjectsService */
 interface Project$3 extends ProjectCoverOneOf$3 {
-    /** Project cover image. */
+    /** project's cover photo */
     coverImage?: Image$3;
-    /** Project cover video. */
+    /** project's cover video */
     coverVideo?: Video$3;
     /**
-     * Project ID.
+     * Project ID
      * @readonly
      */
     id?: string | null;
     /**
-     * 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.
+     * 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
      * @readonly
      */
     revision?: string | null;
-    /** Project title. */
     title?: string | null;
-    /** Project description. */
     description?: string | null;
-    /** Whether the project is hidden from the portfolio. */
+    /** indicates if the project should be hidden from Portfolio */
     hidden?: boolean | null;
-    /** IDs of the collections that include the project. */
+    /** 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) */
     collectionIds?: string[];
-    /** Project details. */
+    /** Custom project details */
     details?: ProjectDetail$3[];
-    /** Project slug. */
+    /** Project's slug */
     slug?: string | null;
     /**
-     * Date and time the project was created.
+     * Represents the time this Project was created
      * @readonly
      */
     createdDate?: Date;
     /**
-     * Date and time the project was updated.
+     * Represents the time this Project was last updated
      * @readonly
      */
     updatedDate?: Date;
     /**
-     * Project's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
+     * 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
      * @readonly
      */
     url?: PageUrlV2$1;
-    /** Project SEO data. */
+    /** SEO data for the project */
     seoData?: SeoSchema$3;
 }
 /** @oneof */
 interface ProjectCoverOneOf$3 {
-    /** Project cover image. */
+    /** project's cover photo */
     coverImage?: Image$3;
-    /** Project cover video. */
+    /** project's cover video */
     coverVideo?: Video$3;
 }
 interface Image$3 {
@@ -1763,30 +1762,21 @@ interface VideoResolution$1 {
     /** Video filename. */
     filename?: string | null;
 }
-/**
- * Project label.
- * One of:
- * + `text`
- * + `link`
- */
 interface ProjectDetail$3 extends ProjectDetailValueOneOf$3 {
-    /** Project label in plain text format. */
     text?: string;
-    /** Project label in link format. */
+    /** Details link */
     link?: DetailsLink$3;
     label?: string;
 }
 /** @oneof */
 interface ProjectDetailValueOneOf$3 {
-    /** Project label in plain text format. */
     text?: string;
-    /** Project label in link format. */
+    /** Details link */
     link?: DetailsLink$3;
 }
 interface DetailsLink$3 {
-    /** Display text of the link. */
     text?: string | null;
-    /** Target URL of the link. */
+    /** link to external source */
     url?: string | null;
     /**
      * Whether the link opens in a new tab or window. One of:
@@ -1879,27 +1869,27 @@ interface ProjectSlug$1 {
     slug?: string;
 }
 interface CreateProjectRequest$1 {
-    /** Project to create. */
+    /** Project to be created */
     project: Project$3;
 }
 interface CreateProjectResponse$1 {
-    /** Created project. */
+    /** The created Project */
     project?: Project$3;
 }
 interface GetProjectRequest$1 {
-    /** ID of the project to retrieve. */
+    /** Id of the Project to retrieve */
     projectId: string;
     /** Include page url */
     includePageUrl?: boolean | null;
 }
 interface GetProjectResponse$1 {
-    /** The requested project. */
+    /** The retrieved Project */
     project?: Project$3;
 }
 interface ListProjectsRequest$1 {
-    /** 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$5;
-    /** Include page url ? */
+    /** Include page url */
     includePageUrl?: boolean | null;
 }
 interface CursorPaging$5 {
@@ -1914,9 +1904,9 @@ interface CursorPaging$5 {
     cursor?: string | null;
 }
 interface ListProjectsResponse$1 {
-    /** List of projects. */
+    /** The retrieved Projects */
     projects?: Project$3[];
-    /** Paging metadata ? */
+    /** Paging metadata */
     metadata?: PagingMetadataV2$5;
 }
 interface PagingMetadataV2$5 {
@@ -1938,33 +1928,33 @@ interface Cursors$5 {
     prev?: string | null;
 }
 interface UpdateProjectRequest$1 {
-    /** Project to update. */
+    /** Project to be updated, may be partial */
     project: Project$3;
 }
 interface UpdateProjectResponse$1 {
-    /** Updated project. */
+    /** The updated Project */
     project?: Project$3;
 }
 interface BulkUpdateProjectsRequest$1 {
-    /** Projects to update. */
+    /** projects to be updated. */
     projects?: MaskedProject$1[];
-    /** Whether to include the updated projects in the response. Set to `true`` to receive the projects in the response. */
+    /** Flag to return full entity in response */
     returnFullEntity?: boolean | null;
 }
 interface MaskedProject$1 {
-    /** Project to update. */
+    /** Project to be updated */
     project?: Project$3;
 }
 interface BulkUpdateProjectsResponse$1 {
-    /** Items created by bulk action. */
+    /** Array with all updated items results. */
     results?: BulkUpdateProjectsResult$1[];
-    /** Bulk action metadata. */
+    /** Holds metadata of the entire bulk update operation */
     bulkActionMetadata?: BulkActionMetadata$1;
 }
 interface BulkUpdateProjectsResult$1 {
-    /** Item metadata. */
+    /** Holds information about an item in bulk update - id, index in original request array, action successful, error (if failed). */
     itemMetadata?: ItemMetadata$1;
-    /** Updated project. */
+    /** Updated Project */
     project?: Project$3;
 }
 interface ItemMetadata$1 {
@@ -1994,17 +1984,17 @@ interface BulkActionMetadata$1 {
     undetailedFailures?: number;
 }
 interface DeleteProjectRequest$1 {
-    /** ID of the project to delete. */
+    /** Id of the Project to delete */
     projectId: string;
 }
 interface DeleteProjectResponse$1 {
-    /** ID of the deleted project. */
+    /** Id of the deleted Project */
     projectId?: string;
 }
 interface QueryProjectsRequest$1 {
-    /** Query options. */
+    /** WQL expression */
     query: QueryV2$3;
-    /** Include page url ? */
+    /** Include page url */
     includePageUrl?: boolean | null;
 }
 interface QueryV2$3 extends QueryV2PagingMethodOneOf$3 {
@@ -2053,9 +2043,9 @@ interface Paging$3 {
     offset?: number | null;
 }
 interface QueryProjectsResponse$1 {
-    /** List of projects. */
+    /** The retrieved Projects */
     projects?: Project$3[];
-    /** Paging metadata ? */
+    /** Paging metadata */
     metadata?: PagingMetadataV2$5;
 }
 interface UpdateProjectOrderInCollectionRequest$3 {
@@ -2223,56 +2213,55 @@ interface QueryProjectWithCollectionInfoResponseNonNullableFields$1 {
     projects: ProjectInCollectionNonNullableFields$3[];
 }
 
+/** Project is the main entity of ProjectsService */
 interface Project$2 extends ProjectCoverOneOf$2 {
-    /** Project cover image. */
+    /** project's cover photo */
     coverImage?: Image$2;
-    /** Project cover video. */
+    /** project's cover video */
     coverVideo?: Video$2;
     /**
-     * Project ID.
+     * Project ID
      * @readonly
      */
     _id?: string | null;
     /**
-     * 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.
+     * 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
      * @readonly
      */
     revision?: string | null;
-    /** Project title. */
     title?: string | null;
-    /** Project description. */
     description?: string | null;
-    /** Whether the project is hidden from the portfolio. */
+    /** indicates if the project should be hidden from Portfolio */
     hidden?: boolean | null;
-    /** IDs of the collections that include the project. */
+    /** 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) */
     collectionIds?: string[];
-    /** Project details. */
+    /** Custom project details */
     details?: ProjectDetail$2[];
-    /** Project slug. */
+    /** Project's slug */
     slug?: string | null;
     /**
-     * Date and time the project was created.
+     * Represents the time this Project was created
      * @readonly
      */
     _createdDate?: Date;
     /**
-     * Date and time the project was updated.
+     * Represents the time this Project was last updated
      * @readonly
      */
     _updatedDate?: Date;
     /**
-     * Project's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
+     * 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
      * @readonly
      */
     url?: string;
-    /** Project SEO data. */
+    /** SEO data for the project */
     seoData?: SeoSchema$2;
 }
 /** @oneof */
 interface ProjectCoverOneOf$2 {
-    /** Project cover image. */
+    /** project's cover photo */
     coverImage?: Image$2;
-    /** Project cover video. */
+    /** project's cover video */
     coverVideo?: Video$2;
 }
 interface Image$2 {
@@ -2298,30 +2287,21 @@ interface Video$2 {
     /** Manually defined Video duration in milliseconds. */
     durationInMillis?: number | null;
 }
-/**
- * Project label.
- * One of:
- * + `text`
- * + `link`
- */
 interface ProjectDetail$2 extends ProjectDetailValueOneOf$2 {
-    /** Project label in plain text format. */
     text?: string;
-    /** Project label in link format. */
+    /** Details link */
     link?: DetailsLink$2;
     label?: string;
 }
 /** @oneof */
 interface ProjectDetailValueOneOf$2 {
-    /** Project label in plain text format. */
     text?: string;
-    /** Project label in link format. */
+    /** Details link */
     link?: DetailsLink$2;
 }
 interface DetailsLink$2 {
-    /** Display text of the link. */
     text?: string | null;
-    /** Target URL of the link. */
+    /** link to external source */
     url?: string | null;
     /**
      * Whether the link opens in a new tab or window. One of:
@@ -2408,27 +2388,27 @@ interface ProjectSlug {
     slug?: string;
 }
 interface CreateProjectRequest {
-    /** Project to create. */
+    /** Project to be created */
     project: Project$2;
 }
 interface CreateProjectResponse {
-    /** Created project. */
+    /** The created Project */
     project?: Project$2;
 }
 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 requested project. */
+    /** The retrieved Project */
     project?: Project$2;
 }
 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$4;
-    /** Include page url ? */
+    /** Include page url */
     includePageUrl?: boolean | null;
 }
 interface CursorPaging$4 {
@@ -2443,9 +2423,9 @@ interface CursorPaging$4 {
     cursor?: string | null;
 }
 interface ListProjectsResponse {
-    /** List of projects. */
+    /** The retrieved Projects */
     projects?: Project$2[];
-    /** Paging metadata ? */
+    /** Paging metadata */
     metadata?: PagingMetadataV2$4;
 }
 interface PagingMetadataV2$4 {
@@ -2467,33 +2447,33 @@ interface Cursors$4 {
     prev?: string | null;
 }
 interface UpdateProjectRequest {
-    /** Project to update. */
+    /** Project to be updated, may be partial */
     project: Project$2;
 }
 interface UpdateProjectResponse {
-    /** Updated project. */
+    /** The updated Project */
     project?: Project$2;
 }
 interface BulkUpdateProjectsRequest {
-    /** Projects to update. */
+    /** projects to be updated. */
     projects?: MaskedProject[];
-    /** Whether to include the updated projects in the response. Set to `true`` to receive the projects in the response. */
+    /** Flag to return full entity in response */
     returnFullEntity?: boolean | null;
 }
 interface MaskedProject {
-    /** Project to update. */
+    /** Project to be updated */
     project?: Project$2;
 }
 interface BulkUpdateProjectsResponse {
-    /** Items created by bulk action. */
+    /** Array with all updated items results. */
     results?: BulkUpdateProjectsResult[];
-    /** Bulk action metadata. */
+    /** Holds metadata of the entire bulk update operation */
     bulkActionMetadata?: BulkActionMetadata;
 }
 interface BulkUpdateProjectsResult {
-    /** Item metadata. */
+    /** Holds information about an item in bulk update - id, index in original request array, action successful, error (if failed). */
     itemMetadata?: ItemMetadata;
-    /** Updated project. */
+    /** Updated Project */
     project?: Project$2;
 }
 interface ItemMetadata {
@@ -2523,17 +2503,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 {
-    /** Query options. */
+    /** WQL expression */
     query: QueryV2$2;
-    /** Include page url ? */
+    /** Include page url */
     includePageUrl?: boolean | null;
 }
 interface QueryV2$2 extends QueryV2PagingMethodOneOf$2 {
@@ -2582,9 +2562,9 @@ interface Paging$2 {
     offset?: number | null;
 }
 interface QueryProjectsResponse {
-    /** List of projects. */
+    /** The retrieved Projects */
     projects?: Project$2[];
-    /** Paging metadata ? */
+    /** Paging metadata */
     metadata?: PagingMetadataV2$4;
 }
 interface UpdateProjectOrderInCollectionRequest$2 {
@@ -2784,56 +2764,55 @@ interface ProjectInCollection$1 {
     /** The sort order of the project in the given Collection */
     sortOrder?: number | null;
 }
+/** Project is the main entity of ProjectsService */
 interface Project$1 extends ProjectCoverOneOf$1 {
-    /** Project cover image. */
+    /** project's cover photo */
     coverImage?: Image$1;
-    /** Project cover video. */
+    /** project's cover video */
     coverVideo?: Video$1;
     /**
-     * Project ID.
+     * Project ID
      * @readonly
      */
     id?: string | null;
     /**
-     * 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.
+     * 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
      * @readonly
      */
     revision?: string | null;
-    /** Project title. */
     title?: string | null;
-    /** Project description. */
     description?: string | null;
-    /** Whether the project is hidden from the portfolio. */
+    /** indicates if the project should be hidden from Portfolio */
     hidden?: boolean | null;
-    /** IDs of the collections that include the project. */
+    /** 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) */
     collectionIds?: string[];
-    /** Project details. */
+    /** Custom project details */
     details?: ProjectDetail$1[];
-    /** Project slug. */
+    /** Project's slug */
     slug?: string | null;
     /**
-     * Date and time the project was created.
+     * Represents the time this Project was created
      * @readonly
      */
     createdDate?: Date;
     /**
-     * Date and time the project was updated.
+     * Represents the time this Project was last updated
      * @readonly
      */
     updatedDate?: Date;
     /**
-     * Project's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
+     * 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
      * @readonly
      */
     url?: PageUrlV2;
-    /** Project SEO data. */
+    /** SEO data for the project */
     seoData?: SeoSchema$1;
 }
 /** @oneof */
 interface ProjectCoverOneOf$1 {
-    /** Project cover image. */
+    /** project's cover photo */
     coverImage?: Image$1;
-    /** Project cover video. */
+    /** project's cover video */
     coverVideo?: Video$1;
 }
 interface Image$1 {
@@ -2902,30 +2881,21 @@ interface VideoResolution {
     /** 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;
-    /** Project label in link format. */
+    /** Details link */
     link?: DetailsLink$1;
     label?: string;
 }
 /** @oneof */
 interface ProjectDetailValueOneOf$1 {
-    /** Project label in plain text format. */
     text?: string;
-    /** Project label in link format. */
+    /** Details link */
     link?: DetailsLink$1;
 }
 interface DetailsLink$1 {
-    /** Display text of the link. */
     text?: string | null;
-    /** Target URL of the link. */
+    /** link to external source */
     url?: string | null;
     /**
      * Whether the link opens in a new tab or window. One of:
@@ -3187,56 +3157,55 @@ 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 cover image. */
+    /** project's cover photo */
     coverImage?: Image;
-    /** Project cover video. */
+    /** project's cover video */
     coverVideo?: Video;
     /**
-     * Project ID.
+     * Project ID
      * @readonly
      */
     _id?: string | null;
     /**
-     * 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.
+     * 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
      * @readonly
      */
     revision?: string | null;
-    /** Project title. */
     title?: string | null;
-    /** Project description. */
     description?: string | null;
-    /** Whether the project is hidden from the portfolio. */
+    /** indicates if the project should be hidden from Portfolio */
     hidden?: boolean | null;
-    /** IDs of the collections that include the project. */
+    /** 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) */
     collectionIds?: string[];
-    /** Project details. */
+    /** Custom project details */
     details?: ProjectDetail[];
-    /** Project slug. */
+    /** Project's slug */
     slug?: string | null;
     /**
-     * Date and time the project was created.
+     * Represents the time this Project was created
      * @readonly
      */
     _createdDate?: Date;
     /**
-     * Date and time the project was updated.
+     * Represents the time this Project was last updated
      * @readonly
      */
     _updatedDate?: Date;
     /**
-     * Project's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
+     * 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
      * @readonly
      */
     url?: string;
-    /** Project SEO data. */
+    /** SEO data for the project */
     seoData?: SeoSchema;
 }
 /** @oneof */
 interface ProjectCoverOneOf {
-    /** Project cover image. */
+    /** project's cover photo */
     coverImage?: Image;
-    /** Project cover video. */
+    /** project's cover video */
     coverVideo?: Video;
 }
 interface Image {
@@ -3262,30 +3231,21 @@ interface Video {
     /** Manually defined Video duration in milliseconds. */
     durationInMillis?: number | null;
 }
-/**
- * Project label.
- * One of:
- * + `text`
- * + `link`
- */
 interface ProjectDetail extends ProjectDetailValueOneOf {
-    /** Project label in plain text format. */
     text?: string;
-    /** Project label in link format. */
+    /** Details link */
     link?: DetailsLink;
     label?: string;
 }
 /** @oneof */
 interface ProjectDetailValueOneOf {
-    /** Project label in plain text format. */
     text?: string;
-    /** Project label in link format. */
+    /** Details link */
     link?: DetailsLink;
 }
 interface DetailsLink {
-    /** Display text of the link. */
     text?: string | null;
-    /** Target URL of the link. */
+    /** link to external source */
     url?: string | null;
     /**
      * Whether the link opens in a new tab or window. One of: