export interface Collection { /** * Collection ID. * @readonly */ _id?: string | null; /** * Revision number, which increments by 1 each time the collection is updated. To prevent conflicting changes, the existing revision must be passed when updating the collection object. * @readonly */ revision?: string | null; /** Collection title. */ title?: string | null; /** Collection description. */ description?: string | null; /** Collection slug. */ slug?: string | null; /** Collection cover image. */ coverImage?: Image; /** Whether the collection is hidden from the portfolio. Default: `false` */ hidden?: boolean | null; /** * Index that determines which position a collection is displayed in the portfolio.
* * Default: [Epoch](https://www.epoch101.com/) timestamp.
*/ sortOrder?: number | null; /** * Date and time the collection was created. * @readonly */ _createdDate?: Date | null; /** * Date and time the collection was updated. * @readonly */ _updatedDate?: Date | null; /** * Collection page URL and and relative path. Returned when `includePageUrl` is `true` in the request. * @readonly */ url?: string; /** Collection SEO data. */ seoData?: SeoSchema; } export interface Image { /** Information about the Wix Media image. */ imageInfo?: string; /** Focal point of the image. */ focalPoint?: Point; } export declare enum ImageType { UNDEFINED = "UNDEFINED", WIX_MEDIA = "WIX_MEDIA", EXTERNAL = "EXTERNAL" } export interface Point { /** X-coordinate of the focal point. */ x?: number; /** Y-coordinate of the focal point. */ y?: number; } export interface UnsharpMasking { /** * Unsharp masking amount. Controls the sharpening strength.
* * Min: `0`
* Max: `5` */ amount?: number | null; /** Unsharp masking radius in pixels. Controls the sharpening width. */ radius?: number | null; /** * Unsharp masking threshold. Controls how different neighboring pixels must be for shapening to apply.
* * Min: `0`
* Max: `1` */ threshold?: number | null; } /** * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines. * The search engines use this information for ranking purposes, or to display snippets in the search results. * This data will override other sources of tags (for example patterns) and will be included in the section of the HTML document, while not being displayed on the page itself. */ export interface SeoSchema { /** SEO tag information. */ tags?: Tag[]; /** SEO general settings. */ settings?: Settings; } export interface Keyword { /** Keyword value. */ term?: string; /** Whether the keyword is the main focus keyword. */ isMain?: boolean; /** The source that added the keyword terms to the SEO settings. */ origin?: string | null; } export interface Tag { /** * SEO tag type. * * * Supported values: `title`, `meta`, `script`, `link`. */ type?: string; /** * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value. * For example: `{"name": "description", "content": "the description itself"}`. */ props?: Record | null; /** SEO tag meta data. For example, `{"height": 300, "width": 240}`. */ meta?: Record | null; /** SEO tag inner content. For example, ` inner content `. */ children?: string; /** Whether the tag is a custom tag. */ custom?: boolean; /** Whether the tag is disabled. */ disabled?: boolean; } export interface Settings { /** * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled. * * * Default: `false` (Auto Redirect is enabled.) */ preventAutoRedirect?: boolean; /** User-selected keyword terms for a specific page. */ keywords?: Keyword[]; } export interface DomainEvent extends DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; /** * Unique event ID. * Allows clients to ignore duplicate webhooks. */ _id?: string; /** * Assumes actions are also always typed to an entity_type * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction */ entityFqdn?: string; /** * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug) * This is although the created/updated/deleted notion is duplication of the oneof types * Example: created/updated/deleted/started/completed/email_opened */ slug?: string; /** ID of the entity associated with the event. */ entityId?: string; /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */ eventTime?: Date | null; /** * Whether the event was triggered as a result of a privacy regulation application * (for example, GDPR). */ triggeredByAnonymizeRequest?: boolean | null; /** If present, indicates the action that triggered the event. */ originatedFrom?: string | null; /** * A sequence number defining the order of updates to the underlying entity. * For example, given that some entity was updated at 16:00 and than again at 16:01, * it is guaranteed that the sequence number of the second update is strictly higher than the first. * As the consumer, you can use this value to ensure that you handle messages in the correct order. * To do so, you will need to persist this number on your end, and compare the sequence number from the * message against the one you have stored. Given that the stored number is higher, you should ignore the message. */ entityEventSequence?: string | null; } /** @oneof */ export interface DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; } export interface EntityCreatedEvent { entity?: string; } export interface RestoreInfo { deletedDate?: Date | null; } export interface EntityUpdatedEvent { /** * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff. * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects. * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it. */ currentEntity?: string; } export interface EntityDeletedEvent { /** Entity that was deleted */ deletedEntity?: string | null; } export interface ActionEvent { body?: string; } export interface Empty { } export interface AdminRemoveMenuItemsResponse { /** number of items queried for deletion */ numItems?: number; /** number of items sucessfully deleted */ numItemsSuccessfullyDeleted?: number; } export interface MessageEnvelope { /** App instance ID. */ instanceId?: string | null; /** Event type. */ eventType?: string; /** The identification type and identity data. */ identity?: IdentificationData; /** Stringify payload. */ data?: string; } export interface IdentificationData extends IdentificationDataIdOneOf { /** ID of a site visitor that has not logged in to the site. */ anonymousVisitorId?: string; /** ID of a site visitor that has logged in to the site. */ memberId?: string; /** ID of a Wix user (site owner, contributor, etc.). */ wixUserId?: string; /** ID of an app. */ appId?: string; /** @readonly */ identityType?: WebhookIdentityType; } /** @oneof */ export interface IdentificationDataIdOneOf { /** ID of a site visitor that has not logged in to the site. */ anonymousVisitorId?: string; /** ID of a site visitor that has logged in to the site. */ memberId?: string; /** ID of a Wix user (site owner, contributor, etc.). */ wixUserId?: string; /** ID of an app. */ appId?: string; } export declare enum WebhookIdentityType { UNKNOWN = "UNKNOWN", ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR", MEMBER = "MEMBER", WIX_USER = "WIX_USER", APP = "APP" } export interface InvalidateCache extends InvalidateCacheGetByOneOf { /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */ metaSiteId?: string; /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */ siteId?: string; /** Invalidate by App */ app?: App; /** Invalidate by page id */ page?: Page; /** Invalidate by URI path */ uri?: URI; /** Invalidate by file (for media files such as PDFs) */ file?: File; /** tell us why you're invalidating the cache. You don't need to add your app name */ reason?: string | null; /** Is local DS */ localDc?: boolean; hardPurge?: boolean; } /** @oneof */ export interface InvalidateCacheGetByOneOf { /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */ metaSiteId?: string; /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */ siteId?: string; /** Invalidate by App */ app?: App; /** Invalidate by page id */ page?: Page; /** Invalidate by URI path */ uri?: URI; /** Invalidate by file (for media files such as PDFs) */ file?: File; } export interface App { /** The AppDefId */ appDefId?: string; /** The instance Id */ instanceId?: string; } export interface Page { /** the msid the page is on */ metaSiteId?: string; /** Invalidate by Page ID */ pageId?: string; } export interface URI { /** the msid the URI is on */ metaSiteId?: string; /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */ uriPath?: string; } export interface File { /** the msid the file is related to */ metaSiteId?: string; /** Invalidate by filename (for media files such as PDFs) */ fileName?: string; } export interface CreateCollectionRequest { /** Collection to create. */ collection: Collection; } export interface CreateCollectionResponse { /** Created collection. */ collection?: Collection; } export interface GetCollectionRequest { /** ID of the collection to retrieve. */ collectionId: string; /** Whether to include the collection's page URL and relative path in the response. Default: `false` */ includePageUrl?: boolean | null; } export interface GetCollectionResponse { /** The requested collection. */ collection?: Collection; } export interface ListCollectionsRequest { paging?: CursorPaging; /** Whether to include the collection's page URL and relative path in the response. Default: `false` */ includePageUrl?: boolean | null; } export interface CursorPaging { /** Maximum number of items to return in the results. */ limit?: number | 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. */ cursor?: string | null; } export interface ListCollectionsResponse { /** List of collections. */ collections?: Collection[]; /** Paging metadata. */ metadata?: PagingMetadataV2; } export interface PagingMetadataV2 { /** Number of items returned in the response. */ count?: number | null; /** Offset that was requested. */ offset?: number | null; /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */ total?: number | null; /** Flag that indicates the server failed to calculate the `total` field. */ tooManyToCount?: boolean | null; /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */ cursors?: Cursors; } export interface Cursors { /** Cursor string pointing to the next page in the list of results. */ next?: string | null; /** Cursor pointing to the previous page in the list of results. */ prev?: string | null; } export interface UpdateCollectionRequest { /** Collection to update. */ collection: Collection; } export interface UpdateCollectionResponse { /** Updated collection. */ collection?: Collection; } export interface DeleteCollectionRequest { /** ID of the collection to delete. */ collectionId: string; } export interface DeleteCollectionResponse { /** ID of the deleted collection. */ collectionId?: string; } export interface QueryCollectionsRequest { /** Query options. */ query: QueryV2; /** Whether to include the collection's page URL and relative path in the response. Default: `false` */ includePageUrl?: boolean | null; } export interface QueryV2 extends QueryV2PagingMethodOneOf { /** Paging options to limit and skip the number of items. */ paging?: Paging; /** 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?: CursorPaging; /** * Filter object. * * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section). */ filter?: Record | null; /** * Sort object. * * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section). */ sort?: Sorting[]; /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */ fields?: string[]; /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */ fieldsets?: string[]; } /** @oneof */ export interface QueryV2PagingMethodOneOf { /** Paging options to limit and skip the number of items. */ paging?: Paging; /** 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?: CursorPaging; } export interface Sorting { /** Name of the field to sort by. */ fieldName?: string; /** Sort order. */ order?: SortOrder; } export declare enum SortOrder { ASC = "ASC", DESC = "DESC" } export interface Paging { /** Number of items to load. */ limit?: number | null; /** Number of items to skip in the current sort order. */ offset?: number | null; } export interface QueryCollectionsResponse { /** List of collections. */ collections?: Collection[]; /** Paging metadata. */ metadata?: PagingMetadataV2; } interface PointNonNullableFields { x: number; y: number; } interface ImageNonNullableFields { type: ImageType; imageInfo: string; focalPoint?: PointNonNullableFields; } interface TagNonNullableFields { type: string; children: string; custom: boolean; disabled: boolean; } interface KeywordNonNullableFields { term: string; isMain: boolean; } interface SettingsNonNullableFields { preventAutoRedirect: boolean; keywords: KeywordNonNullableFields[]; } interface SeoSchemaNonNullableFields { tags: TagNonNullableFields[]; settings?: SettingsNonNullableFields; } export interface CollectionNonNullableFields { coverImage?: ImageNonNullableFields; url: string; seoData?: SeoSchemaNonNullableFields; } export interface CreateCollectionResponseNonNullableFields { collection?: CollectionNonNullableFields; } export interface GetCollectionResponseNonNullableFields { collection?: CollectionNonNullableFields; } export interface ListCollectionsResponseNonNullableFields { collections: CollectionNonNullableFields[]; } export interface UpdateCollectionResponseNonNullableFields { collection?: CollectionNonNullableFields; } export interface DeleteCollectionResponseNonNullableFields { collectionId: string; } export interface QueryCollectionsResponseNonNullableFields { collections: CollectionNonNullableFields[]; } export interface BaseEventMetadata { /** App instance ID. */ instanceId?: string | null; /** Event type. */ eventType?: string; /** The identification type and identity data. */ identity?: IdentificationData; } export interface EventMetadata extends BaseEventMetadata { /** * Unique event ID. * Allows clients to ignore duplicate webhooks. */ _id?: string; /** * Assumes actions are also always typed to an entity_type * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction */ entityFqdn?: string; /** * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug) * This is although the created/updated/deleted notion is duplication of the oneof types * Example: created/updated/deleted/started/completed/email_opened */ slug?: string; /** ID of the entity associated with the event. */ entityId?: string; /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */ eventTime?: Date | null; /** * Whether the event was triggered as a result of a privacy regulation application * (for example, GDPR). */ triggeredByAnonymizeRequest?: boolean | null; /** If present, indicates the action that triggered the event. */ originatedFrom?: string | null; /** * A sequence number defining the order of updates to the underlying entity. * For example, given that some entity was updated at 16:00 and than again at 16:01, * it is guaranteed that the sequence number of the second update is strictly higher than the first. * As the consumer, you can use this value to ensure that you handle messages in the correct order. * To do so, you will need to persist this number on your end, and compare the sequence number from the * message against the one you have stored. Given that the stored number is higher, you should ignore the message. */ entityEventSequence?: string | null; } export interface CollectionCreatedEnvelope { entity: Collection; metadata: EventMetadata; } /** * Triggered when a collection is created. * @permissionScope Manage Portfolio * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO * @permissionId PORTFOLIO.COLLECTION_READ * @webhook * @eventType wix.portfolio.collections.v1.collection_created * @documentationMaturity preview */ export declare function onCollectionCreated(handler: (event: CollectionCreatedEnvelope) => void | Promise): void; export interface CollectionDeletedEnvelope { metadata: EventMetadata; } /** * Triggered when a collection is deleted. * @permissionScope Manage Portfolio * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO * @permissionId PORTFOLIO.COLLECTION_READ * @webhook * @eventType wix.portfolio.collections.v1.collection_deleted * @documentationMaturity preview */ export declare function onCollectionDeleted(handler: (event: CollectionDeletedEnvelope) => void | Promise): void; export interface CollectionUpdatedEnvelope { entity: Collection; metadata: EventMetadata; } /** * Triggered when a collection is updated. * @permissionScope Manage Portfolio * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO * @permissionId PORTFOLIO.COLLECTION_READ * @webhook * @eventType wix.portfolio.collections.v1.collection_updated * @documentationMaturity preview */ export declare function onCollectionUpdated(handler: (event: CollectionUpdatedEnvelope) => void | Promise): void; /** * Creates a collection. * @param collection - Collection to create. * @public * @documentationMaturity preview * @requiredField collection * @permissionId PORTFOLIO.COLLECTION_CREATE * @permissionScope Manage Portfolio * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO * @applicableIdentity APP * @returns Created collection. * @fqn com.wixpress.portfolio.collections.CollectionsService.CreateCollection */ export declare function createCollection(collection: Collection): Promise; /** * Retrieves a collection. * @param collectionId - ID of the collection to retrieve. * @public * @documentationMaturity preview * @requiredField collectionId * @permissionId PORTFOLIO.COLLECTION_READ * @permissionScope Manage Portfolio * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO * @applicableIdentity APP * @applicableIdentity VISITOR * @returns The requested collection. * @fqn com.wixpress.portfolio.collections.CollectionsService.GetCollection */ export declare function getCollection(collectionId: string, options?: GetCollectionOptions): Promise; export interface GetCollectionOptions { /** Whether to include the collection's page URL and relative path in the response. Default: `false` */ includePageUrl?: boolean | null; } /** * Retrieves a list all collections in a portfolio. * @public * @documentationMaturity preview * @permissionId PORTFOLIO.COLLECTION_READ * @permissionScope Manage Portfolio * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO * @applicableIdentity APP * @applicableIdentity VISITOR * @fqn com.wixpress.portfolio.collections.CollectionsService.ListCollections */ export declare function listCollections(options?: ListCollectionsOptions): Promise; export interface ListCollectionsOptions { paging?: CursorPaging; /** Whether to include the collection's page URL and relative path in the response. Default: `false` */ includePageUrl?: boolean | null; } /** * Updates a collection. * @param _id - Collection ID. * @public * @documentationMaturity preview * @requiredField _id * @requiredField collection * @requiredField collection.revision * @permissionId PORTFOLIO.COLLECTION_UPDATE * @permissionScope Manage Portfolio * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO * @applicableIdentity APP * @returns Updated collection. * @fqn com.wixpress.portfolio.collections.CollectionsService.UpdateCollection */ export declare function updateCollection(_id: string | null, collection: UpdateCollection): Promise; export interface UpdateCollection { /** * Collection ID. * @readonly */ _id?: string | null; /** * Revision number, which increments by 1 each time the collection is updated. To prevent conflicting changes, the existing revision must be passed when updating the collection object. * @readonly */ revision?: string | null; /** Collection title. */ title?: string | null; /** Collection description. */ description?: string | null; /** Collection slug. */ slug?: string | null; /** Collection cover image. */ coverImage?: Image; /** Whether the collection is hidden from the portfolio. Default: `false` */ hidden?: boolean | null; /** * Index that determines which position a collection is displayed in the portfolio.
* * Default: [Epoch](https://www.epoch101.com/) timestamp.
*/ sortOrder?: number | null; /** * Date and time the collection was created. * @readonly */ _createdDate?: Date | null; /** * Date and time the collection was updated. * @readonly */ _updatedDate?: Date | null; /** * Collection page URL and and relative path. Returned when `includePageUrl` is `true` in the request. * @readonly */ url?: string; /** Collection SEO data. */ seoData?: SeoSchema; } /** * Deletes a collection. * @param collectionId - ID of the collection to delete. * @public * @documentationMaturity preview * @requiredField collectionId * @permissionId PORTFOLIO.COLLECTION_DELETE * @permissionScope Manage Portfolio * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO * @applicableIdentity APP * @fqn com.wixpress.portfolio.collections.CollectionsService.DeleteCollection */ export declare function deleteCollection(collectionId: string): Promise; /** * Creates a query to retrieve a list of collections. * * The `queryCollections()` method builds a query to retrieve a list of collections and returns a `CollectionsQueryBuilder` object. * * 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/collections/collections-query-builder/find) method. * * You can refine the query by chaining `CollectionsQueryBuilder` methods onto the query. `CollectionsQueryBuilder` methods enable you to filter, sort, and control the results that `queryCollections()` returns. * * `queryCollections()` runs with the following `CollectionsQueryBuilder` defaults which you can override: * * + [`limit(100)`](https://dev.wix.com/docs/sdk/backend-modules/portfolio/collections/collections-query-builder/limit) * + [`ascending('_id')`](https://dev.wix.com/docs/sdk/backend-modules/portfolio/collections/collections-query-builder/ascending) * * The following `CollectionsQueryBuilder` methods are supported for `queryCollections()`. For a full description of the operations object, see the object returned for the [`items`](https://dev.wix.com/docs/sdk/backend-modules/portfolio/collections/collections-query-result/items) property in `CollectionsQueryResult`. * @public * @documentationMaturity preview * @permissionScope Manage Portfolio * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO * @permissionId PORTFOLIO.COLLECTION_READ * @applicableIdentity APP * @applicableIdentity VISITOR * @fqn com.wixpress.portfolio.collections.CollectionsService.QueryCollections */ export declare function queryCollections(options?: QueryCollectionsOptions): CollectionsQueryBuilder; export interface QueryCollectionsOptions { /** Whether to include the collection's page URL and relative path in the response. Default: `false` */ includePageUrl?: boolean | null | undefined; } interface QueryCursorResult { cursors: Cursors; hasNext: () => boolean; hasPrev: () => boolean; length: number; pageSize: number; } export interface CollectionsQueryResult extends QueryCursorResult { items: Collection[]; query: CollectionsQueryBuilder; next: () => Promise; prev: () => Promise; } export interface CollectionsQueryBuilder { /** @param propertyName - Property whose value is compared with `value`. * @param value - Value to compare against. * @documentationMaturity preview */ eq: (propertyName: '_id' | 'title' | 'description' | 'slug' | 'hidden' | 'sortOrder' | '_createdDate' | '_updatedDate', value: any) => CollectionsQueryBuilder; /** @param propertyName - Property whose value is compared with `value`. * @param value - Value to compare against. * @documentationMaturity preview */ ne: (propertyName: '_id' | 'title' | 'description' | 'slug' | 'hidden' | 'sortOrder' | '_createdDate' | '_updatedDate', value: any) => CollectionsQueryBuilder; /** @param propertyName - Property whose value is compared with `value`. * @param value - Value to compare against. * @documentationMaturity preview */ ge: (propertyName: 'sortOrder' | '_createdDate' | '_updatedDate', value: any) => CollectionsQueryBuilder; /** @param propertyName - Property whose value is compared with `value`. * @param value - Value to compare against. * @documentationMaturity preview */ gt: (propertyName: 'sortOrder' | '_createdDate' | '_updatedDate', value: any) => CollectionsQueryBuilder; /** @param propertyName - Property whose value is compared with `value`. * @param value - Value to compare against. * @documentationMaturity preview */ le: (propertyName: 'sortOrder' | '_createdDate' | '_updatedDate', value: any) => CollectionsQueryBuilder; /** @param propertyName - Property whose value is compared with `value`. * @param value - Value to compare against. * @documentationMaturity preview */ lt: (propertyName: 'sortOrder' | '_createdDate' | '_updatedDate', value: any) => CollectionsQueryBuilder; /** @param propertyName - Property whose value is compared with `string`. * @param string - String to compare against. Case-insensitive. * @documentationMaturity preview */ startsWith: (propertyName: '_id' | 'title' | 'description' | 'slug', value: string) => CollectionsQueryBuilder; /** @param propertyName - Property whose value is compared with `values`. * @param values - List of values to compare against. * @documentationMaturity preview */ hasSome: (propertyName: '_id' | 'title' | 'description' | 'slug' | 'hidden' | 'sortOrder' | '_createdDate' | '_updatedDate', value: any[]) => CollectionsQueryBuilder; /** @documentationMaturity preview */ in: (propertyName: '_id' | 'title' | 'description' | 'slug' | 'hidden' | 'sortOrder' | '_createdDate' | '_updatedDate', value: any) => CollectionsQueryBuilder; /** @documentationMaturity preview */ exists: (propertyName: '_id' | 'title' | 'description' | 'slug' | 'hidden' | 'sortOrder' | '_createdDate' | '_updatedDate', value: boolean) => CollectionsQueryBuilder; /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. * @documentationMaturity preview */ ascending: (...propertyNames: Array<'_id' | 'title' | 'description' | 'slug' | 'sortOrder' | '_createdDate' | '_updatedDate'>) => CollectionsQueryBuilder; /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. * @documentationMaturity preview */ descending: (...propertyNames: Array<'_id' | 'title' | 'description' | 'slug' | 'sortOrder' | '_createdDate' | '_updatedDate'>) => CollectionsQueryBuilder; /** @param limit - Number of items to return, which is also the `pageSize` of the results object. * @documentationMaturity preview */ limit: (limit: number) => CollectionsQueryBuilder; /** @param cursor - A pointer to specific record * @documentationMaturity preview */ skipTo: (cursor: string) => CollectionsQueryBuilder; /** @documentationMaturity preview */ find: () => Promise; } export {};