@wix/auto_sdk_portfolio_projects 1.0.25 → 1.0.27

package/build/cjs/meta.d.ts

@@ -204,21 +204,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;
     /**
@@ -247,6 +247,8 @@ interface Watermark {
      * @maxLength 300
      */
     imageUrl?: string;
+    /** Whether the watermark is to be displayed on Items & Cover Photos. */
+    enabled?: boolean;
 }
 declare enum Position {
     NORTH_WEST = "NORTH_WEST",

package/build/es/index.d.mts

@@ -9,7 +9,7 @@ interface CreateProjectSignature {
      * @param - Project to create.
      * @returns Created project.
      */
-    (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>>;
+    (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` | `watermark.enabled`, 6>>;
 }
 declare function getProject$1(httpClient: HttpClient): GetProjectSignature;
 interface GetProjectSignature {
@@ -18,14 +18,14 @@ interface GetProjectSignature {
      * @param - ID of the project to retrieve.
      * @returns The requested project.
      */
-    (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>>;
+    (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` | `watermark.enabled`, 6>>;
 }
 declare function listProjects$1(httpClient: HttpClient): ListProjectsSignature;
 interface ListProjectsSignature {
     /**
      * Retrieves a list of all projects in a portfolio.
      */
-    (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>>;
+    (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` | `projects.${number}.watermark.enabled`, 6>>;
 }
 declare function updateProject$1(httpClient: HttpClient): UpdateProjectSignature;
 interface UpdateProjectSignature {
@@ -34,14 +34,14 @@ interface UpdateProjectSignature {
      * @param - Project ID.
      * @returns Updated project.
      */
-    (_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>>;
+    (_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` | `watermark.enabled`, 6>>;
 }
 declare function bulkUpdateProjects$1(httpClient: HttpClient): BulkUpdateProjectsSignature;
 interface BulkUpdateProjectsSignature {
     /**
      * Updates multiple projects.
      */
-    (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>>;
+    (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` | `results.${number}.project.watermark.enabled` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
 }
 declare function deleteProject$1(httpClient: HttpClient): DeleteProjectSignature;
 interface DeleteProjectSignature {
@@ -79,7 +79,7 @@ interface UpdateProjectOrderInCollectionSignature {
      * @param - Index that determines the placement of a project within the collection.
      * @deprecated
      */
-    (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>>;
+    (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` | `projectInCollection.project.watermark.enabled`, 8>>;
 }
 declare function queryProjectsWithCollectionInfo$1(httpClient: HttpClient): QueryProjectsWithCollectionInfoSignature;
 interface QueryProjectsWithCollectionInfoSignature {
@@ -89,7 +89,7 @@ interface QueryProjectsWithCollectionInfoSignature {
      * @param - WQL expression
      * @deprecated
      */
-    (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>>;
+    (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` | `projects.${number}.project.watermark.enabled`, 6>>;
 }
 declare const onProjectCreated$1: EventDefinition<ProjectCreatedEnvelope, "wix.portfolio.projects.v1.project_created">;
 declare const onProjectDeleted$1: EventDefinition<ProjectDeletedEnvelope, "wix.portfolio.projects.v1.project_deleted">;