@wix/portfolio 1.0.9 → 1.0.10

package/build/es/src/portfolio-projects-v1-project.universal.d.ts

@@ -5,7 +5,7 @@ export declare const __debug: {
     };
 };
 /** Project is the main entity of ProjectsService */
-export interface Project {
+export interface Project extends ProjectCoverOneOf {
     /**
      * Project ID
      * @readonly
@@ -13,14 +13,10 @@ export interface Project {
     _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?: string | null;
-    /** Project name */
     title?: string | null;
-    /** Project description */
     description?: string | null;
     /** indicates if the project should be hidden from Portfolio */
     hidden?: boolean | null;
-    /** project's cover photo */
-    coverImage?: CommonImage;
     /** Collections must exist to be added to a project. can be created/updated/deleted using this //TODO */
     collectionIds?: string[];
     /** Custom project details */
@@ -42,23 +38,28 @@ export interface Project {
      */
     url?: string;
     seoData?: SeoSchema;
+    /**
+     * indicates if the project is synced from external platform (via integration page) and therefore will be updated from the external platform on daily basis
+     * @readonly
+     */
+    syncedProject?: boolean | null;
+    /** project's cover photo */
+    coverImage?: CommonImage;
+    /** project's cover video */
+    coverVideo?: Video;
+}
+/** @oneof */
+export interface ProjectCoverOneOf {
+    /** project's cover photo */
+    coverImage?: CommonImage;
+    /** project's cover video */
+    coverVideo?: Video;
 }
 export interface CommonImage {
-    /** Image info - Wix Media Image. Required. */
+    /** Image info - Wix Media Image. */
     imageInfo?: string;
     /** Focal point of the image. */
     focalPoint?: CommonPoint;
-    /** Set of key-value pairs describing the media in [Exchangeable Image File format](https://en.wikipedia.org/wiki/Exif). */
-    exif?: Record<string, any> | null;
-    /**
-     * Image compression level. <br />
-     *
-     * Min: `30` <br />
-     * Max: `100`
-     */
-    quality?: number | null;
-    /** [Unsharp masking](https://en.wikipedia.org/wiki/Unsharp_masking) values of the image. */
-    unsharpMasking?: CommonUnsharpMasking;
 }
 export declare enum ImageImageType {
     UNDEFINED = "UNDEFINED",
@@ -89,35 +90,46 @@ export interface CommonUnsharpMasking {
      */
     threshold?: number | null;
 }
+export interface Video {
+    /** Video info - Wix Media Image. */
+    videoInfo?: string;
+    /** Manually defined Video duration in milliseconds. */
+    durationInMillis?: number | null;
+}
+export declare enum VideoType {
+    UNDEFINED = "UNDEFINED",
+    WIX_MEDIA = "WIX_MEDIA",
+    YOUTUBE = "YOUTUBE",
+    VIMEO = "VIMEO"
+}
+export interface VideoResolution {
+    /** Video URL.  Required. */
+    url?: string;
+    /** Video height. Required. */
+    height?: number;
+    /** Video width.  Required. */
+    width?: number;
+    /** Video format for example, mp4, hls.  Required. */
+    format?: string;
+    /** Video quality for example 480p, 720p. */
+    quality?: string | null;
+    /** Video filename. */
+    filename?: string | null;
+}
 export interface ProjectDetail extends ProjectDetailValueOneOf {
-    /** key of the detail field from predefined list */
-    key?: Key;
-    /** display label of the key */
     label?: string;
-    /** text value */
     text?: string;
-    /** number value */
-    number?: number;
-    /** date value */
-    date?: Date;
+    link?: DetailsLink;
 }
 /** @oneof */
 export interface ProjectDetailValueOneOf {
-    /** text value */
     text?: string;
-    /** number value */
-    number?: number;
-    /** date value */
-    date?: Date;
+    link?: DetailsLink;
 }
-export declare enum Key {
-    UNDEFINED = "UNDEFINED",
-    ROLE = "ROLE",
-    LOCATION = "LOCATION",
-    DATE = "DATE",
-    CUSTOM = "CUSTOM",
-    /** examples of values: "real estate", "photography" */
-    PROJECT_TYPE = "PROJECT_TYPE"
+export interface DetailsLink {
+    text?: string | null;
+    /** link to external source */
+    url?: string | null;
 }
 export interface ProjectSource {
     appDefId?: string;
@@ -149,13 +161,21 @@ export interface SeoSchema {
     settings?: Settings;
 }
 export interface Tag {
-    /** SEO tag type. Supported values: `title`, `meta`, `script`, `link`. */
+    /**
+     * SEO tag type.
+     *
+     *
+     * Supported values: `title`, `meta`, `script`, `link`.
+     */
     type?: string;
-    /** SEO tag attributes/properties (name, content, rel, href). */
+    /**
+     * A `{'key':'value'} pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.
+     * For example: `{'name': 'description', 'content': 'the description itself'}`.
+     */
     props?: Record<string, any> | null;
-    /** Tag meta data, e.g. {height: 300, width: 240}. */
+    /** SEO tag meta data. For example, `{height: 300, width: 240}`. */
     meta?: Record<string, any> | null;
-    /** Tag inner content e.g. `<title> inner content </title>`. */
+    /** SEO tag inner content. For example, `<title> inner content </title>`. */
     children?: string;
     /** Whether the tag is a custom tag. */
     custom?: boolean;
@@ -163,7 +183,12 @@ export interface Tag {
     disabled?: boolean;
 }
 export interface Settings {
-    /** disable auto creation of 301 redirects on slug changes (enabled by default). */
+    /**
+     * Whether the auto redirects feature creating `301 redirects` on a slug change is enabled.
+     *
+     *
+     * Default: enabled
+     */
     preventAutoRedirect?: boolean;
 }
 export interface GetProjectPageDataRequest {
@@ -374,6 +399,9 @@ export interface NamespaceChanged {
 }
 export interface Empty {
 }
+export interface DummyMenuHelperResponse {
+    response?: string | null;
+}
 export interface InvalidateCache extends InvalidateCacheGetByOneOf {
     /** tell us why you're invalidating the cache. You don't need to add your app name */
     reason?: string | null;
@@ -459,8 +487,6 @@ export interface ListProjectsResponse {
     /** The retrieved Projects */
     projects?: Project[];
     /** Paging metadata */
-    pagingMetadataV2?: PagingMetadataV2;
-    /** Paging metadata */
     metadata?: PagingMetadataV2;
 }
 export interface PagingMetadataV2 {
@@ -484,8 +510,6 @@ export interface Cursors {
 export interface UpdateProjectRequest {
     /** Project to be updated, may be partial */
     project: Project;
-    /** Explicit list of fields to update */
-    mask?: string[];
 }
 export interface UpdateProjectResponse {
     /** The updated Project */
@@ -494,8 +518,6 @@ export interface UpdateProjectResponse {
 export interface DeleteProjectRequest {
     /** Id of the Project to delete */
     projectId: string;
-    /** The revision of the Project */
-    revision?: string;
 }
 export interface DeleteProjectResponse {
     /** Id of the deleted Project */
@@ -557,8 +579,6 @@ export interface QueryProjectsResponse {
     /** The retrieved Projects */
     projects?: Project[];
     /** Paging metadata */
-    pagingMetadataV2?: PagingMetadataV2;
-    /** Paging metadata */
     metadata?: PagingMetadataV2;
 }
 export interface UpdateProjectOrderInCollectionRequest {
@@ -598,8 +618,6 @@ export interface QueryProjectWithCollectionInfoResponse {
     /** The retrieved Projects in Collection */
     projects?: ProjectInCollection[];
     /** Paging metadata */
-    pagingMetadataV2?: PagingMetadataV2;
-    /** Paging metadata */
     metadata?: PagingMetadataV2;
 }
 export interface DomainEvent extends DomainEventBodyOneOf {
@@ -677,6 +695,7 @@ export interface ExtendedFieldsUpdatedEvent {
  * Creates a new Project
  * @param project - Project to be created
  * @public
+ * @documentationMaturity preview
  * @requiredField project
  * @requiredField project.source.appDefId
  * @requiredField project.source.externalId
@@ -688,6 +707,7 @@ export declare function createProject(project: Project): Promise<Project>;
  * Get a Project by id
  * @param projectId - Id of the Project to retrieve
  * @public
+ * @documentationMaturity preview
  * @requiredField projectId
  * @returns The retrieved Project
  */
@@ -697,7 +717,9 @@ export interface GetProjectOptions {
 }
 /**
  * List all projects in portfolio by creation date
- * @public */
+ * @public
+ * @documentationMaturity preview
+ */
 export declare function listProjects(options?: ListProjectsOptions): Promise<ListProjectsResponse>;
 export interface ListProjectsOptions {
     /** Projects limit per response is maximum 100, In the first request the cursor is None */
@@ -709,12 +731,13 @@ export interface ListProjectsOptions {
  * Pass the latest `revision` for a successful update
  * @param _id - Project ID
  * @public
+ * @documentationMaturity preview
  * @requiredField _id
  * @requiredField project
  * @requiredField project.revision
  * @returns The updated Project
  */
-export declare function updateProject(_id: string | null, project: UpdateProject, options?: UpdateProjectOptions): Promise<Project>;
+export declare function updateProject(_id: string | null, project: UpdateProject): Promise<Project>;
 export interface UpdateProject {
     /**
      * Project ID
@@ -723,14 +746,10 @@ export interface UpdateProject {
     _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?: string | null;
-    /** Project name */
     title?: string | null;
-    /** Project description */
     description?: string | null;
     /** indicates if the project should be hidden from Portfolio */
     hidden?: boolean | null;
-    /** project's cover photo */
-    coverImage?: CommonImage;
     /** Collections must exist to be added to a project. can be created/updated/deleted using this //TODO */
     collectionIds?: string[];
     /** Custom project details */
@@ -752,27 +771,31 @@ export interface UpdateProject {
      */
     url?: string;
     seoData?: SeoSchema;
-}
-export interface UpdateProjectOptions {
-    /** Explicit list of fields to update */
-    mask?: string[];
+    /**
+     * indicates if the project is synced from external platform (via integration page) and therefore will be updated from the external platform on daily basis
+     * @readonly
+     */
+    syncedProject?: boolean | null;
+    /** project's cover photo */
+    coverImage?: CommonImage;
+    /** project's cover video */
+    coverVideo?: Video;
 }
 /**
  * Delete a Project
  * @param projectId - Id of the Project to delete
  * @public
+ * @documentationMaturity preview
  * @requiredField projectId
  */
-export declare function deleteProject(projectId: string, options?: DeleteProjectOptions): Promise<DeleteProjectResponse>;
-export interface DeleteProjectOptions {
-    /** The revision of the Project */
-    revision?: string;
-}
+export declare function deleteProject(projectId: string): Promise<DeleteProjectResponse>;
 /**
  * Query Projects using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
  * @public */
 export declare function queryProjects(options?: QueryProjectsOptions): ProjectsQueryBuilder;
-export declare type QueryProjectsOptions = Omit<QueryProjectsRequest, 'query'>;
+export interface QueryProjectsOptions {
+    includePageUrl?: boolean | null | undefined;
+}
 interface QueryCursorResult {
     hasNext: () => boolean;
     hasPrev: () => boolean;
@@ -794,6 +817,14 @@ export interface ProjectsQueryBuilder {
      * @param value - Value to compare against.
      */
     ne: (propertyName: string, value: any) => ProjectsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    gt: (propertyName: string, value: any) => ProjectsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    lt: (propertyName: string, value: any) => ProjectsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `string`.
      * @param string - String to compare against. Case-insensitive.
      */
@@ -802,6 +833,10 @@ export interface ProjectsQueryBuilder {
      * @param values - List of values to compare against.
      */
     hasSome: (propertyName: string, value: any[]) => ProjectsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     */
+    hasAll: (propertyName: string, value: any[]) => ProjectsQueryBuilder;
     in: (propertyName: string, value: any) => ProjectsQueryBuilder;
     exists: (propertyName: string, value: boolean) => ProjectsQueryBuilder;
     /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
@@ -816,6 +851,7 @@ export interface ProjectsQueryBuilder {
  * Updates Project's order in a given Collection
  * @param sortOrder - The new sort order of the project in the given collection
  * @public
+ * @documentationMaturity preview
  * @requiredField identifiers
  * @requiredField identifiers.collectionId
  * @requiredField identifiers.projectId
@@ -838,6 +874,7 @@ export interface UpdateProjectOrderInCollectionIdentifiers {
  * If you want to Query project by Project properties please use Query Projects method - link //TODO
  * @param query - WQL expression
  * @public
+ * @documentationMaturity preview
  * @requiredField query
  */
 export declare function queryProjectsWithCollectionInfo(query: QueryV2, options?: QueryProjectsWithCollectionInfoOptions): Promise<QueryProjectWithCollectionInfoResponse>;