@wix/portfolio 1.0.9 → 1.0.11

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,102 @@ export interface NamespaceChanged {
 }
 export interface Empty {
 }
+export interface HtmlSitePublished {
+    /** Application instance ID */
+    appInstanceId?: string;
+    /** Application type */
+    appType?: string;
+    /** Revision */
+    revision?: string;
+    /** MSID */
+    metaSiteId?: string | null;
+    /** optional branch id if publish is done from branch */
+    branchId?: string | null;
+    /** The site's last transactionId */
+    lastTransactionId?: string | null;
+    /** A list of the site's pages */
+    pages?: EventsPage[];
+    /** Site's publish date */
+    publishDate?: string;
+}
+export interface EventsPage {
+    /** Page's Id */
+    _id?: string;
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    /** random GUID so clients can tell if event was already handled */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /**
+     * Assuming that all messages including Actions have id
+     * Example: The id of the specific order, the id of a specific campaign
+     */
+    entityId?: string;
+    /** The time of the event. Useful if there was a delay in dispatching */
+    eventTime?: Date;
+    /**
+     * A field that should be set if this event was triggered by an anonymize request.
+     * For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.
+     * NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
+}
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntityAsJson?: string;
+}
+export interface EntityDeletedEvent {
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+export interface ExtendedFieldsUpdatedEvent {
+    currentEntityAsJson?: string;
+}
+export interface AdminUpdatePortfolioMenuResponse {
+    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 +580,6 @@ export interface ListProjectsResponse {
     /** The retrieved Projects */
     projects?: Project[];
     /** Paging metadata */
-    pagingMetadataV2?: PagingMetadataV2;
-    /** Paging metadata */
     metadata?: PagingMetadataV2;
 }
 export interface PagingMetadataV2 {
@@ -484,8 +603,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 +611,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,21 +672,19 @@ export interface QueryProjectsResponse {
     /** The retrieved Projects */
     projects?: Project[];
     /** Paging metadata */
-    pagingMetadataV2?: PagingMetadataV2;
-    /** Paging metadata */
     metadata?: PagingMetadataV2;
 }
 export interface UpdateProjectOrderInCollectionRequest {
     /** Id of the Project to update its order */
-    projectId: string;
+    projectId?: string;
     /** Id of the collection in which the project will be re-ordered */
-    collectionId: string;
+    collectionId?: string;
     /** The new sort order of the project in the given collection */
-    sortOrder: number | null;
+    sortOrder?: number | null;
 }
 export interface UpdateProjectOrderInCollectionResponse {
     /** project with new sort order set */
-    project?: ProjectInCollection;
+    projectInCollection?: ProjectInCollection;
 }
 export interface ProjectInCollection {
     /** Collection ID */
@@ -591,113 +704,42 @@ export interface ProjectOrderInCollectionUpdatedEvent {
 }
 export interface QueryProjectWithCollectionInfoRequest {
     /** WQL expression */
-    query: QueryV2;
+    query?: QueryV2;
     includePageUrl?: boolean | null;
 }
 export interface QueryProjectWithCollectionInfoResponse {
     /** The retrieved Projects in Collection */
     projects?: ProjectInCollection[];
     /** Paging metadata */
-    pagingMetadataV2?: PagingMetadataV2;
-    /** Paging metadata */
     metadata?: PagingMetadataV2;
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
-    /** random GUID so clients can tell if event was already handled */
-    _id?: string;
-    /**
-     * Assumes actions are also always typed to an entity_type
-     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
-     */
-    entityFqdn?: string;
-    /**
-     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
-     * This is although the created/updated/deleted notion is duplication of the oneof types
-     * Example: created/updated/deleted/started/completed/email_opened
-     */
-    slug?: string;
-    /**
-     * Assuming that all messages including Actions have id
-     * Example: The id of the specific order, the id of a specific campaign
-     */
-    entityId?: string;
-    /** The time of the event. Useful if there was a delay in dispatching */
-    eventTime?: Date;
-    /**
-     * A field that should be set if this event was triggered by an anonymize request.
-     * For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.
-     * NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.
-     */
-    triggeredByAnonymizeRequest?: boolean | null;
-    /** If present, indicates the action that triggered the event. */
-    originatedFrom?: string | null;
-    /**
-     * A sequence number defining the order of updates to the underlying entity.
-     * For example, given that some entity was updated at 16:00 and than again at 16:01,
-     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
-     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
-     * To do so, you will need to persist this number on your end, and compare the sequence number from the
-     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
-     */
-    entityEventSequence?: string | null;
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-    extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
-}
-/** @oneof */
-export interface DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-    extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
-}
-export interface EntityCreatedEvent {
-    entityAsJson?: string;
-}
-export interface EntityUpdatedEvent {
-    /**
-     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
-     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
-     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
-     */
-    currentEntityAsJson?: string;
-}
-export interface EntityDeletedEvent {
-}
-export interface ActionEvent {
-    bodyAsJson?: string;
-}
-export interface ExtendedFieldsUpdatedEvent {
-    currentEntityAsJson?: string;
-}
 /**
  * Creates a new Project
  * @param project - Project to be created
  * @public
+ * @documentationMaturity preview
  * @requiredField project
  * @requiredField project.source.appDefId
  * @requiredField project.source.externalId
  * @requiredField project.source.sourceName
- * @returns The created Project
  */
-export declare function createProject(project: Project): Promise<Project>;
+export declare function createProject(project: Project): Promise<CreateProjectResponse>;
 /**
  * Get a Project by id
  * @param projectId - Id of the Project to retrieve
  * @public
+ * @documentationMaturity preview
  * @requiredField projectId
- * @returns The retrieved Project
  */
-export declare function getProject(projectId: string, options?: GetProjectOptions): Promise<Project>;
+export declare function getProject(projectId: string, options?: GetProjectOptions): Promise<GetProjectResponse>;
 export interface GetProjectOptions {
     includePageUrl?: boolean | null;
 }
 /**
  * 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 +751,12 @@ 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<UpdateProjectResponse>;
 export interface UpdateProject {
     /**
      * Project ID
@@ -723,14 +765,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,96 +790,32 @@ 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'>;
-interface QueryCursorResult {
-    hasNext: () => boolean;
-    hasPrev: () => boolean;
-    length: number;
-    pageSize: number;
-}
-export interface ProjectsQueryResult extends QueryCursorResult {
-    items: Project[];
-    query: ProjectsQueryBuilder;
-    next: () => Promise<ProjectsQueryResult>;
-    prev: () => Promise<ProjectsQueryResult>;
-}
-export interface ProjectsQueryBuilder {
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     */
-    eq: (propertyName: string, value: any) => ProjectsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     */
-    ne: (propertyName: string, value: any) => ProjectsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `string`.
-     * @param string - String to compare against. Case-insensitive.
-     */
-    startsWith: (propertyName: string, value: string) => ProjectsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `values`.
-     * @param values - List of values to compare against.
-     */
-    hasSome: (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. */
-    ascending: (...propertyNames: string[]) => ProjectsQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
-    descending: (...propertyNames: string[]) => ProjectsQueryBuilder;
-    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
-    limit: (limit: number) => ProjectsQueryBuilder;
-    find: () => Promise<ProjectsQueryResult>;
-}
-/**
- * Updates Project's order in a given Collection
- * @param sortOrder - The new sort order of the project in the given collection
- * @public
- * @requiredField identifiers
- * @requiredField identifiers.collectionId
- * @requiredField identifiers.projectId
- * @requiredField sortOrder
- */
-export declare function updateProjectOrderInCollection(identifiers: UpdateProjectOrderInCollectionIdentifiers, sortOrder: number | null): Promise<UpdateProjectOrderInCollectionResponse>;
-export interface UpdateProjectOrderInCollectionIdentifiers {
-    /** Id of the Project to update its order */
-    projectId: string;
-    /** Id of the collection in which the project will be re-ordered */
-    collectionId: string;
-}
-/**
- * Query project in collection context using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
- *
- * 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
- *
- * Supported Fields for query and ordering: collectionId, projectId, sortOrder, hidden, projectSlug
- *
- * 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>;
-export interface QueryProjectsWithCollectionInfoOptions {
+export declare function queryProjects(query: QueryV2, options?: QueryProjectsOptions): Promise<QueryProjectsResponse>;
+export interface QueryProjectsOptions {
     includePageUrl?: boolean | null;
 }
-export {};