@wix/auto_sdk_portfolio_projects 1.0.24 → 1.0.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +9 -18
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +8 -17
- package/build/cjs/index.typings.js.map +1 -1
- package/build/es/index.d.mts +9 -18
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +8 -17
- package/build/es/index.typings.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +9 -18
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +8 -17
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/es/index.d.mts +9 -18
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +8 -17
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/package.json +3 -3
|
@@ -1405,7 +1405,6 @@ interface ProjectUpdatedEnvelope {
|
|
|
1405
1405
|
* @slug updated
|
|
1406
1406
|
*/
|
|
1407
1407
|
declare function onProjectUpdated(handler: (event: ProjectUpdatedEnvelope) => void | Promise<void>): void;
|
|
1408
|
-
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`;
|
|
1409
1408
|
/**
|
|
1410
1409
|
* Creates a project.
|
|
1411
1410
|
* @param project - Project to create.
|
|
@@ -1416,7 +1415,7 @@ type ProjectNonNullablePaths = `coverImage.focalPoint.x` | `coverImage.focalPoin
|
|
|
1416
1415
|
* @returns Created project.
|
|
1417
1416
|
* @fqn com.wixpress.portfolio.projects.ProjectsService.CreateProject
|
|
1418
1417
|
*/
|
|
1419
|
-
declare function createProject(project: Project): Promise<NonNullablePaths<Project,
|
|
1418
|
+
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>>;
|
|
1420
1419
|
/**
|
|
1421
1420
|
* Retrieves a project.
|
|
1422
1421
|
* @param projectId - ID of the project to retrieve.
|
|
@@ -1428,7 +1427,7 @@ declare function createProject(project: Project): Promise<NonNullablePaths<Proje
|
|
|
1428
1427
|
* @returns The requested project.
|
|
1429
1428
|
* @fqn com.wixpress.portfolio.projects.ProjectsService.GetProject
|
|
1430
1429
|
*/
|
|
1431
|
-
declare function getProject(projectId: string, options?: GetProjectOptions): Promise<NonNullablePaths<Project,
|
|
1430
|
+
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>>;
|
|
1432
1431
|
interface GetProjectOptions {
|
|
1433
1432
|
/** Whether to include the project's relative path and full URL in the response. Default: `false` */
|
|
1434
1433
|
includePageUrl?: boolean | null;
|
|
@@ -1441,9 +1440,7 @@ interface GetProjectOptions {
|
|
|
1441
1440
|
* @applicableIdentity VISITOR
|
|
1442
1441
|
* @fqn com.wixpress.portfolio.projects.ProjectsService.ListProjects
|
|
1443
1442
|
*/
|
|
1444
|
-
declare function listProjects(options?: ListProjectsOptions): Promise<NonNullablePaths<ListProjectsResponse, {
|
|
1445
|
-
[P in ProjectNonNullablePaths]: `projects.${number}.${P}`;
|
|
1446
|
-
}[ProjectNonNullablePaths]>>;
|
|
1443
|
+
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>>;
|
|
1447
1444
|
interface ListProjectsOptions {
|
|
1448
1445
|
/** Projects limit per response is maximum 100, In the first request the cursor is None ? */
|
|
1449
1446
|
paging?: CursorPaging;
|
|
@@ -1462,7 +1459,7 @@ interface ListProjectsOptions {
|
|
|
1462
1459
|
* @returns Updated project.
|
|
1463
1460
|
* @fqn com.wixpress.portfolio.projects.ProjectsService.UpdateProject
|
|
1464
1461
|
*/
|
|
1465
|
-
declare function updateProject(_id: string, project: NonNullablePaths<UpdateProject, `revision
|
|
1462
|
+
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>>;
|
|
1466
1463
|
interface UpdateProject {
|
|
1467
1464
|
/** Project cover image. */
|
|
1468
1465
|
coverImage?: Image;
|
|
@@ -1528,9 +1525,7 @@ interface UpdateProject {
|
|
|
1528
1525
|
* @applicableIdentity APP
|
|
1529
1526
|
* @fqn com.wixpress.portfolio.projects.ProjectsService.BulkUpdateProjects
|
|
1530
1527
|
*/
|
|
1531
|
-
declare function bulkUpdateProjects(options?: NonNullablePaths<BulkUpdateProjectsOptions, `projects.${number}.project` | `projects.${number}.project._id` | `projects.${number}.project.revision
|
|
1532
|
-
[P in ProjectNonNullablePaths]: `results.${number}.project.${P}`;
|
|
1533
|
-
}[ProjectNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
1528
|
+
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>>;
|
|
1534
1529
|
interface BulkUpdateProjectsOptions {
|
|
1535
1530
|
/**
|
|
1536
1531
|
* Projects to update.
|
|
@@ -1549,7 +1544,7 @@ interface BulkUpdateProjectsOptions {
|
|
|
1549
1544
|
* @applicableIdentity APP
|
|
1550
1545
|
* @fqn com.wixpress.portfolio.projects.ProjectsService.DeleteProject
|
|
1551
1546
|
*/
|
|
1552
|
-
declare function deleteProject(projectId: string): Promise<NonNullablePaths<DeleteProjectResponse, `projectId
|
|
1547
|
+
declare function deleteProject(projectId: string): Promise<NonNullablePaths<DeleteProjectResponse, `projectId`, 2>>;
|
|
1553
1548
|
/**
|
|
1554
1549
|
* Creates a query to retrieve a list of projects.
|
|
1555
1550
|
*
|
|
@@ -1652,9 +1647,7 @@ interface ProjectsQueryBuilder {
|
|
|
1652
1647
|
* @fqn com.wixpress.portfolio.projects.ProjectsService.UpdateProjectOrderInCollection
|
|
1653
1648
|
* @deprecated
|
|
1654
1649
|
*/
|
|
1655
|
-
declare function updateProjectOrderInCollection(identifiers: NonNullablePaths<UpdateProjectOrderInCollectionIdentifiers, `collectionId` | `projectId
|
|
1656
|
-
[P in ProjectNonNullablePaths]: `projectInCollection.project.${P}`;
|
|
1657
|
-
}[ProjectNonNullablePaths]>>;
|
|
1650
|
+
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>>;
|
|
1658
1651
|
interface UpdateProjectOrderInCollectionIdentifiers {
|
|
1659
1652
|
/**
|
|
1660
1653
|
* ID of the project to update.
|
|
@@ -1679,9 +1672,7 @@ interface UpdateProjectOrderInCollectionIdentifiers {
|
|
|
1679
1672
|
* @fqn com.wixpress.portfolio.projects.ProjectsService.QueryProjectsWithCollectionInfo
|
|
1680
1673
|
* @deprecated
|
|
1681
1674
|
*/
|
|
1682
|
-
declare function queryProjectsWithCollectionInfo(query: QueryV2, options?: QueryProjectsWithCollectionInfoOptions): Promise<NonNullablePaths<QueryProjectWithCollectionInfoResponse, `projects` | `projects.${number}.collectionId` | {
|
|
1683
|
-
[P in ProjectNonNullablePaths]: `projects.${number}.project.${P}`;
|
|
1684
|
-
}[ProjectNonNullablePaths]>>;
|
|
1675
|
+
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>>;
|
|
1685
1676
|
interface QueryProjectsWithCollectionInfoOptions {
|
|
1686
1677
|
/** Include page url */
|
|
1687
1678
|
includePageUrl?: boolean | null;
|