@wix/auto_sdk_benefit-programs_pool-items 1.0.0

package/build/cjs/index.typings.d.ts

@@ -0,0 +1,733 @@
+import * as _wix_sdk_types from '@wix/sdk-types';
+import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
+
+interface PoolItem {
+    /**
+     * Benefit item ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Revision number, which increments by 1 each time the benefit item is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the item.
+     *
+     * Ignored when creating an item.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the item was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the item was updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * External item ID assigned by the provider of the items.
+     *
+     * For example, if the benefit items are products, this ID corresponds to the specific product ID in the supplier's system.
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    externalId?: string;
+    /**
+     * Item category. Groups benefit items together for organization and management purposes. For example, classes, posts, groups.
+     * @maxLength 20
+     * @immutable
+     * @readonly
+     */
+    category?: string;
+    /**
+     * ID of the application providing the benefit item.
+     *
+     * ID of the external application supplying the items. Each item's external ID is unique to its respective provider's application.
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    providerAppId?: string;
+    /**
+     * Module name of the item provider's application that originated the items.
+     *
+     * For example, `store-inventory` or `fitness-resources`.
+     * @minLength 1
+     * @maxLength 20
+     * @immutable
+     * @readonly
+     */
+    namespace?: string;
+    /**
+     * Pool id
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    poolId?: string;
+    /**
+     * Program id
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    programId?: string | null;
+    /**
+     * Program external id
+     * @format GUID
+     * @readonly
+     */
+    externalProgramId?: string | null;
+    /**
+     * Program definition id
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    programDefinitionId?: string | null;
+    /**
+     * Program definition external id
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    externalProgramDefinitionId?: string | null;
+    /**
+     * Pool definition id
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    poolDefinitionId?: string | null;
+    /**
+     * Item set ID.
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    itemSetId?: string;
+    /**
+     * Who is getting the benefit
+     * @readonly
+     * @immutable
+     */
+    beneficiary?: CommonIdentificationData;
+    /**
+     * Item set ID.
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    itemId?: string;
+    /**
+     * Unique identifier for the benefit associated with this item.
+     * @maxLength 64
+     * @immutable
+     * @readonly
+     */
+    benefitKey?: string;
+    /**
+     * Search key for the item reference, which is a unique identifier for searching and referencing the item within the provider's system.
+     * It's build by concatenating the following fields in this order, separated by a separator (e.g., "/"):
+     * - providerAppId
+     * - category
+     * - externalId
+     * @maxLength 94
+     * @immutable
+     * @readonly
+     */
+    itemReferenceSearchKey?: string;
+}
+interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that hasn't logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site member.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user.
+     * @format GUID
+     */
+    wixUserId?: string;
+}
+/** @oneof */
+interface CommonIdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that hasn't logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site member.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user.
+     * @format GUID
+     */
+    wixUserId?: string;
+}
+declare enum IdentityType {
+    /** Unknown type. This value is not used. */
+    UNKNOWN = "UNKNOWN",
+    /** A site visitor who has not logged in. */
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    /** A logged-in site member. */
+    MEMBER = "MEMBER",
+    /** A Wix account holder, such as a site owner or contributor. */
+    WIX_USER = "WIX_USER"
+}
+/** @enumType */
+type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER';
+interface PoolInfo {
+    /**
+     * Pool name.
+     *
+     * You may want to use the same name that's used in the associated pool definition.
+     * @maxLength 64
+     */
+    displayName?: string;
+    /**
+     * Pool description.
+     * @maxLength 450
+     */
+    description?: string | null;
+}
+interface ProgramInfo {
+    /**
+     * Program id
+     * @format GUID
+     */
+    _id?: string;
+    /**
+     * Program external id
+     * @format GUID
+     */
+    externalId?: string | null;
+    /**
+     * Program name.
+     * @maxLength 64
+     */
+    displayName?: string | null;
+}
+interface ProgramDefinitionInfo {
+    /**
+     * Program definition id
+     * @format GUID
+     */
+    _id?: string;
+    /**
+     * Program definition external id
+     * @format GUID
+     */
+    externalId?: string | null;
+    /**
+     * Program definition name
+     * @maxLength 64
+     */
+    displayName?: string | null;
+    /**
+     * Program definition description.
+     * @maxLength 450
+     */
+    description?: string | null;
+}
+interface ItemInfo {
+    /**
+     * Item display name.
+     * @maxLength 64
+     */
+    displayName?: string | null;
+}
+interface BenefitInfo {
+    /**
+     * Price of the benefit in credits. The price is the same for all of this benefit's items.
+     * @decimalValue options { gte:0, maxScale:4 }
+     */
+    price?: string | null;
+    /**
+     * Unique identifier for this benefit.
+     * @maxLength 64
+     */
+    benefitKey?: string;
+    /**
+     * Benefit name.
+     * @maxLength 40
+     */
+    displayName?: string | null;
+    /**
+     * Benefit description.
+     * @maxLength 255
+     */
+    description?: string | null;
+}
+interface PoolItemDeactivated {
+    /** The pool item that was deactivated. */
+    poolItem?: PoolItem;
+}
+interface QueryPoolItemsRequest {
+    /** Query to select benefit items. */
+    query?: CursorQuery;
+    /**
+     * Fields to be included in the response.
+     * @maxSize 5
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** 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 in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /** 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;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 1000
+     */
+    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.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+declare enum RequestedFields {
+    POOL = "POOL",
+    PROGRAM = "PROGRAM",
+    PROGRAM_DEFINITION = "PROGRAM_DEFINITION",
+    ITEM = "ITEM",
+    BENEFIT = "BENEFIT"
+}
+/** @enumType */
+type RequestedFieldsWithLiterals = RequestedFields | 'POOL' | 'PROGRAM' | 'PROGRAM_DEFINITION' | 'ITEM' | 'BENEFIT';
+interface QueryPoolItemsResponse {
+    /** List of items. */
+    poolItems?: PoolItem[];
+    /** Metadata for paginated results. */
+    metadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface InvalidatePoolItemsRequest {
+    /**
+     * The pool ID whose items are to be invalidated
+     * @format GUID
+     */
+    poolId?: string;
+    /**
+     * List of item set ids whose items are to be invalidated
+     * @maxSize 10
+     * @format GUID
+     */
+    itemSetIds?: string[];
+}
+interface InvalidatePoolItemsResponse {
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For 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 that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+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;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountInfo {
+    /**
+     * ID of the Wix account associated with the event.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
+/**
+ * Retrieves a list of benefit items, given the provided paging, filtering, and sorting. Returns up to 1000 item per request.
+ *
+ * For a detailed list of supported operations, see [Items: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/item-v1/filtering-and-sorting).
+ *
+ * To learn how to query program definitions, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+ * @public
+ * @documentationMaturity preview
+ * @permissionId benefit_programs:v1:pool_item:query_pool_items
+ * @permissionId BENEFIT_PROGRAMS.POOL_READ
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.pool_item.PoolItemService.QueryPoolItems
+ */
+declare function queryPoolItems(options?: QueryPoolItemsOptions): PoolItemsQueryBuilder;
+interface QueryPoolItemsOptions {
+    /**
+     * Fields to be included in the response.
+     * @maxSize 5
+     */
+    fields?: RequestedFieldsWithLiterals[] | undefined;
+}
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface PoolItemsQueryResult extends QueryCursorResult {
+    items: PoolItem[];
+    query: PoolItemsQueryBuilder;
+    next: () => Promise<PoolItemsQueryResult>;
+    prev: () => Promise<PoolItemsQueryResult>;
+}
+interface PoolItemsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolId' | 'programId' | 'externalProgramId' | 'programDefinitionId' | 'externalProgramDefinitionId' | 'poolDefinitionId' | 'itemSetId' | 'beneficiary.memberId' | 'program.id' | 'programDefinition.id' | 'benefitKey' | 'itemReferenceSearchKey', value: any) => PoolItemsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolId' | 'programId' | 'externalProgramId' | 'programDefinitionId' | 'externalProgramDefinitionId' | 'poolDefinitionId' | 'itemSetId' | 'beneficiary.memberId' | 'program.id' | 'programDefinition.id' | 'benefitKey' | 'itemReferenceSearchKey', value: any) => PoolItemsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolId' | 'programId' | 'externalProgramId' | 'programDefinitionId' | 'externalProgramDefinitionId' | 'poolDefinitionId' | 'itemSetId' | 'beneficiary.memberId' | 'program.id' | 'programDefinition.id' | 'benefitKey' | 'itemReferenceSearchKey', value: any) => PoolItemsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolId' | 'programId' | 'externalProgramId' | 'programDefinitionId' | 'externalProgramDefinitionId' | 'poolDefinitionId' | 'itemSetId' | 'beneficiary.memberId' | 'program.id' | 'programDefinition.id' | 'benefitKey' | 'itemReferenceSearchKey', value: any) => PoolItemsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolId' | 'programId' | 'externalProgramId' | 'programDefinitionId' | 'externalProgramDefinitionId' | 'poolDefinitionId' | 'itemSetId' | 'beneficiary.memberId' | 'program.id' | 'programDefinition.id' | 'benefitKey' | 'itemReferenceSearchKey', value: any) => PoolItemsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolId' | 'programId' | 'externalProgramId' | 'programDefinitionId' | 'externalProgramDefinitionId' | 'poolDefinitionId' | 'itemSetId' | 'beneficiary.memberId' | 'program.id' | 'programDefinition.id' | 'benefitKey' | 'itemReferenceSearchKey', value: any) => PoolItemsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: '_id' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolId' | 'programId' | 'externalProgramId' | 'programDefinitionId' | 'externalProgramDefinitionId' | 'poolDefinitionId' | 'itemSetId' | 'beneficiary.memberId' | 'program.id' | 'programDefinition.id' | 'benefitKey' | 'itemReferenceSearchKey', value: string) => PoolItemsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolId' | 'programId' | 'externalProgramId' | 'programDefinitionId' | 'externalProgramDefinitionId' | 'poolDefinitionId' | 'itemSetId' | 'beneficiary.memberId' | 'program.id' | 'programDefinition.id' | 'benefitKey' | 'itemReferenceSearchKey', value: any[]) => PoolItemsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolId' | 'programId' | 'externalProgramId' | 'programDefinitionId' | 'externalProgramDefinitionId' | 'poolDefinitionId' | 'itemSetId' | 'beneficiary.memberId' | 'program.id' | 'programDefinition.id' | 'benefitKey' | 'itemReferenceSearchKey', value: any) => PoolItemsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolId' | 'programId' | 'externalProgramId' | 'programDefinitionId' | 'externalProgramDefinitionId' | 'poolDefinitionId' | 'itemSetId' | 'beneficiary.memberId' | 'program.id' | 'programDefinition.id' | 'benefitKey' | 'itemReferenceSearchKey', value: boolean) => PoolItemsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolId' | 'programId' | 'externalProgramId' | 'programDefinitionId' | 'externalProgramDefinitionId' | 'poolDefinitionId' | 'itemSetId' | 'beneficiary.memberId' | 'program.id' | 'programDefinition.id' | 'benefitKey' | 'itemReferenceSearchKey'>) => PoolItemsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolId' | 'programId' | 'externalProgramId' | 'programDefinitionId' | 'externalProgramDefinitionId' | 'poolDefinitionId' | 'itemSetId' | 'beneficiary.memberId' | 'program.id' | 'programDefinition.id' | 'benefitKey' | 'itemReferenceSearchKey'>) => PoolItemsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => PoolItemsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => PoolItemsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<PoolItemsQueryResult>;
+}
+/**
+ * @hidden
+ * @fqn wix.benefit_programs.v1.pool_item.PoolItemService.QueryPoolItems
+ * @requiredField query
+ */
+declare function typedQueryPoolItems(query: PoolItemQuery, options?: QueryPoolItemsOptions): Promise<NonNullablePaths<QueryPoolItemsResponse, `poolItems` | `poolItems.${number}._id` | `poolItems.${number}.externalId` | `poolItems.${number}.category` | `poolItems.${number}.providerAppId` | `poolItems.${number}.namespace` | `poolItems.${number}.poolId` | `poolItems.${number}.itemSetId` | `poolItems.${number}.beneficiary.anonymousVisitorId` | `poolItems.${number}.beneficiary.memberId` | `poolItems.${number}.beneficiary.wixUserId` | `poolItems.${number}.itemId` | `poolItems.${number}.benefitKey` | `poolItems.${number}.itemReferenceSearchKey`, 5>>;
+interface PoolItemQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [
+        {
+            fields: [
+                '_createdDate',
+                '_id',
+                'beneficiary.memberId',
+                'benefitKey',
+                'category',
+                'externalId',
+                'externalProgramDefinitionId',
+                'externalProgramId',
+                'itemReferenceSearchKey',
+                'itemSetId',
+                'namespace',
+                'poolDefinitionId',
+                'poolId',
+                'programDefinitionId',
+                'programId',
+                'providerAppId'
+            ];
+            operators: '*';
+            sort: 'BOTH';
+        }
+    ];
+}
+type CommonQueryWithEntityContext = Query<PoolItem, PoolItemQuerySpec>;
+type PoolItemQuery = {
+    /**
+    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: 1000
+      */
+        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 in the following format:
+    `"filter" : {
+    "fieldName1": "value1",
+    "fieldName2":{"$operator":"value2"}
+    }`
+    Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Sort object in the following format:
+    `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+    @maxSize: 5
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+    }[];
+};
+declare const utils: {
+    query: {
+        QueryBuilder: () => _wix_sdk_types.QueryBuilder<PoolItem, PoolItemQuerySpec, PoolItemQuery>;
+        Filter: _wix_sdk_types.FilterFactory<PoolItem, PoolItemQuerySpec>;
+        Sort: _wix_sdk_types.SortFactory<PoolItemQuerySpec>;
+    };
+};
+
+export { type AccountInfo, type ActionEvent, type BenefitInfo, type CommonIdentificationData, type CommonIdentificationDataIdOneOf, type CommonQueryWithEntityContext, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type IdentityTypeWithLiterals, type InvalidatePoolItemsRequest, type InvalidatePoolItemsResponse, type ItemInfo, type MessageEnvelope, type PoolInfo, type PoolItem, type PoolItemDeactivated, type PoolItemQuery, type PoolItemQuerySpec, type PoolItemsQueryBuilder, type PoolItemsQueryResult, type ProgramDefinitionInfo, type ProgramInfo, type QueryPoolItemsOptions, type QueryPoolItemsRequest, type QueryPoolItemsResponse, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, queryPoolItems, typedQueryPoolItems, utils };