@wix/auto_sdk_portfolio_projects 1.0.24 → 1.0.26

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.
@@ -1,8 +1,7 @@
1
1
  import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
2
2
  import { Project, GetProjectOptions, ListProjectsOptions, ListProjectsResponse, UpdateProject, BulkUpdateProjectsOptions, BulkUpdateProjectsResponse, DeleteProjectResponse, QueryProjectsOptions, ProjectsQueryBuilder, UpdateProjectOrderInCollectionIdentifiers, UpdateProjectOrderInCollectionResponse, QueryV2, QueryProjectsWithCollectionInfoOptions, QueryProjectWithCollectionInfoResponse, ProjectCreatedEnvelope, ProjectDeletedEnvelope, ProjectUpdatedEnvelope } from './index.typings.js';
3
- export { ActionEvent, App, ApplicationError, Asset, BaseEventMetadata, BulkActionMetadata, BulkUpdateProjectsRequest, BulkUpdateProjectsResult, CreateNewPortfolioAppRequest, CreateNewPortfolioAppResponse, CreateProjectRequest, CreateProjectResponse, CursorPaging, Cursors, CustomTag, DeleteContext, DeleteProjectRequest, DeleteStatus, DeletedProjectRestored, DetailsLink, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, File, GetProjectPageDataRequest, GetProjectPageDataResponse, GetProjectRequest, GetProjectResponse, IdentificationData, IdentificationDataIdOneOf, Image, ImageType, InvalidateCache, InvalidateCacheGetByOneOf, ItemMetadata, Keyword, ListProjectsRequest, MaskedProject, MenuSettingUpdatedEvent, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, Namespace, NamespaceChanged, OdeditorAssigned, OdeditorUnassigned, Page, Paging, PagingMetadataV2, PicassoAssigned, PicassoUnassigned, Point, Position, ProjectCoverOneOf, ProjectDetail, ProjectDetailValueOneOf, ProjectSlug, ProjectSource, ProjectsInCollections, ProjectsQueryResult, QueryProjectWithCollectionInfoRequest, QueryProjectsRequest, QueryProjectsResponse, QueryV2PagingMethodOneOf, RestoreInfo, RestoreProjectFromTrashBinRequest, RestoreProjectFromTrashBinResponse, SeoSchema, ServiceProvisioned, ServiceRemoved, Settings, SiteCreated, SiteCreatedContext, SiteDeleted, SiteHardDeleted, SiteMarkedAsTemplate, SiteMarkedAsWixSite, SitePublished, SitePurgedExternally, SiteRenamed, SiteTransferred, SiteUndeleted, SiteUnpublished, SiteUrlChanged, SortOrder, Sorting, State, StudioAssigned, StudioUnassigned, SyncProjectWithCollectionMappings, SyncStatus, Tag, URI, UnsharpMasking, UpdateProjectOrderInCollectionRequest, UpdateProjectRequest, UpdateProjectResponse, Video, VideoResolution, Watermark, WebhookIdentityType } from './index.typings.js';
3
+ export { ActionEvent, App, ApplicationError, Asset, BaseEventMetadata, BulkActionMetadata, BulkUpdateProjectsRequest, BulkUpdateProjectsResult, CreateNewPortfolioAppRequest, CreateNewPortfolioAppResponse, CreateProjectRequest, CreateProjectResponse, CursorPaging, Cursors, CustomTag, DeleteContext, DeleteProjectRequest, DeleteStatus, DeleteStatusWithLiterals, DeletedProjectRestored, DetailsLink, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, File, GetProjectPageDataRequest, GetProjectPageDataResponse, GetProjectRequest, GetProjectResponse, IdentificationData, IdentificationDataIdOneOf, Image, ImageType, ImageTypeWithLiterals, InvalidateCache, InvalidateCacheGetByOneOf, ItemMetadata, Keyword, ListProjectsRequest, MaskedProject, MenuSettingUpdatedEvent, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, Namespace, NamespaceChanged, NamespaceWithLiterals, OdeditorAssigned, OdeditorUnassigned, Page, Paging, PagingMetadataV2, PicassoAssigned, PicassoUnassigned, Point, Position, PositionWithLiterals, ProjectCoverOneOf, ProjectDetail, ProjectDetailValueOneOf, ProjectSlug, ProjectSource, ProjectsInCollections, ProjectsQueryResult, QueryProjectWithCollectionInfoRequest, QueryProjectsRequest, QueryProjectsResponse, QueryV2PagingMethodOneOf, RestoreInfo, RestoreProjectFromTrashBinRequest, RestoreProjectFromTrashBinResponse, SeoSchema, ServiceProvisioned, ServiceRemoved, Settings, SiteCreated, SiteCreatedContext, SiteCreatedContextWithLiterals, SiteDeleted, SiteHardDeleted, SiteMarkedAsTemplate, SiteMarkedAsWixSite, SitePublished, SitePurgedExternally, SiteRenamed, SiteTransferred, SiteUndeleted, SiteUnpublished, SiteUrlChanged, SortOrder, SortOrderWithLiterals, Sorting, State, StateWithLiterals, StudioAssigned, StudioUnassigned, SyncProjectWithCollectionMappings, SyncStatus, SyncStatusWithLiterals, Tag, URI, UnsharpMasking, UpdateProjectOrderInCollectionRequest, UpdateProjectRequest, UpdateProjectResponse, Video, VideoResolution, Watermark, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
4
4
 
5
- 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`;
6
5
  declare function createProject$1(httpClient: HttpClient): CreateProjectSignature;
7
6
  interface CreateProjectSignature {
8
7
  /**
@@ -10,7 +9,7 @@ interface CreateProjectSignature {
10
9
  * @param - Project to create.
11
10
  * @returns Created project.
12
11
  */
13
- (project: Project): Promise<NonNullablePaths<Project, ProjectNonNullablePaths>>;
12
+ (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>>;
14
13
  }
15
14
  declare function getProject$1(httpClient: HttpClient): GetProjectSignature;
16
15
  interface GetProjectSignature {
@@ -19,16 +18,14 @@ interface GetProjectSignature {
19
18
  * @param - ID of the project to retrieve.
20
19
  * @returns The requested project.
21
20
  */
22
- (projectId: string, options?: GetProjectOptions): Promise<NonNullablePaths<Project, ProjectNonNullablePaths>>;
21
+ (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>>;
23
22
  }
24
23
  declare function listProjects$1(httpClient: HttpClient): ListProjectsSignature;
25
24
  interface ListProjectsSignature {
26
25
  /**
27
26
  * Retrieves a list of all projects in a portfolio.
28
27
  */
29
- (options?: ListProjectsOptions): Promise<NonNullablePaths<ListProjectsResponse, {
30
- [P in ProjectNonNullablePaths]: `projects.${number}.${P}`;
31
- }[ProjectNonNullablePaths]>>;
28
+ (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>>;
32
29
  }
33
30
  declare function updateProject$1(httpClient: HttpClient): UpdateProjectSignature;
34
31
  interface UpdateProjectSignature {
@@ -37,16 +34,14 @@ interface UpdateProjectSignature {
37
34
  * @param - Project ID.
38
35
  * @returns Updated project.
39
36
  */
40
- (_id: string, project: NonNullablePaths<UpdateProject, `revision`>): Promise<NonNullablePaths<Project, ProjectNonNullablePaths>>;
37
+ (_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>>;
41
38
  }
42
39
  declare function bulkUpdateProjects$1(httpClient: HttpClient): BulkUpdateProjectsSignature;
43
40
  interface BulkUpdateProjectsSignature {
44
41
  /**
45
42
  * Updates multiple projects.
46
43
  */
47
- (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` | {
48
- [P in ProjectNonNullablePaths]: `results.${number}.project.${P}`;
49
- }[ProjectNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
44
+ (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>>;
50
45
  }
51
46
  declare function deleteProject$1(httpClient: HttpClient): DeleteProjectSignature;
52
47
  interface DeleteProjectSignature {
@@ -54,7 +49,7 @@ interface DeleteProjectSignature {
54
49
  * Deletes a project.
55
50
  * @param - ID of the project to delete.
56
51
  */
57
- (projectId: string): Promise<NonNullablePaths<DeleteProjectResponse, `projectId`>>;
52
+ (projectId: string): Promise<NonNullablePaths<DeleteProjectResponse, `projectId`, 2>>;
58
53
  }
59
54
  declare function queryProjects$1(httpClient: HttpClient): QueryProjectsSignature;
60
55
  interface QueryProjectsSignature {
@@ -84,9 +79,7 @@ interface UpdateProjectOrderInCollectionSignature {
84
79
  * @param - Index that determines the placement of a project within the collection.
85
80
  * @deprecated
86
81
  */
87
- (identifiers: NonNullablePaths<UpdateProjectOrderInCollectionIdentifiers, `collectionId` | `projectId`>, sortOrder: number): Promise<NonNullablePaths<UpdateProjectOrderInCollectionResponse, `projectInCollection.collectionId` | {
88
- [P in ProjectNonNullablePaths]: `projectInCollection.project.${P}`;
89
- }[ProjectNonNullablePaths]>>;
82
+ (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>>;
90
83
  }
91
84
  declare function queryProjectsWithCollectionInfo$1(httpClient: HttpClient): QueryProjectsWithCollectionInfoSignature;
92
85
  interface QueryProjectsWithCollectionInfoSignature {
@@ -96,9 +89,7 @@ interface QueryProjectsWithCollectionInfoSignature {
96
89
  * @param - WQL expression
97
90
  * @deprecated
98
91
  */
99
- (query: QueryV2, options?: QueryProjectsWithCollectionInfoOptions): Promise<NonNullablePaths<QueryProjectWithCollectionInfoResponse, `projects` | `projects.${number}.collectionId` | {
100
- [P in ProjectNonNullablePaths]: `projects.${number}.project.${P}`;
101
- }[ProjectNonNullablePaths]>>;
92
+ (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>>;
102
93
  }
103
94
  declare const onProjectCreated$1: EventDefinition<ProjectCreatedEnvelope, "wix.portfolio.projects.v1.project_created">;
104
95
  declare const onProjectDeleted$1: EventDefinition<ProjectDeletedEnvelope, "wix.portfolio.projects.v1.project_deleted">;