@wix/auto_sdk_portfolio_projects 1.0.23 → 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 +12 -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} +196 -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 +12 -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} +196 -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 +12 -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} +196 -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 +12 -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} +196 -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,101 @@ 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
|
+
/**
|
|
1409
|
+
* Creates a project.
|
|
1410
|
+
* @param project - Project to create.
|
|
1411
|
+
* @public
|
|
1412
|
+
* @requiredField project
|
|
1413
|
+
* @permissionId PORTFOLIO.PROJECT_CREATE
|
|
1414
|
+
* @applicableIdentity APP
|
|
1415
|
+
* @returns Created project.
|
|
1416
|
+
* @fqn com.wixpress.portfolio.projects.ProjectsService.CreateProject
|
|
1417
|
+
*/
|
|
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>>;
|
|
1419
|
+
/**
|
|
1420
|
+
* Retrieves a project.
|
|
1421
|
+
* @param projectId - ID of the project to retrieve.
|
|
1422
|
+
* @public
|
|
1423
|
+
* @requiredField projectId
|
|
1424
|
+
* @permissionId PORTFOLIO.PROJECT_READ
|
|
1425
|
+
* @applicableIdentity APP
|
|
1426
|
+
* @applicableIdentity VISITOR
|
|
1427
|
+
* @returns The requested project.
|
|
1428
|
+
* @fqn com.wixpress.portfolio.projects.ProjectsService.GetProject
|
|
1429
|
+
*/
|
|
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>>;
|
|
1335
1431
|
interface GetProjectOptions {
|
|
1336
1432
|
/** Whether to include the project's relative path and full URL in the response. Default: `false` */
|
|
1337
1433
|
includePageUrl?: boolean | null;
|
|
1338
1434
|
}
|
|
1435
|
+
/**
|
|
1436
|
+
* Retrieves a list of all projects in a portfolio.
|
|
1437
|
+
* @public
|
|
1438
|
+
* @permissionId PORTFOLIO.PROJECT_READ
|
|
1439
|
+
* @applicableIdentity APP
|
|
1440
|
+
* @applicableIdentity VISITOR
|
|
1441
|
+
* @fqn com.wixpress.portfolio.projects.ProjectsService.ListProjects
|
|
1442
|
+
*/
|
|
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>>;
|
|
1339
1444
|
interface ListProjectsOptions {
|
|
1340
1445
|
/** Projects limit per response is maximum 100, In the first request the cursor is None ? */
|
|
1341
1446
|
paging?: CursorPaging;
|
|
1342
1447
|
/** Whether to include the project's relative path and full URL in the response. Default: `false` */
|
|
1343
1448
|
includePageUrl?: boolean | null;
|
|
1344
1449
|
}
|
|
1450
|
+
/**
|
|
1451
|
+
* Updates a project.
|
|
1452
|
+
* @param _id - Project ID.
|
|
1453
|
+
* @public
|
|
1454
|
+
* @requiredField _id
|
|
1455
|
+
* @requiredField project
|
|
1456
|
+
* @requiredField project.revision
|
|
1457
|
+
* @permissionId PORTFOLIO.PROJECT_UPDATE
|
|
1458
|
+
* @applicableIdentity APP
|
|
1459
|
+
* @returns Updated project.
|
|
1460
|
+
* @fqn com.wixpress.portfolio.projects.ProjectsService.UpdateProject
|
|
1461
|
+
*/
|
|
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>>;
|
|
1345
1463
|
interface UpdateProject {
|
|
1346
1464
|
/** Project cover image. */
|
|
1347
1465
|
coverImage?: Image;
|
|
@@ -1394,7 +1512,20 @@ interface UpdateProject {
|
|
|
1394
1512
|
url?: string;
|
|
1395
1513
|
/** Project SEO data. */
|
|
1396
1514
|
seoData?: SeoSchema;
|
|
1515
|
+
/** Optional watermark that can be applied to all project's images. */
|
|
1516
|
+
watermark?: Watermark;
|
|
1397
1517
|
}
|
|
1518
|
+
/**
|
|
1519
|
+
* Updates multiple projects.
|
|
1520
|
+
* @public
|
|
1521
|
+
* @requiredField options.projects.project
|
|
1522
|
+
* @requiredField options.projects.project._id
|
|
1523
|
+
* @requiredField options.projects.project.revision
|
|
1524
|
+
* @permissionId PORTFOLIO.PROJECT_UPDATE
|
|
1525
|
+
* @applicableIdentity APP
|
|
1526
|
+
* @fqn com.wixpress.portfolio.projects.ProjectsService.BulkUpdateProjects
|
|
1527
|
+
*/
|
|
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>>;
|
|
1398
1529
|
interface BulkUpdateProjectsOptions {
|
|
1399
1530
|
/**
|
|
1400
1531
|
* Projects to update.
|
|
@@ -1404,6 +1535,38 @@ interface BulkUpdateProjectsOptions {
|
|
|
1404
1535
|
/** Whether to include the updated projects in the response. Set to `true` to receive the projects in the response. Default: `false` */
|
|
1405
1536
|
returnFullEntity?: boolean | null;
|
|
1406
1537
|
}
|
|
1538
|
+
/**
|
|
1539
|
+
* Deletes a project.
|
|
1540
|
+
* @param projectId - ID of the project to delete.
|
|
1541
|
+
* @public
|
|
1542
|
+
* @requiredField projectId
|
|
1543
|
+
* @permissionId PORTFOLIO.PROJECT_DELETE
|
|
1544
|
+
* @applicableIdentity APP
|
|
1545
|
+
* @fqn com.wixpress.portfolio.projects.ProjectsService.DeleteProject
|
|
1546
|
+
*/
|
|
1547
|
+
declare function deleteProject(projectId: string): Promise<NonNullablePaths<DeleteProjectResponse, `projectId`, 2>>;
|
|
1548
|
+
/**
|
|
1549
|
+
* Creates a query to retrieve a list of projects.
|
|
1550
|
+
*
|
|
1551
|
+
* The `queryProjects()` method builds a query to retrieve a list of projects and returns a `ProjectsQueryBuilder` object.
|
|
1552
|
+
*
|
|
1553
|
+
* 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.
|
|
1554
|
+
*
|
|
1555
|
+
* 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.
|
|
1556
|
+
*
|
|
1557
|
+
* `queryProjects()` runs with the following `ProjectsQueryBuilder` defaults which you can override:
|
|
1558
|
+
*
|
|
1559
|
+
* + [`limit(100)`](https://dev.wix.com/docs/sdk/backend-modules/portfolio/projects/projects-query-builder/limit)
|
|
1560
|
+
* + [`ascending('_id')`](https://dev.wix.com/docs/sdk/backend-modules/portfolio/projects/projects-query-builder/ascending)
|
|
1561
|
+
*
|
|
1562
|
+
* 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`.
|
|
1563
|
+
* @public
|
|
1564
|
+
* @permissionId PORTFOLIO.PROJECT_READ
|
|
1565
|
+
* @applicableIdentity APP
|
|
1566
|
+
* @applicableIdentity VISITOR
|
|
1567
|
+
* @fqn com.wixpress.portfolio.projects.ProjectsService.QueryProjects
|
|
1568
|
+
*/
|
|
1569
|
+
declare function queryProjects(options?: QueryProjectsOptions): ProjectsQueryBuilder;
|
|
1407
1570
|
interface QueryProjectsOptions {
|
|
1408
1571
|
/** Whether to include the project's relative path and full URL in the response. Default: `false` */
|
|
1409
1572
|
includePageUrl?: boolean | null | undefined;
|
|
@@ -1424,72 +1587,67 @@ interface ProjectsQueryResult extends QueryCursorResult {
|
|
|
1424
1587
|
interface ProjectsQueryBuilder {
|
|
1425
1588
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1426
1589
|
* @param value - Value to compare against.
|
|
1427
|
-
* @documentationMaturity preview
|
|
1428
1590
|
*/
|
|
1429
1591
|
eq: (propertyName: '_id' | 'title' | 'description' | 'hidden' | 'collectionIds' | 'slug' | '_createdDate' | '_updatedDate', value: any) => ProjectsQueryBuilder;
|
|
1430
1592
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1431
1593
|
* @param value - Value to compare against.
|
|
1432
|
-
* @documentationMaturity preview
|
|
1433
1594
|
*/
|
|
1434
1595
|
ne: (propertyName: '_id' | 'title' | 'description' | 'hidden' | 'collectionIds' | 'slug' | '_createdDate' | '_updatedDate', value: any) => ProjectsQueryBuilder;
|
|
1435
1596
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1436
1597
|
* @param value - Value to compare against.
|
|
1437
|
-
* @documentationMaturity preview
|
|
1438
1598
|
*/
|
|
1439
1599
|
ge: (propertyName: '_id' | 'title' | 'description' | 'slug' | '_createdDate' | '_updatedDate', value: any) => ProjectsQueryBuilder;
|
|
1440
1600
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1441
1601
|
* @param value - Value to compare against.
|
|
1442
|
-
* @documentationMaturity preview
|
|
1443
1602
|
*/
|
|
1444
1603
|
gt: (propertyName: '_id' | 'title' | 'description' | 'slug' | '_createdDate' | '_updatedDate', value: any) => ProjectsQueryBuilder;
|
|
1445
1604
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1446
1605
|
* @param value - Value to compare against.
|
|
1447
|
-
* @documentationMaturity preview
|
|
1448
1606
|
*/
|
|
1449
1607
|
le: (propertyName: '_id' | 'title' | 'description' | 'slug' | '_createdDate' | '_updatedDate', value: any) => ProjectsQueryBuilder;
|
|
1450
1608
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1451
1609
|
* @param value - Value to compare against.
|
|
1452
|
-
* @documentationMaturity preview
|
|
1453
1610
|
*/
|
|
1454
1611
|
lt: (propertyName: '_id' | 'title' | 'description' | 'slug' | '_createdDate' | '_updatedDate', value: any) => ProjectsQueryBuilder;
|
|
1455
1612
|
/** @param propertyName - Property whose value is compared with `string`.
|
|
1456
1613
|
* @param string - String to compare against. Case-insensitive.
|
|
1457
|
-
* @documentationMaturity preview
|
|
1458
1614
|
*/
|
|
1459
1615
|
startsWith: (propertyName: '_id' | 'title' | 'description' | 'slug', value: string) => ProjectsQueryBuilder;
|
|
1460
1616
|
/** @param propertyName - Property whose value is compared with `values`.
|
|
1461
1617
|
* @param values - List of values to compare against.
|
|
1462
|
-
* @documentationMaturity preview
|
|
1463
1618
|
*/
|
|
1464
1619
|
hasSome: (propertyName: '_id' | 'title' | 'description' | 'hidden' | 'collectionIds' | 'slug' | '_createdDate' | '_updatedDate', value: any[]) => ProjectsQueryBuilder;
|
|
1465
1620
|
/** @param propertyName - Property whose value is compared with `values`.
|
|
1466
1621
|
* @param values - List of values to compare against.
|
|
1467
|
-
* @documentationMaturity preview
|
|
1468
1622
|
*/
|
|
1469
1623
|
hasAll: (propertyName: 'collectionIds', value: any[]) => ProjectsQueryBuilder;
|
|
1470
|
-
/** @documentationMaturity preview */
|
|
1471
1624
|
in: (propertyName: '_id' | 'title' | 'description' | 'hidden' | 'collectionIds' | 'slug' | '_createdDate' | '_updatedDate', value: any) => ProjectsQueryBuilder;
|
|
1472
|
-
/** @documentationMaturity preview */
|
|
1473
1625
|
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
|
-
*/
|
|
1626
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
1477
1627
|
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
|
-
*/
|
|
1628
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
1481
1629
|
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
|
-
*/
|
|
1630
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
|
|
1485
1631
|
limit: (limit: number) => ProjectsQueryBuilder;
|
|
1486
|
-
/** @param cursor - A pointer to specific record
|
|
1487
|
-
* @documentationMaturity preview
|
|
1488
|
-
*/
|
|
1632
|
+
/** @param cursor - A pointer to specific record */
|
|
1489
1633
|
skipTo: (cursor: string) => ProjectsQueryBuilder;
|
|
1490
|
-
/** @documentationMaturity preview */
|
|
1491
1634
|
find: () => Promise<ProjectsQueryResult>;
|
|
1492
1635
|
}
|
|
1636
|
+
/**
|
|
1637
|
+
* Deprecated - please use ProjectsInCollectionsService.UpdateProjectOrderInCollection instead
|
|
1638
|
+
* our Client still use it
|
|
1639
|
+
* @param sortOrder - Index that determines the placement of a project within the collection.
|
|
1640
|
+
* @public
|
|
1641
|
+
* @requiredField identifiers
|
|
1642
|
+
* @requiredField identifiers.collectionId
|
|
1643
|
+
* @requiredField identifiers.projectId
|
|
1644
|
+
* @requiredField sortOrder
|
|
1645
|
+
* @permissionId PORTFOLIO.PROJECT_UPDATE
|
|
1646
|
+
* @applicableIdentity APP
|
|
1647
|
+
* @fqn com.wixpress.portfolio.projects.ProjectsService.UpdateProjectOrderInCollection
|
|
1648
|
+
* @deprecated
|
|
1649
|
+
*/
|
|
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>>;
|
|
1493
1651
|
interface UpdateProjectOrderInCollectionIdentifiers {
|
|
1494
1652
|
/**
|
|
1495
1653
|
* ID of the project to update.
|
|
@@ -1502,9 +1660,22 @@ interface UpdateProjectOrderInCollectionIdentifiers {
|
|
|
1502
1660
|
*/
|
|
1503
1661
|
collectionId: string;
|
|
1504
1662
|
}
|
|
1663
|
+
/**
|
|
1664
|
+
* Deprecated - please use ProjectsInCollectionsService.QueryProjectsInCollections instead
|
|
1665
|
+
* our Client still use it
|
|
1666
|
+
* @param query - WQL expression
|
|
1667
|
+
* @public
|
|
1668
|
+
* @requiredField query
|
|
1669
|
+
* @permissionId PORTFOLIO.PROJECT_READ
|
|
1670
|
+
* @applicableIdentity APP
|
|
1671
|
+
* @applicableIdentity VISITOR
|
|
1672
|
+
* @fqn com.wixpress.portfolio.projects.ProjectsService.QueryProjectsWithCollectionInfo
|
|
1673
|
+
* @deprecated
|
|
1674
|
+
*/
|
|
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>>;
|
|
1505
1676
|
interface QueryProjectsWithCollectionInfoOptions {
|
|
1506
1677
|
/** Include page url */
|
|
1507
1678
|
includePageUrl?: boolean | null;
|
|
1508
1679
|
}
|
|
1509
1680
|
|
|
1510
|
-
export { type
|
|
1681
|
+
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 };
|