@wix/portfolio 1.0.94 → 1.0.96

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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/portfolio",
3
- "version": "1.0.94",
3
+ "version": "1.0.96",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -18,11 +18,11 @@
18
18
  "type-bundles"
19
19
  ],
20
20
  "dependencies": {
21
- "@wix/portfolio_collections": "1.0.28",
21
+ "@wix/portfolio_collections": "1.0.30",
22
22
  "@wix/portfolio_portfolio-settings": "1.0.16",
23
- "@wix/portfolio_project-in-collections": "1.0.27",
24
- "@wix/portfolio_project-items": "1.0.32",
25
- "@wix/portfolio_projects": "1.0.39",
23
+ "@wix/portfolio_project-in-collections": "1.0.29",
24
+ "@wix/portfolio_project-items": "1.0.34",
25
+ "@wix/portfolio_projects": "1.0.41",
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": "9f2217cb67488ec1cae6311af8e51128bf68024df90d601ebdbc768c"
51
+ "falconPackageHash": "a145c3b1dd2847bd2422200d6841c4f70c996fc229fce00fffac91c8"
52
52
  }
@@ -2461,56 +2461,55 @@ 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 */
2464
2465
  interface Project$1 extends ProjectCoverOneOf$1 {
2465
- /** Project cover image. */
2466
+ /** project's cover photo */
2466
2467
  coverImage?: Image$1;
2467
- /** Project cover video. */
2468
+ /** project's cover video */
2468
2469
  coverVideo?: Video$1;
2469
2470
  /**
2470
- * Project ID.
2471
+ * Project ID
2471
2472
  * @readonly
2472
2473
  */
2473
2474
  _id?: string | null;
2474
2475
  /**
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.
2476
+ * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision
2476
2477
  * @readonly
2477
2478
  */
2478
2479
  revision?: string | null;
2479
- /** Project title. */
2480
2480
  title?: string | null;
2481
- /** Project description. */
2482
2481
  description?: string | null;
2483
- /** Whether the project is hidden from the portfolio. */
2482
+ /** indicates if the project should be hidden from Portfolio */
2484
2483
  hidden?: boolean | null;
2485
- /** IDs of the collections that include the project. */
2484
+ /** Collections must exist to be added to a project. Can be created/updated/deleted using [Collection Service](https://dev.wix.com/docs/rest/business-solutions/portfolio/collection) */
2486
2485
  collectionIds?: string[];
2487
- /** Project details. */
2486
+ /** Custom project details */
2488
2487
  details?: ProjectDetail$1[];
2489
- /** Project slug. */
2488
+ /** Project's slug */
2490
2489
  slug?: string | null;
2491
2490
  /**
2492
- * Date and time the project was created.
2491
+ * Represents the time this Project was created
2493
2492
  * @readonly
2494
2493
  */
2495
2494
  _createdDate?: Date;
2496
2495
  /**
2497
- * Date and time the project was updated.
2496
+ * Represents the time this Project was last updated
2498
2497
  * @readonly
2499
2498
  */
2500
2499
  _updatedDate?: Date;
2501
2500
  /**
2502
- * Project's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
2501
+ * Url and relative url of Project - in order to receive this field in READ requests you will need to pass the `include_page_url` field as part of request
2503
2502
  * @readonly
2504
2503
  */
2505
2504
  url?: string;
2506
- /** Project SEO data. */
2505
+ /** SEO data for the project */
2507
2506
  seoData?: SeoSchema$1;
2508
2507
  }
2509
2508
  /** @oneof */
2510
2509
  interface ProjectCoverOneOf$1 {
2511
- /** Project cover image. */
2510
+ /** project's cover photo */
2512
2511
  coverImage?: Image$1;
2513
- /** Project cover video. */
2512
+ /** project's cover video */
2514
2513
  coverVideo?: Video$1;
2515
2514
  }
2516
2515
  interface Image$1 {
@@ -2568,30 +2567,21 @@ interface VideoResolution$1 {
2568
2567
  /** Video filename. */
2569
2568
  filename?: string | null;
2570
2569
  }
2571
- /**
2572
- * Project label.
2573
- * One of:
2574
- * + `text`
2575
- * + `link`
2576
- */
2577
2570
  interface ProjectDetail$1 extends ProjectDetailValueOneOf$1 {
2578
- /** Project label in plain text format. */
2579
2571
  text?: string;
2580
- /** Project label in link format. */
2572
+ /** Details link */
2581
2573
  link?: DetailsLink$1;
2582
2574
  label?: string;
2583
2575
  }
2584
2576
  /** @oneof */
2585
2577
  interface ProjectDetailValueOneOf$1 {
2586
- /** Project label in plain text format. */
2587
2578
  text?: string;
2588
- /** Project label in link format. */
2579
+ /** Details link */
2589
2580
  link?: DetailsLink$1;
2590
2581
  }
2591
2582
  interface DetailsLink$1 {
2592
- /** Display text of the link. */
2593
2583
  text?: string | null;
2594
- /** Target URL of the link. */
2584
+ /** link to external source */
2595
2585
  url?: string | null;
2596
2586
  /**
2597
2587
  * Whether the link opens in a new tab or window. One of:
@@ -3097,27 +3087,27 @@ interface DeletedProjectRestored {
3097
3087
  deletionTimestamp?: Date;
3098
3088
  }
3099
3089
  interface CreateProjectRequest {
3100
- /** Project to create. */
3090
+ /** Project to be created */
3101
3091
  project: Project$1;
3102
3092
  }
3103
3093
  interface CreateProjectResponse {
3104
- /** Created project. */
3094
+ /** The created Project */
3105
3095
  project?: Project$1;
3106
3096
  }
3107
3097
  interface GetProjectRequest {
3108
- /** ID of the project to retrieve. */
3098
+ /** Id of the Project to retrieve */
3109
3099
  projectId: string;
3110
3100
  /** Include page url */
3111
3101
  includePageUrl?: boolean | null;
3112
3102
  }
3113
3103
  interface GetProjectResponse {
3114
- /** The requested project. */
3104
+ /** The retrieved Project */
3115
3105
  project?: Project$1;
3116
3106
  }
3117
3107
  interface ListProjectsRequest {
3118
- /** Projects limit per response is maximum 100, In the first request the cursor is None ? */
3108
+ /** Projects limit per response is maximum 100, In the first request the cursor is None */
3119
3109
  paging?: CursorPaging$2;
3120
- /** Include page url ? */
3110
+ /** Include page url */
3121
3111
  includePageUrl?: boolean | null;
3122
3112
  }
3123
3113
  interface CursorPaging$2 {
@@ -3132,9 +3122,9 @@ interface CursorPaging$2 {
3132
3122
  cursor?: string | null;
3133
3123
  }
3134
3124
  interface ListProjectsResponse {
3135
- /** List of projects. */
3125
+ /** The retrieved Projects */
3136
3126
  projects?: Project$1[];
3137
- /** Paging metadata ? */
3127
+ /** Paging metadata */
3138
3128
  metadata?: PagingMetadataV2$2;
3139
3129
  }
3140
3130
  interface PagingMetadataV2$2 {
@@ -3156,33 +3146,33 @@ interface Cursors$2 {
3156
3146
  prev?: string | null;
3157
3147
  }
3158
3148
  interface UpdateProjectRequest {
3159
- /** Project to update. */
3149
+ /** Project to be updated, may be partial */
3160
3150
  project: Project$1;
3161
3151
  }
3162
3152
  interface UpdateProjectResponse {
3163
- /** Updated project. */
3153
+ /** The updated Project */
3164
3154
  project?: Project$1;
3165
3155
  }
3166
3156
  interface BulkUpdateProjectsRequest {
3167
- /** Projects to update. */
3157
+ /** projects to be updated. */
3168
3158
  projects?: MaskedProject[];
3169
- /** Whether to include the updated projects in the response. Set to `true`` to receive the projects in the response. */
3159
+ /** Flag to return full entity in response */
3170
3160
  returnFullEntity?: boolean | null;
3171
3161
  }
3172
3162
  interface MaskedProject {
3173
- /** Project to update. */
3163
+ /** Project to be updated */
3174
3164
  project?: Project$1;
3175
3165
  }
3176
3166
  interface BulkUpdateProjectsResponse {
3177
- /** Items created by bulk action. */
3167
+ /** Array with all updated items results. */
3178
3168
  results?: BulkUpdateProjectsResult[];
3179
- /** Bulk action metadata. */
3169
+ /** Holds metadata of the entire bulk update operation */
3180
3170
  bulkActionMetadata?: BulkActionMetadata;
3181
3171
  }
3182
3172
  interface BulkUpdateProjectsResult {
3183
- /** Item metadata. */
3173
+ /** Holds information about an item in bulk update - id, index in original request array, action successful, error (if failed). */
3184
3174
  itemMetadata?: ItemMetadata;
3185
- /** Updated project. */
3175
+ /** Updated Project */
3186
3176
  project?: Project$1;
3187
3177
  }
3188
3178
  interface ItemMetadata {
@@ -3212,17 +3202,17 @@ interface BulkActionMetadata {
3212
3202
  undetailedFailures?: number;
3213
3203
  }
3214
3204
  interface DeleteProjectRequest {
3215
- /** ID of the project to delete. */
3205
+ /** Id of the Project to delete */
3216
3206
  projectId: string;
3217
3207
  }
3218
3208
  interface DeleteProjectResponse {
3219
- /** ID of the deleted project. */
3209
+ /** Id of the deleted Project */
3220
3210
  projectId?: string;
3221
3211
  }
3222
3212
  interface QueryProjectsRequest {
3223
- /** Query options. */
3213
+ /** WQL expression */
3224
3214
  query: QueryV2$1;
3225
- /** Include page url ? */
3215
+ /** Include page url */
3226
3216
  includePageUrl?: boolean | null;
3227
3217
  }
3228
3218
  interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
@@ -3271,9 +3261,9 @@ interface Paging$1 {
3271
3261
  offset?: number | null;
3272
3262
  }
3273
3263
  interface QueryProjectsResponse {
3274
- /** List of projects. */
3264
+ /** The retrieved Projects */
3275
3265
  projects?: Project$1[];
3276
- /** Paging metadata ? */
3266
+ /** Paging metadata */
3277
3267
  metadata?: PagingMetadataV2$2;
3278
3268
  }
3279
3269
  interface UpdateProjectOrderInCollectionRequest$1 {
@@ -3564,64 +3554,62 @@ interface GetProjectOptions {
3564
3554
  includePageUrl?: boolean | null;
3565
3555
  }
3566
3556
  interface ListProjectsOptions {
3567
- /** Projects limit per response is maximum 100, In the first request the cursor is None ? */
3557
+ /** Projects limit per response is maximum 100, In the first request the cursor is None */
3568
3558
  paging?: CursorPaging$2;
3569
- /** Include page url ? */
3559
+ /** Include page url */
3570
3560
  includePageUrl?: boolean | null;
3571
3561
  }
3572
3562
  interface UpdateProject {
3573
- /** Project cover image. */
3563
+ /** project's cover photo */
3574
3564
  coverImage?: Image$1;
3575
- /** Project cover video. */
3565
+ /** project's cover video */
3576
3566
  coverVideo?: Video$1;
3577
3567
  /**
3578
- * Project ID.
3568
+ * Project ID
3579
3569
  * @readonly
3580
3570
  */
3581
3571
  _id?: string | null;
3582
3572
  /**
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.
3573
+ * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision
3584
3574
  * @readonly
3585
3575
  */
3586
3576
  revision?: string | null;
3587
- /** Project title. */
3588
3577
  title?: string | null;
3589
- /** Project description. */
3590
3578
  description?: string | null;
3591
- /** Whether the project is hidden from the portfolio. */
3579
+ /** indicates if the project should be hidden from Portfolio */
3592
3580
  hidden?: boolean | null;
3593
- /** IDs of the collections that include the project. */
3581
+ /** Collections must exist to be added to a project. Can be created/updated/deleted using [Collection Service](https://dev.wix.com/docs/rest/business-solutions/portfolio/collection) */
3594
3582
  collectionIds?: string[];
3595
- /** Project details. */
3583
+ /** Custom project details */
3596
3584
  details?: ProjectDetail$1[];
3597
- /** Project slug. */
3585
+ /** Project's slug */
3598
3586
  slug?: string | null;
3599
3587
  /**
3600
- * Date and time the project was created.
3588
+ * Represents the time this Project was created
3601
3589
  * @readonly
3602
3590
  */
3603
3591
  _createdDate?: Date;
3604
3592
  /**
3605
- * Date and time the project was updated.
3593
+ * Represents the time this Project was last updated
3606
3594
  * @readonly
3607
3595
  */
3608
3596
  _updatedDate?: Date;
3609
3597
  /**
3610
- * Project's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
3598
+ * Url and relative url of Project - in order to receive this field in READ requests you will need to pass the `include_page_url` field as part of request
3611
3599
  * @readonly
3612
3600
  */
3613
3601
  url?: string;
3614
- /** Project SEO data. */
3602
+ /** SEO data for the project */
3615
3603
  seoData?: SeoSchema$1;
3616
3604
  }
3617
3605
  interface BulkUpdateProjectsOptions {
3618
- /** Projects to update. */
3606
+ /** projects to be updated. */
3619
3607
  projects?: MaskedProject[];
3620
- /** Whether to include the updated projects in the response. Set to `true`` to receive the projects in the response. */
3608
+ /** Flag to return full entity in response */
3621
3609
  returnFullEntity?: boolean | null;
3622
3610
  }
3623
3611
  interface QueryProjectsOptions {
3624
- /** Include page url ? */
3612
+ /** Include page url */
3625
3613
  includePageUrl?: boolean | null | undefined;
3626
3614
  }
3627
3615
  interface QueryCursorResult$1 {
@@ -3727,61 +3715,57 @@ interface GetProjectPageDataSignature {
3727
3715
  declare function createProject$1(httpClient: HttpClient): CreateProjectSignature;
3728
3716
  interface CreateProjectSignature {
3729
3717
  /**
3730
- * Creates a project.
3731
- * @param - Project to create.
3732
- * @returns Created project.
3718
+ * Creates a new Project
3719
+ * @param - Project to be created
3720
+ * @returns The created Project
3733
3721
  */
3734
3722
  (project: Project$1): Promise<Project$1 & ProjectNonNullableFields$1>;
3735
3723
  }
3736
3724
  declare function getProject$1(httpClient: HttpClient): GetProjectSignature;
3737
3725
  interface GetProjectSignature {
3738
3726
  /**
3739
- * Retrieves a project.
3740
- * @param - ID of the project to retrieve.
3741
- * @returns The requested project.
3727
+ * Get a Project by id
3728
+ * @param - Id of the Project to retrieve
3729
+ * @returns The retrieved Project
3742
3730
  */
3743
3731
  (projectId: string, options?: GetProjectOptions | undefined): Promise<Project$1 & ProjectNonNullableFields$1>;
3744
3732
  }
3745
3733
  declare function listProjects$1(httpClient: HttpClient): ListProjectsSignature;
3746
3734
  interface ListProjectsSignature {
3747
3735
  /**
3748
- * Retrieves a list of all projects in a portfolio.
3736
+ * List all projects in portfolio by creation date
3749
3737
  */
3750
3738
  (options?: ListProjectsOptions | undefined): Promise<ListProjectsResponse & ListProjectsResponseNonNullableFields>;
3751
3739
  }
3752
3740
  declare function updateProject$1(httpClient: HttpClient): UpdateProjectSignature;
3753
3741
  interface UpdateProjectSignature {
3754
3742
  /**
3755
- * Updates a project.
3756
- * @param - Project ID.
3757
- * @returns Updated project.
3743
+ * Update a Project, supports partial update
3744
+ * Pass the latest `revision` for a successful update
3745
+ * @param - Project ID
3746
+ * @returns The updated Project
3758
3747
  */
3759
3748
  (_id: string | null, project: UpdateProject): Promise<Project$1 & ProjectNonNullableFields$1>;
3760
3749
  }
3761
3750
  declare function bulkUpdateProjects$1(httpClient: HttpClient): BulkUpdateProjectsSignature;
3762
3751
  interface BulkUpdateProjectsSignature {
3763
3752
  /**
3764
- * Updates multiple projects.
3753
+ * Update Projects in bulk
3765
3754
  */
3766
3755
  (options?: BulkUpdateProjectsOptions | undefined): Promise<BulkUpdateProjectsResponse & BulkUpdateProjectsResponseNonNullableFields>;
3767
3756
  }
3768
3757
  declare function deleteProject$1(httpClient: HttpClient): DeleteProjectSignature;
3769
3758
  interface DeleteProjectSignature {
3770
3759
  /**
3771
- * Deletes a project.
3772
- * @param - ID of the project to delete.
3760
+ * Delete a Project
3761
+ * @param - Id of the Project to delete
3773
3762
  */
3774
3763
  (projectId: string): Promise<DeleteProjectResponse & DeleteProjectResponseNonNullableFields>;
3775
3764
  }
3776
3765
  declare function queryProjects$1(httpClient: HttpClient): QueryProjectsSignature;
3777
3766
  interface QueryProjectsSignature {
3778
3767
  /**
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).
3768
+ * Query Projects using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
3785
3769
  */
3786
3770
  (options?: QueryProjectsOptions | undefined): ProjectsQueryBuilder;
3787
3771
  }
@@ -3841,9 +3825,7 @@ declare const updateProjectOrderInCollection$2: MaybeContext<BuildRESTFunction<t
3841
3825
  declare const queryProjectsWithCollectionInfo: MaybeContext<BuildRESTFunction<typeof queryProjectsWithCollectionInfo$1> & typeof queryProjectsWithCollectionInfo$1>;
3842
3826
 
3843
3827
  type _publicOnProjectCreatedType = typeof onProjectCreated$1;
3844
- /**
3845
- * Triggered when a project is created.
3846
- */
3828
+ /** */
3847
3829
  declare const onProjectCreated: ReturnType<typeof createEventModule$1<_publicOnProjectCreatedType>>;
3848
3830
 
3849
3831
  type _publicOnProjectUpdatedType = typeof onProjectUpdated$1;
@@ -3851,9 +3833,7 @@ type _publicOnProjectUpdatedType = typeof onProjectUpdated$1;
3851
3833
  declare const onProjectUpdated: ReturnType<typeof createEventModule$1<_publicOnProjectUpdatedType>>;
3852
3834
 
3853
3835
  type _publicOnProjectDeletedType = typeof onProjectDeleted$1;
3854
- /**
3855
- * Triggered when a project is deleted.
3856
- */
3836
+ /** */
3857
3837
  declare const onProjectDeleted: ReturnType<typeof createEventModule$1<_publicOnProjectDeletedType>>;
3858
3838
 
3859
3839
  type context$2_App = App;
@@ -3941,56 +3921,55 @@ interface ProjectInCollection {
3941
3921
  /** The sort order of the project in the given Collection */
3942
3922
  sortOrder?: number | null;
3943
3923
  }
3924
+ /** Project is the main entity of ProjectsService */
3944
3925
  interface Project extends ProjectCoverOneOf {
3945
- /** Project cover image. */
3926
+ /** project's cover photo */
3946
3927
  coverImage?: Image;
3947
- /** Project cover video. */
3928
+ /** project's cover video */
3948
3929
  coverVideo?: Video;
3949
3930
  /**
3950
- * Project ID.
3931
+ * Project ID
3951
3932
  * @readonly
3952
3933
  */
3953
3934
  _id?: string | null;
3954
3935
  /**
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.
3936
+ * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision
3956
3937
  * @readonly
3957
3938
  */
3958
3939
  revision?: string | null;
3959
- /** Project title. */
3960
3940
  title?: string | null;
3961
- /** Project description. */
3962
3941
  description?: string | null;
3963
- /** Whether the project is hidden from the portfolio. */
3942
+ /** indicates if the project should be hidden from Portfolio */
3964
3943
  hidden?: boolean | null;
3965
- /** IDs of the collections that include the project. */
3944
+ /** Collections must exist to be added to a project. Can be created/updated/deleted using [Collection Service](https://dev.wix.com/docs/rest/business-solutions/portfolio/collection) */
3966
3945
  collectionIds?: string[];
3967
- /** Project details. */
3946
+ /** Custom project details */
3968
3947
  details?: ProjectDetail[];
3969
- /** Project slug. */
3948
+ /** Project's slug */
3970
3949
  slug?: string | null;
3971
3950
  /**
3972
- * Date and time the project was created.
3951
+ * Represents the time this Project was created
3973
3952
  * @readonly
3974
3953
  */
3975
3954
  _createdDate?: Date;
3976
3955
  /**
3977
- * Date and time the project was updated.
3956
+ * Represents the time this Project was last updated
3978
3957
  * @readonly
3979
3958
  */
3980
3959
  _updatedDate?: Date;
3981
3960
  /**
3982
- * Project's page URL and relative path. To receive this field in the response, pass the `includePageUrl` query parameter in the request.
3961
+ * Url and relative url of Project - in order to receive this field in READ requests you will need to pass the `include_page_url` field as part of request
3983
3962
  * @readonly
3984
3963
  */
3985
3964
  url?: string;
3986
- /** Project SEO data. */
3965
+ /** SEO data for the project */
3987
3966
  seoData?: SeoSchema;
3988
3967
  }
3989
3968
  /** @oneof */
3990
3969
  interface ProjectCoverOneOf {
3991
- /** Project cover image. */
3970
+ /** project's cover photo */
3992
3971
  coverImage?: Image;
3993
- /** Project cover video. */
3972
+ /** project's cover video */
3994
3973
  coverVideo?: Video;
3995
3974
  }
3996
3975
  interface Image {
@@ -4048,30 +4027,21 @@ interface VideoResolution {
4048
4027
  /** Video filename. */
4049
4028
  filename?: string | null;
4050
4029
  }
4051
- /**
4052
- * Project label.
4053
- * One of:
4054
- * + `text`
4055
- * + `link`
4056
- */
4057
4030
  interface ProjectDetail extends ProjectDetailValueOneOf {
4058
- /** Project label in plain text format. */
4059
4031
  text?: string;
4060
- /** Project label in link format. */
4032
+ /** Details link */
4061
4033
  link?: DetailsLink;
4062
4034
  label?: string;
4063
4035
  }
4064
4036
  /** @oneof */
4065
4037
  interface ProjectDetailValueOneOf {
4066
- /** Project label in plain text format. */
4067
4038
  text?: string;
4068
- /** Project label in link format. */
4039
+ /** Details link */
4069
4040
  link?: DetailsLink;
4070
4041
  }
4071
4042
  interface DetailsLink {
4072
- /** Display text of the link. */
4073
4043
  text?: string | null;
4074
- /** Target URL of the link. */
4044
+ /** link to external source */
4075
4045
  url?: string | null;
4076
4046
  /**
4077
4047
  * Whether the link opens in a new tab or window. One of: