@wix/auto_sdk_portfolio_projects 1.0.22 → 1.0.24
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 +21 -12
- package/build/cjs/index.js +14 -0
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/{portfolio-projects-v1-project-projects.universal-nCVjlWBr.d.ts → index.typings.d.ts} +205 -25
- package/build/cjs/index.typings.js +1235 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +38 -1
- package/build/es/index.d.mts +21 -12
- package/build/es/index.mjs +13 -0
- package/build/es/index.mjs.map +1 -1
- package/build/es/{portfolio-projects-v1-project-projects.universal-nCVjlWBr.d.mts → index.typings.d.mts} +205 -25
- package/build/es/index.typings.mjs +1194 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/es/meta.d.mts +38 -1
- package/build/internal/cjs/index.d.ts +21 -12
- package/build/internal/cjs/index.js +14 -0
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/{portfolio-projects-v1-project-projects.universal-nCVjlWBr.d.ts → index.typings.d.ts} +205 -25
- package/build/internal/cjs/index.typings.js +1235 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +38 -1
- package/build/internal/es/index.d.mts +21 -12
- package/build/internal/es/index.mjs +13 -0
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/{portfolio-projects-v1-project-projects.universal-nCVjlWBr.d.mts → index.typings.d.mts} +205 -25
- package/build/internal/es/index.typings.mjs +1194 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +38 -1
- package/package.json +4 -3
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
|
|
1
3
|
interface Project extends ProjectCoverOneOf {
|
|
2
4
|
/** Project cover image. */
|
|
3
5
|
coverImage?: Image;
|
|
@@ -50,6 +52,8 @@ interface Project extends ProjectCoverOneOf {
|
|
|
50
52
|
url?: string;
|
|
51
53
|
/** Project SEO data. */
|
|
52
54
|
seoData?: SeoSchema;
|
|
55
|
+
/** Optional watermark that can be applied to all project's images. */
|
|
56
|
+
watermark?: Watermark;
|
|
53
57
|
}
|
|
54
58
|
/** @oneof */
|
|
55
59
|
interface ProjectCoverOneOf {
|
|
@@ -69,6 +73,8 @@ declare enum ImageType {
|
|
|
69
73
|
WIX_MEDIA = "WIX_MEDIA",
|
|
70
74
|
EXTERNAL = "EXTERNAL"
|
|
71
75
|
}
|
|
76
|
+
/** @enumType */
|
|
77
|
+
type ImageTypeWithLiterals = ImageType | 'UNDEFINED' | 'WIX_MEDIA' | 'EXTERNAL';
|
|
72
78
|
interface Point {
|
|
73
79
|
/** X-coordinate of the focal point. */
|
|
74
80
|
x?: number;
|
|
@@ -250,6 +256,40 @@ interface Settings {
|
|
|
250
256
|
*/
|
|
251
257
|
keywords?: Keyword[];
|
|
252
258
|
}
|
|
259
|
+
/** Optional Watermark that can be applied to all project's images */
|
|
260
|
+
interface Watermark {
|
|
261
|
+
/** Position of the watermark on the image. */
|
|
262
|
+
position?: PositionWithLiterals;
|
|
263
|
+
/**
|
|
264
|
+
* Size of the watermark, from 0 to 100.
|
|
265
|
+
* @max 100
|
|
266
|
+
*/
|
|
267
|
+
size?: number;
|
|
268
|
+
/**
|
|
269
|
+
* Opacity of the watermark.
|
|
270
|
+
* @min 1
|
|
271
|
+
* @max 100
|
|
272
|
+
*/
|
|
273
|
+
opacity?: number;
|
|
274
|
+
/**
|
|
275
|
+
* Image ID of the Watermark as saved in Media Platform.
|
|
276
|
+
* @maxLength 300
|
|
277
|
+
*/
|
|
278
|
+
imageUrl?: string;
|
|
279
|
+
}
|
|
280
|
+
declare enum Position {
|
|
281
|
+
NORTH_WEST = "NORTH_WEST",
|
|
282
|
+
NORTH = "NORTH",
|
|
283
|
+
NORTH_EAST = "NORTH_EAST",
|
|
284
|
+
WEST = "WEST",
|
|
285
|
+
CENTER = "CENTER",
|
|
286
|
+
EAST = "EAST",
|
|
287
|
+
SOUTH_WEST = "SOUTH_WEST",
|
|
288
|
+
SOUTH = "SOUTH",
|
|
289
|
+
SOUTH_EAST = "SOUTH_EAST"
|
|
290
|
+
}
|
|
291
|
+
/** @enumType */
|
|
292
|
+
type PositionWithLiterals = Position | 'NORTH_WEST' | 'NORTH' | 'NORTH_EAST' | 'WEST' | 'CENTER' | 'EAST' | 'SOUTH_WEST' | 'SOUTH' | 'SOUTH_EAST';
|
|
253
293
|
interface MenuSettingUpdatedEvent {
|
|
254
294
|
}
|
|
255
295
|
interface GetProjectPageDataRequest {
|
|
@@ -1325,23 +1365,104 @@ interface ProjectCreatedEnvelope {
|
|
|
1325
1365
|
entity: Project;
|
|
1326
1366
|
metadata: EventMetadata;
|
|
1327
1367
|
}
|
|
1368
|
+
/**
|
|
1369
|
+
* Triggered when a project is created.
|
|
1370
|
+
* @permissionScope Manage Portfolio
|
|
1371
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1372
|
+
* @permissionId PORTFOLIO.PROJECT_READ
|
|
1373
|
+
* @webhook
|
|
1374
|
+
* @eventType wix.portfolio.projects.v1.project_created
|
|
1375
|
+
* @serviceIdentifier com.wixpress.portfolio.projects.ProjectsService
|
|
1376
|
+
* @slug created
|
|
1377
|
+
*/
|
|
1378
|
+
declare function onProjectCreated(handler: (event: ProjectCreatedEnvelope) => void | Promise<void>): void;
|
|
1328
1379
|
interface ProjectDeletedEnvelope {
|
|
1329
1380
|
metadata: EventMetadata;
|
|
1330
1381
|
}
|
|
1382
|
+
/**
|
|
1383
|
+
* Triggered when a project is deleted.
|
|
1384
|
+
* @permissionScope Manage Portfolio
|
|
1385
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1386
|
+
* @permissionId PORTFOLIO.PROJECT_READ
|
|
1387
|
+
* @webhook
|
|
1388
|
+
* @eventType wix.portfolio.projects.v1.project_deleted
|
|
1389
|
+
* @serviceIdentifier com.wixpress.portfolio.projects.ProjectsService
|
|
1390
|
+
* @slug deleted
|
|
1391
|
+
*/
|
|
1392
|
+
declare function onProjectDeleted(handler: (event: ProjectDeletedEnvelope) => void | Promise<void>): void;
|
|
1331
1393
|
interface ProjectUpdatedEnvelope {
|
|
1332
1394
|
entity: Project;
|
|
1333
1395
|
metadata: EventMetadata;
|
|
1334
1396
|
}
|
|
1397
|
+
/**
|
|
1398
|
+
* Triggered when a project is updated.
|
|
1399
|
+
* @permissionScope Manage Portfolio
|
|
1400
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1401
|
+
* @permissionId PORTFOLIO.PROJECT_READ
|
|
1402
|
+
* @webhook
|
|
1403
|
+
* @eventType wix.portfolio.projects.v1.project_updated
|
|
1404
|
+
* @serviceIdentifier com.wixpress.portfolio.projects.ProjectsService
|
|
1405
|
+
* @slug updated
|
|
1406
|
+
*/
|
|
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
|
+
/**
|
|
1410
|
+
* Creates a project.
|
|
1411
|
+
* @param project - Project to create.
|
|
1412
|
+
* @public
|
|
1413
|
+
* @requiredField project
|
|
1414
|
+
* @permissionId PORTFOLIO.PROJECT_CREATE
|
|
1415
|
+
* @applicableIdentity APP
|
|
1416
|
+
* @returns Created project.
|
|
1417
|
+
* @fqn com.wixpress.portfolio.projects.ProjectsService.CreateProject
|
|
1418
|
+
*/
|
|
1419
|
+
declare function createProject(project: Project): Promise<NonNullablePaths<Project, ProjectNonNullablePaths>>;
|
|
1420
|
+
/**
|
|
1421
|
+
* Retrieves a project.
|
|
1422
|
+
* @param projectId - ID of the project to retrieve.
|
|
1423
|
+
* @public
|
|
1424
|
+
* @requiredField projectId
|
|
1425
|
+
* @permissionId PORTFOLIO.PROJECT_READ
|
|
1426
|
+
* @applicableIdentity APP
|
|
1427
|
+
* @applicableIdentity VISITOR
|
|
1428
|
+
* @returns The requested project.
|
|
1429
|
+
* @fqn com.wixpress.portfolio.projects.ProjectsService.GetProject
|
|
1430
|
+
*/
|
|
1431
|
+
declare function getProject(projectId: string, options?: GetProjectOptions): Promise<NonNullablePaths<Project, ProjectNonNullablePaths>>;
|
|
1335
1432
|
interface GetProjectOptions {
|
|
1336
1433
|
/** Whether to include the project's relative path and full URL in the response. Default: `false` */
|
|
1337
1434
|
includePageUrl?: boolean | null;
|
|
1338
1435
|
}
|
|
1436
|
+
/**
|
|
1437
|
+
* Retrieves a list of all projects in a portfolio.
|
|
1438
|
+
* @public
|
|
1439
|
+
* @permissionId PORTFOLIO.PROJECT_READ
|
|
1440
|
+
* @applicableIdentity APP
|
|
1441
|
+
* @applicableIdentity VISITOR
|
|
1442
|
+
* @fqn com.wixpress.portfolio.projects.ProjectsService.ListProjects
|
|
1443
|
+
*/
|
|
1444
|
+
declare function listProjects(options?: ListProjectsOptions): Promise<NonNullablePaths<ListProjectsResponse, {
|
|
1445
|
+
[P in ProjectNonNullablePaths]: `projects.${number}.${P}`;
|
|
1446
|
+
}[ProjectNonNullablePaths]>>;
|
|
1339
1447
|
interface ListProjectsOptions {
|
|
1340
1448
|
/** Projects limit per response is maximum 100, In the first request the cursor is None ? */
|
|
1341
1449
|
paging?: CursorPaging;
|
|
1342
1450
|
/** Whether to include the project's relative path and full URL in the response. Default: `false` */
|
|
1343
1451
|
includePageUrl?: boolean | null;
|
|
1344
1452
|
}
|
|
1453
|
+
/**
|
|
1454
|
+
* Updates a project.
|
|
1455
|
+
* @param _id - Project ID.
|
|
1456
|
+
* @public
|
|
1457
|
+
* @requiredField _id
|
|
1458
|
+
* @requiredField project
|
|
1459
|
+
* @requiredField project.revision
|
|
1460
|
+
* @permissionId PORTFOLIO.PROJECT_UPDATE
|
|
1461
|
+
* @applicableIdentity APP
|
|
1462
|
+
* @returns Updated project.
|
|
1463
|
+
* @fqn com.wixpress.portfolio.projects.ProjectsService.UpdateProject
|
|
1464
|
+
*/
|
|
1465
|
+
declare function updateProject(_id: string, project: NonNullablePaths<UpdateProject, `revision`>): Promise<NonNullablePaths<Project, ProjectNonNullablePaths>>;
|
|
1345
1466
|
interface UpdateProject {
|
|
1346
1467
|
/** Project cover image. */
|
|
1347
1468
|
coverImage?: Image;
|
|
@@ -1394,7 +1515,22 @@ interface UpdateProject {
|
|
|
1394
1515
|
url?: string;
|
|
1395
1516
|
/** Project SEO data. */
|
|
1396
1517
|
seoData?: SeoSchema;
|
|
1518
|
+
/** Optional watermark that can be applied to all project's images. */
|
|
1519
|
+
watermark?: Watermark;
|
|
1397
1520
|
}
|
|
1521
|
+
/**
|
|
1522
|
+
* Updates multiple projects.
|
|
1523
|
+
* @public
|
|
1524
|
+
* @requiredField options.projects.project
|
|
1525
|
+
* @requiredField options.projects.project._id
|
|
1526
|
+
* @requiredField options.projects.project.revision
|
|
1527
|
+
* @permissionId PORTFOLIO.PROJECT_UPDATE
|
|
1528
|
+
* @applicableIdentity APP
|
|
1529
|
+
* @fqn com.wixpress.portfolio.projects.ProjectsService.BulkUpdateProjects
|
|
1530
|
+
*/
|
|
1531
|
+
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` | {
|
|
1532
|
+
[P in ProjectNonNullablePaths]: `results.${number}.project.${P}`;
|
|
1533
|
+
}[ProjectNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
1398
1534
|
interface BulkUpdateProjectsOptions {
|
|
1399
1535
|
/**
|
|
1400
1536
|
* Projects to update.
|
|
@@ -1404,6 +1540,38 @@ interface BulkUpdateProjectsOptions {
|
|
|
1404
1540
|
/** Whether to include the updated projects in the response. Set to `true` to receive the projects in the response. Default: `false` */
|
|
1405
1541
|
returnFullEntity?: boolean | null;
|
|
1406
1542
|
}
|
|
1543
|
+
/**
|
|
1544
|
+
* Deletes a project.
|
|
1545
|
+
* @param projectId - ID of the project to delete.
|
|
1546
|
+
* @public
|
|
1547
|
+
* @requiredField projectId
|
|
1548
|
+
* @permissionId PORTFOLIO.PROJECT_DELETE
|
|
1549
|
+
* @applicableIdentity APP
|
|
1550
|
+
* @fqn com.wixpress.portfolio.projects.ProjectsService.DeleteProject
|
|
1551
|
+
*/
|
|
1552
|
+
declare function deleteProject(projectId: string): Promise<NonNullablePaths<DeleteProjectResponse, `projectId`>>;
|
|
1553
|
+
/**
|
|
1554
|
+
* Creates a query to retrieve a list of projects.
|
|
1555
|
+
*
|
|
1556
|
+
* The `queryProjects()` method builds a query to retrieve a list of projects and returns a `ProjectsQueryBuilder` object.
|
|
1557
|
+
*
|
|
1558
|
+
* The returned object contains the query definition, which is used to run the query using the [`find()`](https://dev.wix.com/docs/sdk/backend-modules/portfolio/projects/projects-query-builder/find) method.
|
|
1559
|
+
*
|
|
1560
|
+
* You can refine the query by chaining `ProjectsQueryBuilder` methods onto the query. `ProjectsQueryBuilder` methods enable you to filter, sort, and control the results that `queryProjects()` returns.
|
|
1561
|
+
*
|
|
1562
|
+
* `queryProjects()` runs with the following `ProjectsQueryBuilder` defaults which you can override:
|
|
1563
|
+
*
|
|
1564
|
+
* + [`limit(100)`](https://dev.wix.com/docs/sdk/backend-modules/portfolio/projects/projects-query-builder/limit)
|
|
1565
|
+
* + [`ascending('_id')`](https://dev.wix.com/docs/sdk/backend-modules/portfolio/projects/projects-query-builder/ascending)
|
|
1566
|
+
*
|
|
1567
|
+
* The following `ProjectsQueryBuilder` methods are supported for `queryProjects()`. For a full description of the operations object, see the object returned for the [`items`](https://dev.wix.com/docs/sdk/backend-modules/portfolio/projects/projects-query-result/items) property in `ProjectsQueryResult`.
|
|
1568
|
+
* @public
|
|
1569
|
+
* @permissionId PORTFOLIO.PROJECT_READ
|
|
1570
|
+
* @applicableIdentity APP
|
|
1571
|
+
* @applicableIdentity VISITOR
|
|
1572
|
+
* @fqn com.wixpress.portfolio.projects.ProjectsService.QueryProjects
|
|
1573
|
+
*/
|
|
1574
|
+
declare function queryProjects(options?: QueryProjectsOptions): ProjectsQueryBuilder;
|
|
1407
1575
|
interface QueryProjectsOptions {
|
|
1408
1576
|
/** Whether to include the project's relative path and full URL in the response. Default: `false` */
|
|
1409
1577
|
includePageUrl?: boolean | null | undefined;
|
|
@@ -1424,72 +1592,69 @@ interface ProjectsQueryResult extends QueryCursorResult {
|
|
|
1424
1592
|
interface ProjectsQueryBuilder {
|
|
1425
1593
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1426
1594
|
* @param value - Value to compare against.
|
|
1427
|
-
* @documentationMaturity preview
|
|
1428
1595
|
*/
|
|
1429
1596
|
eq: (propertyName: '_id' | 'title' | 'description' | 'hidden' | 'collectionIds' | 'slug' | '_createdDate' | '_updatedDate', value: any) => ProjectsQueryBuilder;
|
|
1430
1597
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1431
1598
|
* @param value - Value to compare against.
|
|
1432
|
-
* @documentationMaturity preview
|
|
1433
1599
|
*/
|
|
1434
1600
|
ne: (propertyName: '_id' | 'title' | 'description' | 'hidden' | 'collectionIds' | 'slug' | '_createdDate' | '_updatedDate', value: any) => ProjectsQueryBuilder;
|
|
1435
1601
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1436
1602
|
* @param value - Value to compare against.
|
|
1437
|
-
* @documentationMaturity preview
|
|
1438
1603
|
*/
|
|
1439
1604
|
ge: (propertyName: '_id' | 'title' | 'description' | 'slug' | '_createdDate' | '_updatedDate', value: any) => ProjectsQueryBuilder;
|
|
1440
1605
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1441
1606
|
* @param value - Value to compare against.
|
|
1442
|
-
* @documentationMaturity preview
|
|
1443
1607
|
*/
|
|
1444
1608
|
gt: (propertyName: '_id' | 'title' | 'description' | 'slug' | '_createdDate' | '_updatedDate', value: any) => ProjectsQueryBuilder;
|
|
1445
1609
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1446
1610
|
* @param value - Value to compare against.
|
|
1447
|
-
* @documentationMaturity preview
|
|
1448
1611
|
*/
|
|
1449
1612
|
le: (propertyName: '_id' | 'title' | 'description' | 'slug' | '_createdDate' | '_updatedDate', value: any) => ProjectsQueryBuilder;
|
|
1450
1613
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1451
1614
|
* @param value - Value to compare against.
|
|
1452
|
-
* @documentationMaturity preview
|
|
1453
1615
|
*/
|
|
1454
1616
|
lt: (propertyName: '_id' | 'title' | 'description' | 'slug' | '_createdDate' | '_updatedDate', value: any) => ProjectsQueryBuilder;
|
|
1455
1617
|
/** @param propertyName - Property whose value is compared with `string`.
|
|
1456
1618
|
* @param string - String to compare against. Case-insensitive.
|
|
1457
|
-
* @documentationMaturity preview
|
|
1458
1619
|
*/
|
|
1459
1620
|
startsWith: (propertyName: '_id' | 'title' | 'description' | 'slug', value: string) => ProjectsQueryBuilder;
|
|
1460
1621
|
/** @param propertyName - Property whose value is compared with `values`.
|
|
1461
1622
|
* @param values - List of values to compare against.
|
|
1462
|
-
* @documentationMaturity preview
|
|
1463
1623
|
*/
|
|
1464
1624
|
hasSome: (propertyName: '_id' | 'title' | 'description' | 'hidden' | 'collectionIds' | 'slug' | '_createdDate' | '_updatedDate', value: any[]) => ProjectsQueryBuilder;
|
|
1465
1625
|
/** @param propertyName - Property whose value is compared with `values`.
|
|
1466
1626
|
* @param values - List of values to compare against.
|
|
1467
|
-
* @documentationMaturity preview
|
|
1468
1627
|
*/
|
|
1469
1628
|
hasAll: (propertyName: 'collectionIds', value: any[]) => ProjectsQueryBuilder;
|
|
1470
|
-
/** @documentationMaturity preview */
|
|
1471
1629
|
in: (propertyName: '_id' | 'title' | 'description' | 'hidden' | 'collectionIds' | 'slug' | '_createdDate' | '_updatedDate', value: any) => ProjectsQueryBuilder;
|
|
1472
|
-
/** @documentationMaturity preview */
|
|
1473
1630
|
exists: (propertyName: '_id' | 'title' | 'description' | 'hidden' | 'collectionIds' | 'slug' | '_createdDate' | '_updatedDate', value: boolean) => ProjectsQueryBuilder;
|
|
1474
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
1475
|
-
* @documentationMaturity preview
|
|
1476
|
-
*/
|
|
1631
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
1477
1632
|
ascending: (...propertyNames: Array<'_id' | 'title' | 'description' | 'slug' | '_createdDate' | '_updatedDate'>) => ProjectsQueryBuilder;
|
|
1478
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
1479
|
-
* @documentationMaturity preview
|
|
1480
|
-
*/
|
|
1633
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
1481
1634
|
descending: (...propertyNames: Array<'_id' | 'title' | 'description' | 'slug' | '_createdDate' | '_updatedDate'>) => ProjectsQueryBuilder;
|
|
1482
|
-
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
1483
|
-
* @documentationMaturity preview
|
|
1484
|
-
*/
|
|
1635
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
|
|
1485
1636
|
limit: (limit: number) => ProjectsQueryBuilder;
|
|
1486
|
-
/** @param cursor - A pointer to specific record
|
|
1487
|
-
* @documentationMaturity preview
|
|
1488
|
-
*/
|
|
1637
|
+
/** @param cursor - A pointer to specific record */
|
|
1489
1638
|
skipTo: (cursor: string) => ProjectsQueryBuilder;
|
|
1490
|
-
/** @documentationMaturity preview */
|
|
1491
1639
|
find: () => Promise<ProjectsQueryResult>;
|
|
1492
1640
|
}
|
|
1641
|
+
/**
|
|
1642
|
+
* Deprecated - please use ProjectsInCollectionsService.UpdateProjectOrderInCollection instead
|
|
1643
|
+
* our Client still use it
|
|
1644
|
+
* @param sortOrder - Index that determines the placement of a project within the collection.
|
|
1645
|
+
* @public
|
|
1646
|
+
* @requiredField identifiers
|
|
1647
|
+
* @requiredField identifiers.collectionId
|
|
1648
|
+
* @requiredField identifiers.projectId
|
|
1649
|
+
* @requiredField sortOrder
|
|
1650
|
+
* @permissionId PORTFOLIO.PROJECT_UPDATE
|
|
1651
|
+
* @applicableIdentity APP
|
|
1652
|
+
* @fqn com.wixpress.portfolio.projects.ProjectsService.UpdateProjectOrderInCollection
|
|
1653
|
+
* @deprecated
|
|
1654
|
+
*/
|
|
1655
|
+
declare function updateProjectOrderInCollection(identifiers: NonNullablePaths<UpdateProjectOrderInCollectionIdentifiers, `collectionId` | `projectId`>, sortOrder: number): Promise<NonNullablePaths<UpdateProjectOrderInCollectionResponse, `projectInCollection.collectionId` | {
|
|
1656
|
+
[P in ProjectNonNullablePaths]: `projectInCollection.project.${P}`;
|
|
1657
|
+
}[ProjectNonNullablePaths]>>;
|
|
1493
1658
|
interface UpdateProjectOrderInCollectionIdentifiers {
|
|
1494
1659
|
/**
|
|
1495
1660
|
* ID of the project to update.
|
|
@@ -1502,9 +1667,24 @@ interface UpdateProjectOrderInCollectionIdentifiers {
|
|
|
1502
1667
|
*/
|
|
1503
1668
|
collectionId: string;
|
|
1504
1669
|
}
|
|
1670
|
+
/**
|
|
1671
|
+
* Deprecated - please use ProjectsInCollectionsService.QueryProjectsInCollections instead
|
|
1672
|
+
* our Client still use it
|
|
1673
|
+
* @param query - WQL expression
|
|
1674
|
+
* @public
|
|
1675
|
+
* @requiredField query
|
|
1676
|
+
* @permissionId PORTFOLIO.PROJECT_READ
|
|
1677
|
+
* @applicableIdentity APP
|
|
1678
|
+
* @applicableIdentity VISITOR
|
|
1679
|
+
* @fqn com.wixpress.portfolio.projects.ProjectsService.QueryProjectsWithCollectionInfo
|
|
1680
|
+
* @deprecated
|
|
1681
|
+
*/
|
|
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]>>;
|
|
1505
1685
|
interface QueryProjectsWithCollectionInfoOptions {
|
|
1506
1686
|
/** Include page url */
|
|
1507
1687
|
includePageUrl?: boolean | null;
|
|
1508
1688
|
}
|
|
1509
1689
|
|
|
1510
|
-
export { type
|
|
1690
|
+
export { type ActionEvent, type App, type ApplicationError, type Asset, type BaseEventMetadata, type BulkActionMetadata, type BulkUpdateProjectsOptions, type BulkUpdateProjectsRequest, type BulkUpdateProjectsResponse, type BulkUpdateProjectsResult, type CreateNewPortfolioAppRequest, type CreateNewPortfolioAppResponse, type CreateProjectRequest, type CreateProjectResponse, type CursorPaging, type Cursors, type CustomTag, type DeleteContext, type DeleteProjectRequest, type DeleteProjectResponse, DeleteStatus, type DeleteStatusWithLiterals, type DeletedProjectRestored, type DetailsLink, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type File, type GetProjectOptions, type GetProjectPageDataRequest, type GetProjectPageDataResponse, type GetProjectRequest, type GetProjectResponse, type IdentificationData, type IdentificationDataIdOneOf, type Image, ImageType, type ImageTypeWithLiterals, type InvalidateCache, type InvalidateCacheGetByOneOf, type ItemMetadata, type Keyword, type ListProjectsOptions, type ListProjectsRequest, type ListProjectsResponse, type MaskedProject, type MenuSettingUpdatedEvent, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type Page, type Paging, type PagingMetadataV2, type PicassoAssigned, type PicassoUnassigned, type Point, Position, type PositionWithLiterals, type Project, type ProjectCoverOneOf, type ProjectCreatedEnvelope, type ProjectDeletedEnvelope, type ProjectDetail, type ProjectDetailValueOneOf, type ProjectSlug, type ProjectSource, type ProjectUpdatedEnvelope, type ProjectsInCollections, type ProjectsQueryBuilder, type ProjectsQueryResult, type QueryProjectWithCollectionInfoRequest, type QueryProjectWithCollectionInfoResponse, type QueryProjectsOptions, type QueryProjectsRequest, type QueryProjectsResponse, type QueryProjectsWithCollectionInfoOptions, type QueryV2, type QueryV2PagingMethodOneOf, type RestoreInfo, type RestoreProjectFromTrashBinRequest, type RestoreProjectFromTrashBinResponse, type SeoSchema, type ServiceProvisioned, type ServiceRemoved, type Settings, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, type StudioAssigned, type StudioUnassigned, type SyncProjectWithCollectionMappings, SyncStatus, type SyncStatusWithLiterals, type Tag, type URI, type UnsharpMasking, type UpdateProject, type UpdateProjectOrderInCollectionIdentifiers, type UpdateProjectOrderInCollectionRequest, type UpdateProjectOrderInCollectionResponse, type UpdateProjectRequest, type UpdateProjectResponse, type Video, type VideoResolution, type Watermark, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkUpdateProjects, createProject, deleteProject, getProject, listProjects, onProjectCreated, onProjectDeleted, onProjectUpdated, queryProjects, queryProjectsWithCollectionInfo, updateProject, updateProjectOrderInCollection };
|