@wix/portfolio 1.0.96 → 1.0.97
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/package.json +4 -4
- package/type-bundles/context.bundle.d.ts +123 -93
- package/type-bundles/index.bundle.d.ts +123 -93
- package/type-bundles/meta.bundle.d.ts +158 -118
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/portfolio",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.97",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -20,9 +20,9 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@wix/portfolio_collections": "1.0.30",
|
|
22
22
|
"@wix/portfolio_portfolio-settings": "1.0.16",
|
|
23
|
-
"@wix/portfolio_project-in-collections": "1.0.
|
|
23
|
+
"@wix/portfolio_project-in-collections": "1.0.30",
|
|
24
24
|
"@wix/portfolio_project-items": "1.0.34",
|
|
25
|
-
"@wix/portfolio_projects": "1.0.
|
|
25
|
+
"@wix/portfolio_projects": "1.0.42",
|
|
26
26
|
"@wix/portfolio_synced-project": "1.0.13"
|
|
27
27
|
},
|
|
28
28
|
"devDependencies": {
|
|
@@ -48,5 +48,5 @@
|
|
|
48
48
|
"fqdn": ""
|
|
49
49
|
}
|
|
50
50
|
},
|
|
51
|
-
"falconPackageHash": "
|
|
51
|
+
"falconPackageHash": "9f2217cb67488ec1cae6311af8e51128bf68024df90d601ebdbc768c"
|
|
52
52
|
}
|
|
@@ -2461,55 +2461,56 @@ declare namespace context$3 {
|
|
|
2461
2461
|
export { type ActionEvent$3 as ActionEvent, type App$1 as App, type ApplicationError$1 as ApplicationError, type BaseEventMetadata$2 as BaseEventMetadata, type BulkActionMetadata$1 as BulkActionMetadata, type context$3_BulkCreateProjectItemResult as BulkCreateProjectItemResult, type context$3_BulkCreateProjectItemsOptions as BulkCreateProjectItemsOptions, type context$3_BulkCreateProjectItemsRequest as BulkCreateProjectItemsRequest, type context$3_BulkCreateProjectItemsResponse as BulkCreateProjectItemsResponse, type context$3_BulkCreateProjectItemsResponseNonNullableFields as BulkCreateProjectItemsResponseNonNullableFields, type context$3_BulkDeleteProjectItemResult as BulkDeleteProjectItemResult, type context$3_BulkDeleteProjectItemsOptions as BulkDeleteProjectItemsOptions, type context$3_BulkDeleteProjectItemsRequest as BulkDeleteProjectItemsRequest, type context$3_BulkDeleteProjectItemsResponse as BulkDeleteProjectItemsResponse, type context$3_BulkDeleteProjectItemsResponseNonNullableFields as BulkDeleteProjectItemsResponseNonNullableFields, type context$3_BulkUpdateProjectItemResult as BulkUpdateProjectItemResult, type context$3_BulkUpdateProjectItemsOptions as BulkUpdateProjectItemsOptions, type context$3_BulkUpdateProjectItemsRequest as BulkUpdateProjectItemsRequest, type context$3_BulkUpdateProjectItemsResponse as BulkUpdateProjectItemsResponse, type context$3_BulkUpdateProjectItemsResponseNonNullableFields as BulkUpdateProjectItemsResponseNonNullableFields, type context$3_CreateProjectGalleryRequest as CreateProjectGalleryRequest, type context$3_CreateProjectGalleryResponse as CreateProjectGalleryResponse, type context$3_CreateProjectItemRequest as CreateProjectItemRequest, type context$3_CreateProjectItemResponse as CreateProjectItemResponse, type context$3_CreateProjectItemResponseNonNullableFields as CreateProjectItemResponseNonNullableFields, type CursorPaging$3 as CursorPaging, type Cursors$3 as Cursors, type context$3_DeleteProjectItemRequest as DeleteProjectItemRequest, type context$3_DeleteProjectItemResponse as DeleteProjectItemResponse, type context$3_DeleteProjectItemResponseNonNullableFields as DeleteProjectItemResponseNonNullableFields, type DeletedProjectRestored$1 as DeletedProjectRestored, type DomainEvent$3 as DomainEvent, type DomainEventBodyOneOf$3 as DomainEventBodyOneOf, type context$3_DuplicateProjectItemsOptions as DuplicateProjectItemsOptions, type context$3_DuplicateProjectItemsRequest as DuplicateProjectItemsRequest, type context$3_DuplicateProjectItemsResponse as DuplicateProjectItemsResponse, type context$3_DuplicateProjectItemsResponseNonNullableFields as DuplicateProjectItemsResponseNonNullableFields, type Empty$2 as Empty, type EntityCreatedEvent$3 as EntityCreatedEvent, type EntityDeletedEvent$3 as EntityDeletedEvent, type EntityUpdatedEvent$3 as EntityUpdatedEvent, type EventMetadata$2 as EventMetadata, type File$1 as File, type context$3_GenerateTokenForProjectItemsRequest as GenerateTokenForProjectItemsRequest, type context$3_GenerateTokenForProjectItemsResponse as GenerateTokenForProjectItemsResponse, type context$3_GetProjectItemRequest as GetProjectItemRequest, type context$3_GetProjectItemResponse as GetProjectItemResponse, type context$3_GetProjectItemResponseNonNullableFields as GetProjectItemResponseNonNullableFields, type IdentificationData$3 as IdentificationData, type IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf, type Image$2 as Image, ImageType$2 as ImageType, type InvalidateCache$1 as InvalidateCache, type InvalidateCacheGetByOneOf$1 as InvalidateCacheGetByOneOf, type context$3_Item as Item, type ItemMetadata$1 as ItemMetadata, type context$3_ItemMetadataOneOf as ItemMetadataOneOf, type context$3_ItemNonNullableFields as ItemNonNullableFields, type context$3_Link as Link, type context$3_ListProjectItemsOptions as ListProjectItemsOptions, type context$3_ListProjectItemsRequest as ListProjectItemsRequest, type context$3_ListProjectItemsResponse as ListProjectItemsResponse, type context$3_ListProjectItemsResponseNonNullableFields as ListProjectItemsResponseNonNullableFields, type context$3_MaskedItem as MaskedItem, type MessageEnvelope$3 as MessageEnvelope, type Page$1 as Page, type Paging$2 as Paging, type PagingMetadataV2$3 as PagingMetadataV2, type Point$2 as Point, type context$3_ProjectItemCreatedEnvelope as ProjectItemCreatedEnvelope, type context$3_ProjectItemDeletedEnvelope as ProjectItemDeletedEnvelope, type context$3_ProjectItemMediaToken as ProjectItemMediaToken, type context$3_ProjectItemUpdatedEnvelope as ProjectItemUpdatedEnvelope, type context$3_QueryProjectItemsRequest as QueryProjectItemsRequest, type context$3_QueryProjectItemsResponse as QueryProjectItemsResponse, type QueryV2$2 as QueryV2, type QueryV2PagingMethodOneOf$2 as QueryV2PagingMethodOneOf, type RestoreInfo$3 as RestoreInfo, SortOrder$2 as SortOrder, type Sorting$2 as Sorting, type context$3_Tags as Tags, context$3_Type as Type, type URI$1 as URI, type UnsharpMasking$2 as UnsharpMasking, type context$3_UpdateProjectItem as UpdateProjectItem, type context$3_UpdateProjectItemRequest as UpdateProjectItemRequest, type context$3_UpdateProjectItemResponse as UpdateProjectItemResponse, type context$3_UpdateProjectItemResponseNonNullableFields as UpdateProjectItemResponseNonNullableFields, type Video$2 as Video, type VideoResolution$2 as VideoResolution, WebhookIdentityType$3 as WebhookIdentityType, type context$3__publicOnProjectItemCreatedType as _publicOnProjectItemCreatedType, type context$3__publicOnProjectItemDeletedType as _publicOnProjectItemDeletedType, type context$3__publicOnProjectItemUpdatedType as _publicOnProjectItemUpdatedType, context$3_bulkCreateProjectItems as bulkCreateProjectItems, context$3_bulkDeleteProjectItems as bulkDeleteProjectItems, context$3_bulkUpdateProjectItems as bulkUpdateProjectItems, context$3_createProjectItem as createProjectItem, context$3_deleteProjectItem as deleteProjectItem, context$3_duplicateProjectItems as duplicateProjectItems, context$3_getProjectItem as getProjectItem, context$3_listProjectItems as listProjectItems, context$3_onProjectItemCreated as onProjectItemCreated, context$3_onProjectItemDeleted as onProjectItemDeleted, context$3_onProjectItemUpdated as onProjectItemUpdated, onProjectItemCreated$1 as publicOnProjectItemCreated, onProjectItemDeleted$1 as publicOnProjectItemDeleted, onProjectItemUpdated$1 as publicOnProjectItemUpdated, context$3_updateProjectItem as updateProjectItem };
|
|
2462
2462
|
}
|
|
2463
2463
|
|
|
2464
|
-
/** Project is the main entity of ProjectsService */
|
|
2465
2464
|
interface Project$1 extends ProjectCoverOneOf$1 {
|
|
2466
|
-
/**
|
|
2465
|
+
/** Project cover image. */
|
|
2467
2466
|
coverImage?: Image$1;
|
|
2468
|
-
/**
|
|
2467
|
+
/** Project cover video. */
|
|
2469
2468
|
coverVideo?: Video$1;
|
|
2470
2469
|
/**
|
|
2471
|
-
* Project ID
|
|
2470
|
+
* Project ID.
|
|
2472
2471
|
* @readonly
|
|
2473
2472
|
*/
|
|
2474
2473
|
_id?: string | null;
|
|
2475
2474
|
/**
|
|
2476
|
-
*
|
|
2475
|
+
* Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object.
|
|
2477
2476
|
* @readonly
|
|
2478
2477
|
*/
|
|
2479
2478
|
revision?: string | null;
|
|
2479
|
+
/** Project title. */
|
|
2480
2480
|
title?: string | null;
|
|
2481
|
+
/** Project description. */
|
|
2481
2482
|
description?: string | null;
|
|
2482
|
-
/**
|
|
2483
|
+
/** Whether the project is hidden from the portfolio. */
|
|
2483
2484
|
hidden?: boolean | null;
|
|
2484
|
-
/**
|
|
2485
|
+
/** IDs of the collections that include the project. */
|
|
2485
2486
|
collectionIds?: string[];
|
|
2486
|
-
/**
|
|
2487
|
+
/** Project details. */
|
|
2487
2488
|
details?: ProjectDetail$1[];
|
|
2488
|
-
/** Project
|
|
2489
|
+
/** Project slug. */
|
|
2489
2490
|
slug?: string | null;
|
|
2490
2491
|
/**
|
|
2491
|
-
*
|
|
2492
|
+
* Date and time the project was created.
|
|
2492
2493
|
* @readonly
|
|
2493
2494
|
*/
|
|
2494
2495
|
_createdDate?: Date;
|
|
2495
2496
|
/**
|
|
2496
|
-
*
|
|
2497
|
+
* Date and time the project was updated.
|
|
2497
2498
|
* @readonly
|
|
2498
2499
|
*/
|
|
2499
2500
|
_updatedDate?: Date;
|
|
2500
2501
|
/**
|
|
2501
|
-
*
|
|
2502
|
+
* Project's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
|
|
2502
2503
|
* @readonly
|
|
2503
2504
|
*/
|
|
2504
2505
|
url?: string;
|
|
2505
|
-
/** SEO data
|
|
2506
|
+
/** Project SEO data. */
|
|
2506
2507
|
seoData?: SeoSchema$1;
|
|
2507
2508
|
}
|
|
2508
2509
|
/** @oneof */
|
|
2509
2510
|
interface ProjectCoverOneOf$1 {
|
|
2510
|
-
/**
|
|
2511
|
+
/** Project cover image. */
|
|
2511
2512
|
coverImage?: Image$1;
|
|
2512
|
-
/**
|
|
2513
|
+
/** Project cover video. */
|
|
2513
2514
|
coverVideo?: Video$1;
|
|
2514
2515
|
}
|
|
2515
2516
|
interface Image$1 {
|
|
@@ -2567,21 +2568,30 @@ interface VideoResolution$1 {
|
|
|
2567
2568
|
/** Video filename. */
|
|
2568
2569
|
filename?: string | null;
|
|
2569
2570
|
}
|
|
2571
|
+
/**
|
|
2572
|
+
* Project label.
|
|
2573
|
+
* One of:
|
|
2574
|
+
* + `text`
|
|
2575
|
+
* + `link`
|
|
2576
|
+
*/
|
|
2570
2577
|
interface ProjectDetail$1 extends ProjectDetailValueOneOf$1 {
|
|
2578
|
+
/** Project label in plain text format. */
|
|
2571
2579
|
text?: string;
|
|
2572
|
-
/**
|
|
2580
|
+
/** Project label in link format. */
|
|
2573
2581
|
link?: DetailsLink$1;
|
|
2574
2582
|
label?: string;
|
|
2575
2583
|
}
|
|
2576
2584
|
/** @oneof */
|
|
2577
2585
|
interface ProjectDetailValueOneOf$1 {
|
|
2586
|
+
/** Project label in plain text format. */
|
|
2578
2587
|
text?: string;
|
|
2579
|
-
/**
|
|
2588
|
+
/** Project label in link format. */
|
|
2580
2589
|
link?: DetailsLink$1;
|
|
2581
2590
|
}
|
|
2582
2591
|
interface DetailsLink$1 {
|
|
2592
|
+
/** Display text of the link. */
|
|
2583
2593
|
text?: string | null;
|
|
2584
|
-
/**
|
|
2594
|
+
/** Target URL of the link. */
|
|
2585
2595
|
url?: string | null;
|
|
2586
2596
|
/**
|
|
2587
2597
|
* Whether the link opens in a new tab or window. One of:
|
|
@@ -3087,27 +3097,27 @@ interface DeletedProjectRestored {
|
|
|
3087
3097
|
deletionTimestamp?: Date;
|
|
3088
3098
|
}
|
|
3089
3099
|
interface CreateProjectRequest {
|
|
3090
|
-
/** Project to
|
|
3100
|
+
/** Project to create. */
|
|
3091
3101
|
project: Project$1;
|
|
3092
3102
|
}
|
|
3093
3103
|
interface CreateProjectResponse {
|
|
3094
|
-
/**
|
|
3104
|
+
/** Created project. */
|
|
3095
3105
|
project?: Project$1;
|
|
3096
3106
|
}
|
|
3097
3107
|
interface GetProjectRequest {
|
|
3098
|
-
/**
|
|
3108
|
+
/** ID of the project to retrieve. */
|
|
3099
3109
|
projectId: string;
|
|
3100
3110
|
/** Include page url */
|
|
3101
3111
|
includePageUrl?: boolean | null;
|
|
3102
3112
|
}
|
|
3103
3113
|
interface GetProjectResponse {
|
|
3104
|
-
/** The
|
|
3114
|
+
/** The requested project. */
|
|
3105
3115
|
project?: Project$1;
|
|
3106
3116
|
}
|
|
3107
3117
|
interface ListProjectsRequest {
|
|
3108
|
-
/** Projects limit per response is maximum 100, In the first request the cursor is None */
|
|
3118
|
+
/** Projects limit per response is maximum 100, In the first request the cursor is None ? */
|
|
3109
3119
|
paging?: CursorPaging$2;
|
|
3110
|
-
/** Include page url */
|
|
3120
|
+
/** Include page url ? */
|
|
3111
3121
|
includePageUrl?: boolean | null;
|
|
3112
3122
|
}
|
|
3113
3123
|
interface CursorPaging$2 {
|
|
@@ -3122,9 +3132,9 @@ interface CursorPaging$2 {
|
|
|
3122
3132
|
cursor?: string | null;
|
|
3123
3133
|
}
|
|
3124
3134
|
interface ListProjectsResponse {
|
|
3125
|
-
/**
|
|
3135
|
+
/** List of projects. */
|
|
3126
3136
|
projects?: Project$1[];
|
|
3127
|
-
/** Paging metadata */
|
|
3137
|
+
/** Paging metadata ? */
|
|
3128
3138
|
metadata?: PagingMetadataV2$2;
|
|
3129
3139
|
}
|
|
3130
3140
|
interface PagingMetadataV2$2 {
|
|
@@ -3146,33 +3156,33 @@ interface Cursors$2 {
|
|
|
3146
3156
|
prev?: string | null;
|
|
3147
3157
|
}
|
|
3148
3158
|
interface UpdateProjectRequest {
|
|
3149
|
-
/** Project to
|
|
3159
|
+
/** Project to update. */
|
|
3150
3160
|
project: Project$1;
|
|
3151
3161
|
}
|
|
3152
3162
|
interface UpdateProjectResponse {
|
|
3153
|
-
/**
|
|
3163
|
+
/** Updated project. */
|
|
3154
3164
|
project?: Project$1;
|
|
3155
3165
|
}
|
|
3156
3166
|
interface BulkUpdateProjectsRequest {
|
|
3157
|
-
/**
|
|
3167
|
+
/** Projects to update. */
|
|
3158
3168
|
projects?: MaskedProject[];
|
|
3159
|
-
/**
|
|
3169
|
+
/** Whether to include the updated projects in the response. Set to `true`` to receive the projects in the response. */
|
|
3160
3170
|
returnFullEntity?: boolean | null;
|
|
3161
3171
|
}
|
|
3162
3172
|
interface MaskedProject {
|
|
3163
|
-
/** Project to
|
|
3173
|
+
/** Project to update. */
|
|
3164
3174
|
project?: Project$1;
|
|
3165
3175
|
}
|
|
3166
3176
|
interface BulkUpdateProjectsResponse {
|
|
3167
|
-
/**
|
|
3177
|
+
/** Items created by bulk action. */
|
|
3168
3178
|
results?: BulkUpdateProjectsResult[];
|
|
3169
|
-
/**
|
|
3179
|
+
/** Bulk action metadata. */
|
|
3170
3180
|
bulkActionMetadata?: BulkActionMetadata;
|
|
3171
3181
|
}
|
|
3172
3182
|
interface BulkUpdateProjectsResult {
|
|
3173
|
-
/**
|
|
3183
|
+
/** Item metadata. */
|
|
3174
3184
|
itemMetadata?: ItemMetadata;
|
|
3175
|
-
/** Updated
|
|
3185
|
+
/** Updated project. */
|
|
3176
3186
|
project?: Project$1;
|
|
3177
3187
|
}
|
|
3178
3188
|
interface ItemMetadata {
|
|
@@ -3202,17 +3212,17 @@ interface BulkActionMetadata {
|
|
|
3202
3212
|
undetailedFailures?: number;
|
|
3203
3213
|
}
|
|
3204
3214
|
interface DeleteProjectRequest {
|
|
3205
|
-
/**
|
|
3215
|
+
/** ID of the project to delete. */
|
|
3206
3216
|
projectId: string;
|
|
3207
3217
|
}
|
|
3208
3218
|
interface DeleteProjectResponse {
|
|
3209
|
-
/**
|
|
3219
|
+
/** ID of the deleted project. */
|
|
3210
3220
|
projectId?: string;
|
|
3211
3221
|
}
|
|
3212
3222
|
interface QueryProjectsRequest {
|
|
3213
|
-
/**
|
|
3223
|
+
/** Query options. */
|
|
3214
3224
|
query: QueryV2$1;
|
|
3215
|
-
/** Include page url */
|
|
3225
|
+
/** Include page url ? */
|
|
3216
3226
|
includePageUrl?: boolean | null;
|
|
3217
3227
|
}
|
|
3218
3228
|
interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
|
|
@@ -3261,9 +3271,9 @@ interface Paging$1 {
|
|
|
3261
3271
|
offset?: number | null;
|
|
3262
3272
|
}
|
|
3263
3273
|
interface QueryProjectsResponse {
|
|
3264
|
-
/**
|
|
3274
|
+
/** List of projects. */
|
|
3265
3275
|
projects?: Project$1[];
|
|
3266
|
-
/** Paging metadata */
|
|
3276
|
+
/** Paging metadata ? */
|
|
3267
3277
|
metadata?: PagingMetadataV2$2;
|
|
3268
3278
|
}
|
|
3269
3279
|
interface UpdateProjectOrderInCollectionRequest$1 {
|
|
@@ -3554,62 +3564,64 @@ interface GetProjectOptions {
|
|
|
3554
3564
|
includePageUrl?: boolean | null;
|
|
3555
3565
|
}
|
|
3556
3566
|
interface ListProjectsOptions {
|
|
3557
|
-
/** Projects limit per response is maximum 100, In the first request the cursor is None */
|
|
3567
|
+
/** Projects limit per response is maximum 100, In the first request the cursor is None ? */
|
|
3558
3568
|
paging?: CursorPaging$2;
|
|
3559
|
-
/** Include page url */
|
|
3569
|
+
/** Include page url ? */
|
|
3560
3570
|
includePageUrl?: boolean | null;
|
|
3561
3571
|
}
|
|
3562
3572
|
interface UpdateProject {
|
|
3563
|
-
/**
|
|
3573
|
+
/** Project cover image. */
|
|
3564
3574
|
coverImage?: Image$1;
|
|
3565
|
-
/**
|
|
3575
|
+
/** Project cover video. */
|
|
3566
3576
|
coverVideo?: Video$1;
|
|
3567
3577
|
/**
|
|
3568
|
-
* Project ID
|
|
3578
|
+
* Project ID.
|
|
3569
3579
|
* @readonly
|
|
3570
3580
|
*/
|
|
3571
3581
|
_id?: string | null;
|
|
3572
3582
|
/**
|
|
3573
|
-
*
|
|
3583
|
+
* Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object.
|
|
3574
3584
|
* @readonly
|
|
3575
3585
|
*/
|
|
3576
3586
|
revision?: string | null;
|
|
3587
|
+
/** Project title. */
|
|
3577
3588
|
title?: string | null;
|
|
3589
|
+
/** Project description. */
|
|
3578
3590
|
description?: string | null;
|
|
3579
|
-
/**
|
|
3591
|
+
/** Whether the project is hidden from the portfolio. */
|
|
3580
3592
|
hidden?: boolean | null;
|
|
3581
|
-
/**
|
|
3593
|
+
/** IDs of the collections that include the project. */
|
|
3582
3594
|
collectionIds?: string[];
|
|
3583
|
-
/**
|
|
3595
|
+
/** Project details. */
|
|
3584
3596
|
details?: ProjectDetail$1[];
|
|
3585
|
-
/** Project
|
|
3597
|
+
/** Project slug. */
|
|
3586
3598
|
slug?: string | null;
|
|
3587
3599
|
/**
|
|
3588
|
-
*
|
|
3600
|
+
* Date and time the project was created.
|
|
3589
3601
|
* @readonly
|
|
3590
3602
|
*/
|
|
3591
3603
|
_createdDate?: Date;
|
|
3592
3604
|
/**
|
|
3593
|
-
*
|
|
3605
|
+
* Date and time the project was updated.
|
|
3594
3606
|
* @readonly
|
|
3595
3607
|
*/
|
|
3596
3608
|
_updatedDate?: Date;
|
|
3597
3609
|
/**
|
|
3598
|
-
*
|
|
3610
|
+
* Project's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
|
|
3599
3611
|
* @readonly
|
|
3600
3612
|
*/
|
|
3601
3613
|
url?: string;
|
|
3602
|
-
/** SEO data
|
|
3614
|
+
/** Project SEO data. */
|
|
3603
3615
|
seoData?: SeoSchema$1;
|
|
3604
3616
|
}
|
|
3605
3617
|
interface BulkUpdateProjectsOptions {
|
|
3606
|
-
/**
|
|
3618
|
+
/** Projects to update. */
|
|
3607
3619
|
projects?: MaskedProject[];
|
|
3608
|
-
/**
|
|
3620
|
+
/** Whether to include the updated projects in the response. Set to `true`` to receive the projects in the response. */
|
|
3609
3621
|
returnFullEntity?: boolean | null;
|
|
3610
3622
|
}
|
|
3611
3623
|
interface QueryProjectsOptions {
|
|
3612
|
-
/** Include page url */
|
|
3624
|
+
/** Include page url ? */
|
|
3613
3625
|
includePageUrl?: boolean | null | undefined;
|
|
3614
3626
|
}
|
|
3615
3627
|
interface QueryCursorResult$1 {
|
|
@@ -3715,57 +3727,61 @@ interface GetProjectPageDataSignature {
|
|
|
3715
3727
|
declare function createProject$1(httpClient: HttpClient): CreateProjectSignature;
|
|
3716
3728
|
interface CreateProjectSignature {
|
|
3717
3729
|
/**
|
|
3718
|
-
* Creates a
|
|
3719
|
-
* @param - Project to
|
|
3720
|
-
* @returns
|
|
3730
|
+
* Creates a project.
|
|
3731
|
+
* @param - Project to create.
|
|
3732
|
+
* @returns Created project.
|
|
3721
3733
|
*/
|
|
3722
3734
|
(project: Project$1): Promise<Project$1 & ProjectNonNullableFields$1>;
|
|
3723
3735
|
}
|
|
3724
3736
|
declare function getProject$1(httpClient: HttpClient): GetProjectSignature;
|
|
3725
3737
|
interface GetProjectSignature {
|
|
3726
3738
|
/**
|
|
3727
|
-
*
|
|
3728
|
-
* @param -
|
|
3729
|
-
* @returns The
|
|
3739
|
+
* Retrieves a project.
|
|
3740
|
+
* @param - ID of the project to retrieve.
|
|
3741
|
+
* @returns The requested project.
|
|
3730
3742
|
*/
|
|
3731
3743
|
(projectId: string, options?: GetProjectOptions | undefined): Promise<Project$1 & ProjectNonNullableFields$1>;
|
|
3732
3744
|
}
|
|
3733
3745
|
declare function listProjects$1(httpClient: HttpClient): ListProjectsSignature;
|
|
3734
3746
|
interface ListProjectsSignature {
|
|
3735
3747
|
/**
|
|
3736
|
-
*
|
|
3748
|
+
* Retrieves a list of all projects in a portfolio.
|
|
3737
3749
|
*/
|
|
3738
3750
|
(options?: ListProjectsOptions | undefined): Promise<ListProjectsResponse & ListProjectsResponseNonNullableFields>;
|
|
3739
3751
|
}
|
|
3740
3752
|
declare function updateProject$1(httpClient: HttpClient): UpdateProjectSignature;
|
|
3741
3753
|
interface UpdateProjectSignature {
|
|
3742
3754
|
/**
|
|
3743
|
-
*
|
|
3744
|
-
*
|
|
3745
|
-
* @
|
|
3746
|
-
* @returns The updated Project
|
|
3755
|
+
* Updates a project.
|
|
3756
|
+
* @param - Project ID.
|
|
3757
|
+
* @returns Updated project.
|
|
3747
3758
|
*/
|
|
3748
3759
|
(_id: string | null, project: UpdateProject): Promise<Project$1 & ProjectNonNullableFields$1>;
|
|
3749
3760
|
}
|
|
3750
3761
|
declare function bulkUpdateProjects$1(httpClient: HttpClient): BulkUpdateProjectsSignature;
|
|
3751
3762
|
interface BulkUpdateProjectsSignature {
|
|
3752
3763
|
/**
|
|
3753
|
-
*
|
|
3764
|
+
* Updates multiple projects.
|
|
3754
3765
|
*/
|
|
3755
3766
|
(options?: BulkUpdateProjectsOptions | undefined): Promise<BulkUpdateProjectsResponse & BulkUpdateProjectsResponseNonNullableFields>;
|
|
3756
3767
|
}
|
|
3757
3768
|
declare function deleteProject$1(httpClient: HttpClient): DeleteProjectSignature;
|
|
3758
3769
|
interface DeleteProjectSignature {
|
|
3759
3770
|
/**
|
|
3760
|
-
*
|
|
3761
|
-
* @param -
|
|
3771
|
+
* Deletes a project.
|
|
3772
|
+
* @param - ID of the project to delete.
|
|
3762
3773
|
*/
|
|
3763
3774
|
(projectId: string): Promise<DeleteProjectResponse & DeleteProjectResponseNonNullableFields>;
|
|
3764
3775
|
}
|
|
3765
3776
|
declare function queryProjects$1(httpClient: HttpClient): QueryProjectsSignature;
|
|
3766
3777
|
interface QueryProjectsSignature {
|
|
3767
3778
|
/**
|
|
3768
|
-
*
|
|
3779
|
+
* Retrieves a list of projects, given the provided paging, filtering, and sorting. Up to 100 projects can be returned per request.
|
|
3780
|
+
*
|
|
3781
|
+
* The default `sort` is `id` in `ASC`.
|
|
3782
|
+
*
|
|
3783
|
+
* For a detailed list of supported operations, see [Projects: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/sort-and-filter).
|
|
3784
|
+
* To learn how to query projects, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
|
|
3769
3785
|
*/
|
|
3770
3786
|
(options?: QueryProjectsOptions | undefined): ProjectsQueryBuilder;
|
|
3771
3787
|
}
|
|
@@ -3825,7 +3841,9 @@ declare const updateProjectOrderInCollection$2: MaybeContext<BuildRESTFunction<t
|
|
|
3825
3841
|
declare const queryProjectsWithCollectionInfo: MaybeContext<BuildRESTFunction<typeof queryProjectsWithCollectionInfo$1> & typeof queryProjectsWithCollectionInfo$1>;
|
|
3826
3842
|
|
|
3827
3843
|
type _publicOnProjectCreatedType = typeof onProjectCreated$1;
|
|
3828
|
-
/**
|
|
3844
|
+
/**
|
|
3845
|
+
* Triggered when a project is created.
|
|
3846
|
+
*/
|
|
3829
3847
|
declare const onProjectCreated: ReturnType<typeof createEventModule$1<_publicOnProjectCreatedType>>;
|
|
3830
3848
|
|
|
3831
3849
|
type _publicOnProjectUpdatedType = typeof onProjectUpdated$1;
|
|
@@ -3833,7 +3851,9 @@ type _publicOnProjectUpdatedType = typeof onProjectUpdated$1;
|
|
|
3833
3851
|
declare const onProjectUpdated: ReturnType<typeof createEventModule$1<_publicOnProjectUpdatedType>>;
|
|
3834
3852
|
|
|
3835
3853
|
type _publicOnProjectDeletedType = typeof onProjectDeleted$1;
|
|
3836
|
-
/**
|
|
3854
|
+
/**
|
|
3855
|
+
* Triggered when a project is deleted.
|
|
3856
|
+
*/
|
|
3837
3857
|
declare const onProjectDeleted: ReturnType<typeof createEventModule$1<_publicOnProjectDeletedType>>;
|
|
3838
3858
|
|
|
3839
3859
|
type context$2_App = App;
|
|
@@ -3921,55 +3941,56 @@ interface ProjectInCollection {
|
|
|
3921
3941
|
/** The sort order of the project in the given Collection */
|
|
3922
3942
|
sortOrder?: number | null;
|
|
3923
3943
|
}
|
|
3924
|
-
/** Project is the main entity of ProjectsService */
|
|
3925
3944
|
interface Project extends ProjectCoverOneOf {
|
|
3926
|
-
/**
|
|
3945
|
+
/** Project cover image. */
|
|
3927
3946
|
coverImage?: Image;
|
|
3928
|
-
/**
|
|
3947
|
+
/** Project cover video. */
|
|
3929
3948
|
coverVideo?: Video;
|
|
3930
3949
|
/**
|
|
3931
|
-
* Project ID
|
|
3950
|
+
* Project ID.
|
|
3932
3951
|
* @readonly
|
|
3933
3952
|
*/
|
|
3934
3953
|
_id?: string | null;
|
|
3935
3954
|
/**
|
|
3936
|
-
*
|
|
3955
|
+
* Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object.
|
|
3937
3956
|
* @readonly
|
|
3938
3957
|
*/
|
|
3939
3958
|
revision?: string | null;
|
|
3959
|
+
/** Project title. */
|
|
3940
3960
|
title?: string | null;
|
|
3961
|
+
/** Project description. */
|
|
3941
3962
|
description?: string | null;
|
|
3942
|
-
/**
|
|
3963
|
+
/** Whether the project is hidden from the portfolio. */
|
|
3943
3964
|
hidden?: boolean | null;
|
|
3944
|
-
/**
|
|
3965
|
+
/** IDs of the collections that include the project. */
|
|
3945
3966
|
collectionIds?: string[];
|
|
3946
|
-
/**
|
|
3967
|
+
/** Project details. */
|
|
3947
3968
|
details?: ProjectDetail[];
|
|
3948
|
-
/** Project
|
|
3969
|
+
/** Project slug. */
|
|
3949
3970
|
slug?: string | null;
|
|
3950
3971
|
/**
|
|
3951
|
-
*
|
|
3972
|
+
* Date and time the project was created.
|
|
3952
3973
|
* @readonly
|
|
3953
3974
|
*/
|
|
3954
3975
|
_createdDate?: Date;
|
|
3955
3976
|
/**
|
|
3956
|
-
*
|
|
3977
|
+
* Date and time the project was updated.
|
|
3957
3978
|
* @readonly
|
|
3958
3979
|
*/
|
|
3959
3980
|
_updatedDate?: Date;
|
|
3960
3981
|
/**
|
|
3961
|
-
*
|
|
3982
|
+
* Project's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
|
|
3962
3983
|
* @readonly
|
|
3963
3984
|
*/
|
|
3964
3985
|
url?: string;
|
|
3965
|
-
/** SEO data
|
|
3986
|
+
/** Project SEO data. */
|
|
3966
3987
|
seoData?: SeoSchema;
|
|
3967
3988
|
}
|
|
3968
3989
|
/** @oneof */
|
|
3969
3990
|
interface ProjectCoverOneOf {
|
|
3970
|
-
/**
|
|
3991
|
+
/** Project cover image. */
|
|
3971
3992
|
coverImage?: Image;
|
|
3972
|
-
/**
|
|
3993
|
+
/** Project cover video. */
|
|
3973
3994
|
coverVideo?: Video;
|
|
3974
3995
|
}
|
|
3975
3996
|
interface Image {
|
|
@@ -4027,21 +4048,30 @@ interface VideoResolution {
|
|
|
4027
4048
|
/** Video filename. */
|
|
4028
4049
|
filename?: string | null;
|
|
4029
4050
|
}
|
|
4051
|
+
/**
|
|
4052
|
+
* Project label.
|
|
4053
|
+
* One of:
|
|
4054
|
+
* + `text`
|
|
4055
|
+
* + `link`
|
|
4056
|
+
*/
|
|
4030
4057
|
interface ProjectDetail extends ProjectDetailValueOneOf {
|
|
4058
|
+
/** Project label in plain text format. */
|
|
4031
4059
|
text?: string;
|
|
4032
|
-
/**
|
|
4060
|
+
/** Project label in link format. */
|
|
4033
4061
|
link?: DetailsLink;
|
|
4034
4062
|
label?: string;
|
|
4035
4063
|
}
|
|
4036
4064
|
/** @oneof */
|
|
4037
4065
|
interface ProjectDetailValueOneOf {
|
|
4066
|
+
/** Project label in plain text format. */
|
|
4038
4067
|
text?: string;
|
|
4039
|
-
/**
|
|
4068
|
+
/** Project label in link format. */
|
|
4040
4069
|
link?: DetailsLink;
|
|
4041
4070
|
}
|
|
4042
4071
|
interface DetailsLink {
|
|
4072
|
+
/** Display text of the link. */
|
|
4043
4073
|
text?: string | null;
|
|
4044
|
-
/**
|
|
4074
|
+
/** Target URL of the link. */
|
|
4045
4075
|
url?: string | null;
|
|
4046
4076
|
/**
|
|
4047
4077
|
* Whether the link opens in a new tab or window. One of:
|