@wix/auto_sdk_portfolio_projects 1.0.24 → 1.0.26

package/build/cjs/index.typings.d.ts

@@ -233,21 +233,21 @@ interface Tag {
      * For example: `{"name": "description", "content": "the description itself"}`.
      */
     props?: Record<string, any> | null;
-    /** SEO tag meta data. For example, `{"height": 300, "width": 240}`. */
+    /** SEO tag metadata. For example, `{"height": 300, "width": 240}`. */
     meta?: Record<string, any> | null;
     /** SEO tag inner content. For example, `<title> inner content </title>`. */
     children?: string;
-    /** Whether the tag is a custom tag. */
+    /** Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). */
     custom?: boolean;
-    /** Whether the tag is disabled. */
+    /** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
     disabled?: boolean;
 }
 interface Settings {
     /**
-     * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
+     * Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.
      *
      *
-     * Default: `false` (Auto Redirect is enabled.)
+     * Default: `false` (automatical redirect is enabled).
      */
     preventAutoRedirect?: boolean;
     /**
@@ -1405,7 +1405,6 @@ interface ProjectUpdatedEnvelope {
  * @slug updated
  */
 declare function onProjectUpdated(handler: (event: ProjectUpdatedEnvelope) => void | Promise<void>): void;
-type ProjectNonNullablePaths = `coverImage.focalPoint.x` | `coverImage.focalPoint.y` | `collectionIds` | `details` | `details.${number}.text` | `details.${number}.label` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `watermark.position` | `watermark.size` | `watermark.opacity` | `watermark.imageUrl`;
 /**
  * Creates a project.
  * @param project - Project to create.
@@ -1416,7 +1415,7 @@ type ProjectNonNullablePaths = `coverImage.focalPoint.x` | `coverImage.focalPoin
  * @returns Created project.
  * @fqn com.wixpress.portfolio.projects.ProjectsService.CreateProject
  */
-declare function createProject(project: Project): Promise<NonNullablePaths<Project, ProjectNonNullablePaths>>;
+declare function createProject(project: Project): Promise<NonNullablePaths<Project, `coverImage.focalPoint.x` | `coverImage.focalPoint.y` | `collectionIds` | `details` | `details.${number}.text` | `details.${number}.label` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `watermark.position` | `watermark.size` | `watermark.opacity` | `watermark.imageUrl`, 6>>;
 /**
  * Retrieves a project.
  * @param projectId - ID of the project to retrieve.
@@ -1424,11 +1423,10 @@ declare function createProject(project: Project): Promise<NonNullablePaths<Proje
  * @requiredField projectId
  * @permissionId PORTFOLIO.PROJECT_READ
  * @applicableIdentity APP
- * @applicableIdentity VISITOR
  * @returns The requested project.
  * @fqn com.wixpress.portfolio.projects.ProjectsService.GetProject
  */
-declare function getProject(projectId: string, options?: GetProjectOptions): Promise<NonNullablePaths<Project, ProjectNonNullablePaths>>;
+declare function getProject(projectId: string, options?: GetProjectOptions): Promise<NonNullablePaths<Project, `coverImage.focalPoint.x` | `coverImage.focalPoint.y` | `collectionIds` | `details` | `details.${number}.text` | `details.${number}.label` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `watermark.position` | `watermark.size` | `watermark.opacity` | `watermark.imageUrl`, 6>>;
 interface GetProjectOptions {
     /** Whether to include the project's relative path and full URL in the response. Default: `false` */
     includePageUrl?: boolean | null;
@@ -1438,12 +1436,9 @@ interface GetProjectOptions {
  * @public
  * @permissionId PORTFOLIO.PROJECT_READ
  * @applicableIdentity APP
- * @applicableIdentity VISITOR
  * @fqn com.wixpress.portfolio.projects.ProjectsService.ListProjects
  */
-declare function listProjects(options?: ListProjectsOptions): Promise<NonNullablePaths<ListProjectsResponse, {
-    [P in ProjectNonNullablePaths]: `projects.${number}.${P}`;
-}[ProjectNonNullablePaths]>>;
+declare function listProjects(options?: ListProjectsOptions): Promise<NonNullablePaths<ListProjectsResponse, `projects` | `projects.${number}.coverImage.focalPoint.x` | `projects.${number}.coverImage.focalPoint.y` | `projects.${number}.seoData.settings.preventAutoRedirect` | `projects.${number}.watermark.position` | `projects.${number}.watermark.size` | `projects.${number}.watermark.opacity` | `projects.${number}.watermark.imageUrl`, 6>>;
 interface ListProjectsOptions {
     /** Projects limit per response is maximum 100, In the first request the cursor is None ? */
     paging?: CursorPaging;
@@ -1462,7 +1457,7 @@ interface ListProjectsOptions {
  * @returns Updated project.
  * @fqn com.wixpress.portfolio.projects.ProjectsService.UpdateProject
  */
-declare function updateProject(_id: string, project: NonNullablePaths<UpdateProject, `revision`>): Promise<NonNullablePaths<Project, ProjectNonNullablePaths>>;
+declare function updateProject(_id: string, project: NonNullablePaths<UpdateProject, `revision`, 2>): Promise<NonNullablePaths<Project, `coverImage.focalPoint.x` | `coverImage.focalPoint.y` | `collectionIds` | `details` | `details.${number}.text` | `details.${number}.label` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `watermark.position` | `watermark.size` | `watermark.opacity` | `watermark.imageUrl`, 6>>;
 interface UpdateProject {
     /** Project cover image. */
     coverImage?: Image;
@@ -1528,9 +1523,7 @@ interface UpdateProject {
  * @applicableIdentity APP
  * @fqn com.wixpress.portfolio.projects.ProjectsService.BulkUpdateProjects
  */
-declare function bulkUpdateProjects(options?: NonNullablePaths<BulkUpdateProjectsOptions, `projects.${number}.project` | `projects.${number}.project._id` | `projects.${number}.project.revision`>): Promise<NonNullablePaths<BulkUpdateProjectsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
-    [P in ProjectNonNullablePaths]: `results.${number}.project.${P}`;
-}[ProjectNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
+declare function bulkUpdateProjects(options?: NonNullablePaths<BulkUpdateProjectsOptions, `projects.${number}.project` | `projects.${number}.project._id` | `projects.${number}.project.revision`, 5>): Promise<NonNullablePaths<BulkUpdateProjectsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.project.watermark.position` | `results.${number}.project.watermark.size` | `results.${number}.project.watermark.opacity` | `results.${number}.project.watermark.imageUrl` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
 interface BulkUpdateProjectsOptions {
     /**
      * Projects to update.
@@ -1549,7 +1542,7 @@ interface BulkUpdateProjectsOptions {
  * @applicableIdentity APP
  * @fqn com.wixpress.portfolio.projects.ProjectsService.DeleteProject
  */
-declare function deleteProject(projectId: string): Promise<NonNullablePaths<DeleteProjectResponse, `projectId`>>;
+declare function deleteProject(projectId: string): Promise<NonNullablePaths<DeleteProjectResponse, `projectId`, 2>>;
 /**
  * Creates a query to retrieve a list of projects.
  *
@@ -1568,7 +1561,6 @@ declare function deleteProject(projectId: string): Promise<NonNullablePaths<Dele
  * @public
  * @permissionId PORTFOLIO.PROJECT_READ
  * @applicableIdentity APP
- * @applicableIdentity VISITOR
  * @fqn com.wixpress.portfolio.projects.ProjectsService.QueryProjects
  */
 declare function queryProjects(options?: QueryProjectsOptions): ProjectsQueryBuilder;
@@ -1652,9 +1644,7 @@ interface ProjectsQueryBuilder {
  * @fqn com.wixpress.portfolio.projects.ProjectsService.UpdateProjectOrderInCollection
  * @deprecated
  */
-declare function updateProjectOrderInCollection(identifiers: NonNullablePaths<UpdateProjectOrderInCollectionIdentifiers, `collectionId` | `projectId`>, sortOrder: number): Promise<NonNullablePaths<UpdateProjectOrderInCollectionResponse, `projectInCollection.collectionId` | {
-    [P in ProjectNonNullablePaths]: `projectInCollection.project.${P}`;
-}[ProjectNonNullablePaths]>>;
+declare function updateProjectOrderInCollection(identifiers: NonNullablePaths<UpdateProjectOrderInCollectionIdentifiers, `collectionId` | `projectId`, 2>, sortOrder: number): Promise<NonNullablePaths<UpdateProjectOrderInCollectionResponse, `projectInCollection.collectionId` | `projectInCollection.project.coverImage.focalPoint.x` | `projectInCollection.project.coverImage.focalPoint.y` | `projectInCollection.project.collectionIds` | `projectInCollection.project.details` | `projectInCollection.project.details.${number}.text` | `projectInCollection.project.details.${number}.label` | `projectInCollection.project.seoData.tags` | `projectInCollection.project.seoData.tags.${number}.type` | `projectInCollection.project.seoData.tags.${number}.children` | `projectInCollection.project.seoData.tags.${number}.custom` | `projectInCollection.project.seoData.tags.${number}.disabled` | `projectInCollection.project.seoData.settings.preventAutoRedirect` | `projectInCollection.project.seoData.settings.keywords` | `projectInCollection.project.seoData.settings.keywords.${number}.term` | `projectInCollection.project.seoData.settings.keywords.${number}.isMain` | `projectInCollection.project.watermark.position` | `projectInCollection.project.watermark.size` | `projectInCollection.project.watermark.opacity` | `projectInCollection.project.watermark.imageUrl`, 8>>;
 interface UpdateProjectOrderInCollectionIdentifiers {
     /**
      * ID of the project to update.
@@ -1675,13 +1665,10 @@ interface UpdateProjectOrderInCollectionIdentifiers {
  * @requiredField query
  * @permissionId PORTFOLIO.PROJECT_READ
  * @applicableIdentity APP
- * @applicableIdentity VISITOR
  * @fqn com.wixpress.portfolio.projects.ProjectsService.QueryProjectsWithCollectionInfo
  * @deprecated
  */
-declare function queryProjectsWithCollectionInfo(query: QueryV2, options?: QueryProjectsWithCollectionInfoOptions): Promise<NonNullablePaths<QueryProjectWithCollectionInfoResponse, `projects` | `projects.${number}.collectionId` | {
-    [P in ProjectNonNullablePaths]: `projects.${number}.project.${P}`;
-}[ProjectNonNullablePaths]>>;
+declare function queryProjectsWithCollectionInfo(query: QueryV2, options?: QueryProjectsWithCollectionInfoOptions): Promise<NonNullablePaths<QueryProjectWithCollectionInfoResponse, `projects` | `projects.${number}.collectionId` | `projects.${number}.project.watermark.position` | `projects.${number}.project.watermark.size` | `projects.${number}.project.watermark.opacity` | `projects.${number}.project.watermark.imageUrl`, 6>>;
 interface QueryProjectsWithCollectionInfoOptions {
     /** Include page url */
     includePageUrl?: boolean | null;