@wix/auto_sdk_portfolio_projects 1.0.40 → 1.0.41

package/build/internal/es/index.typings.d.mts

@@ -1,4 +1,4 @@
-import { NonNullablePaths } from '@wix/sdk-types';
+import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
 
 interface Project extends ProjectCoverOneOf {
     /** Project cover image. */
@@ -1727,7 +1727,80 @@ interface ProjectsQueryBuilder {
  * @fqn com.wixpress.portfolio.projects.ProjectsService.QueryProjects
  * @requiredField query
  */
-declare function typedQueryProjects(query: QueryV2, options?: QueryProjectsOptions): Promise<NonNullablePaths<QueryProjectsResponse, `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` | `projects.${number}.watermark.enabled`, 6>>;
+declare function typedQueryProjects(query: ProjectQuery, options?: QueryProjectsOptions): Promise<NonNullablePaths<QueryProjectsResponse, `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` | `projects.${number}.watermark.enabled`, 6>>;
+interface ProjectQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [
+        {
+            fields: ['_id'];
+            operators: '*';
+            sort: 'BOTH';
+        },
+        {
+            fields: ['description', 'slug', 'title'];
+            operators: '*';
+            sort: 'BOTH';
+        },
+        {
+            fields: ['collectionIds'];
+            operators: ['$hasAll', '$hasSome'];
+            sort: 'NONE';
+        },
+        {
+            fields: ['hidden'];
+            operators: '*';
+            sort: 'NONE';
+        },
+        {
+            fields: ['_createdDate', '_updatedDate'];
+            operators: '*';
+            sort: 'BOTH';
+        }
+    ];
+}
+type CommonQueryWithEntityContext = Query<Project, ProjectQuerySpec>;
+type ProjectQuery = {
+    /**
+    Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.
+    */
+    cursorPaging?: {
+        /**
+      Maximum number of items to return in the results.
+      @max: 100
+      */
+        limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | null;
+        /**
+      Pointer to the next or previous page in the list of results.
+    
+      Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+      Not relevant for the first request.
+      @maxLength: 16000
+      */
+        cursor?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object.
+  
+    Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Sort object.
+  
+    Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+    }[];
+};
 /**
  * Deprecated - please use ProjectsInCollectionsService.UpdateProjectOrderInCollection instead
  * our Client still use it
@@ -1772,4 +1845,4 @@ interface QueryProjectsWithCollectionInfoOptions {
     includePageUrl?: boolean | null;
 }
 
-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 GetAdjacentProjectInfoRequest, type GetAdjacentProjectInfoResponse, 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 ProjectInfo, 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 StudioTwoAssigned, type StudioTwoUnassigned, 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, type WixelAssigned, type WixelUnassigned, bulkUpdateProjects, createProject, deleteProject, getProject, listProjects, onProjectCreated, onProjectDeleted, onProjectUpdated, queryProjects, queryProjectsWithCollectionInfo, typedQueryProjects, updateProject, updateProjectOrderInCollection };
+export { type ActionEvent, type App, type ApplicationError, type Asset, type BaseEventMetadata, type BulkActionMetadata, type BulkUpdateProjectsOptions, type BulkUpdateProjectsRequest, type BulkUpdateProjectsResponse, type BulkUpdateProjectsResult, type CommonQueryWithEntityContext, 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 GetAdjacentProjectInfoRequest, type GetAdjacentProjectInfoResponse, 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 ProjectInfo, type ProjectQuery, type ProjectQuerySpec, 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 StudioTwoAssigned, type StudioTwoUnassigned, 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, type WixelAssigned, type WixelUnassigned, bulkUpdateProjects, createProject, deleteProject, getProject, listProjects, onProjectCreated, onProjectDeleted, onProjectUpdated, queryProjects, queryProjectsWithCollectionInfo, typedQueryProjects, updateProject, updateProjectOrderInCollection };