@wix/auto_sdk_benefit-programs_pool-items 1.0.1 → 1.0.2

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

@@ -1,60 +1,58 @@
 import * as _wix_sdk_types from '@wix/sdk-types';
 import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
 
+/**
+ * A pool item represents a specific catalog item that a beneficiary can access as part of a benefit in their pool. Pool items are created automatically when items become available to a beneficiary, and they're removed when the items are revoked.
+ *
+ * Each pool item links a beneficiary's pool to a single catalog item, surfacing pricing, display details, and references to the underlying pool, program, pool definition, and program definition.
+ */
 interface PoolItem {
     /**
-     * Benefit item ID.
+     * Pool item ID. Generated deterministically from `poolId` and `itemId`.
      * @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.
+     * Revision number, which increments by 1 each time the pool item is updated.
      * @readonly
      */
     revision?: string | null;
     /**
-     * Date and time the item was created.
+     * Date and time the pool item was created.
      * @readonly
      */
     _createdDate?: Date | null;
     /**
-     * Date and time the item was updated.
+     * Date and time the pool 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.
+     * For example, if the items are products, this ID corresponds to the specific product ID in the provider's system.
      * @format GUID
      * @immutable
      * @readonly
      */
     externalId?: string;
     /**
-     * Item category. Groups benefit items together for organization and management purposes. For example, classes, posts, groups.
+     * Item category. Groups benefit items together for organization and management. For example, `classes`, `posts`, or `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.
+     * ID of the application that provides the benefit items. Each item's `externalId` is unique within its provider 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`.
+     * Namespace for your app or site's benefit programs. Namespaces let you distinguish between entities that you created and entities that other apps created.
      * @minLength 1
      * @maxLength 20
      * @immutable
@@ -62,79 +60,110 @@ interface PoolItem {
      */
     namespace?: string;
     /**
-     * Pool id
+     * ID of the pool that contains this item. A pool is the runtime container of benefits and items provisioned for a beneficiary.
      * @format GUID
      * @immutable
      * @readonly
      */
     poolId?: string;
     /**
-     * Program id
+     * ID of the program that contains this pool item. The program is the runtime instance of a program definition for a specific beneficiary.
      * @format GUID
      * @immutable
      * @readonly
      */
     programId?: string | null;
     /**
-     * Program external id
+     * External program ID assigned by the provider.
      * @format GUID
      * @readonly
      */
     externalProgramId?: string | null;
     /**
-     * Program definition id
+     * ID of the program definition that's the template for this pool item's program.
      * @format GUID
      * @immutable
      * @readonly
      */
     programDefinitionId?: string | null;
     /**
-     * Program definition external id
+     * External program definition ID assigned by the provider.
      * @format GUID
      * @immutable
      * @readonly
      */
     externalProgramDefinitionId?: string | null;
     /**
-     * Pool definition id
+     * ID of the pool definition that's the template for this pool item's pool.
      * @format GUID
      * @immutable
      * @readonly
      */
     poolDefinitionId?: string | null;
     /**
-     * Item set ID.
+     * Internal grouping identifier for this benefit's item set. Use `poolId` together with `benefitKey` to identify a benefit — `itemSetId` is an implementation detail.
      * @format GUID
      * @immutable
      * @readonly
      */
     itemSetId?: string;
     /**
-     * Who is getting the benefit
+     * Beneficiary of the pool — the member, contact, or visitor who holds this pool item.
      * @readonly
      * @immutable
      */
     beneficiary?: CommonIdentificationData;
     /**
-     * Item set ID.
+     * Pool details, including display name and description.
+     *
+     * Returned only when `POOL` is included in the `fields` request parameter.
+     * @readonly
+     */
+    pool?: PoolInfo;
+    /**
+     * Program details — `id`, `externalId`, and `displayName`.
+     *
+     * Returned only when `PROGRAM` is included in the `fields` request parameter.
+     * @readonly
+     */
+    program?: ProgramInfo;
+    /**
+     * Program definition that includes this item as an accessible benefit.
+     *
+     * Returned only when `PROGRAM_DEFINITION` is included in the `fields` request parameter.
+     * @readonly
+     */
+    programDefinition?: ProgramDefinitionInfo;
+    /**
+     * Item ID.
      * @format GUID
      * @immutable
      * @readonly
      */
     itemId?: string;
     /**
-     * Unique identifier for the benefit associated with this item.
+     * Display name for the catalog item.
+     *
+     * Returned only when `ITEM` is included in the `fields` request parameter.
+     * @readonly
+     */
+    itemInfo?: ItemInfo;
+    /**
+     * Pricing and display information for the associated benefit, including credit price, name, and description.
+     *
+     * Returned only when `BENEFIT` is included in the `fields` request parameter.
+     * @readonly
+     */
+    benefitInfo?: BenefitInfo;
+    /**
+     * Unique identifier for the benefit that grants access to 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
+     * Pre-computed search key for the item reference, built by concatenating `providerAppId`, `category`, and `externalId` separated by `/`. Use this field for efficient single-field filtering instead of composing three separate conditions.
      * @maxLength 94
      * @immutable
      * @readonly
@@ -188,11 +217,10 @@ declare enum IdentityType {
 }
 /** @enumType */
 type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER';
+/** Pool's display details. */
 interface PoolInfo {
     /**
-     * Pool name.
-     *
-     * You may want to use the same name that's used in the associated pool definition.
+     * Pool's display name. Often matches the name on the associated pool definition.
      * @maxLength 64
      */
     displayName?: string;
@@ -202,36 +230,38 @@ interface PoolInfo {
      */
     description?: string | null;
 }
+/** Program's identifying details. */
 interface ProgramInfo {
     /**
-     * Program id
+     * Program ID.
      * @format GUID
      */
     _id?: string;
     /**
-     * Program external id
+     * External program ID assigned by the provider.
      * @format GUID
      */
     externalId?: string | null;
     /**
-     * Program name.
+     * Program's display name.
      * @maxLength 64
      */
     displayName?: string | null;
 }
+/** Program definition's display details. */
 interface ProgramDefinitionInfo {
     /**
-     * Program definition id
+     * Program definition ID.
      * @format GUID
      */
     _id?: string;
     /**
-     * Program definition external id
+     * External program definition ID assigned by the provider.
      * @format GUID
      */
     externalId?: string | null;
     /**
-     * Program definition name
+     * Program definition's display name.
      * @maxLength 64
      */
     displayName?: string | null;
@@ -241,26 +271,30 @@ interface ProgramDefinitionInfo {
      */
     description?: string | null;
 }
+/** Catalog item's display details. */
 interface ItemInfo {
     /**
-     * Item display name.
+     * Item's display name.
      * @maxLength 64
      */
     displayName?: string | null;
 }
+/** Pricing and display information for a benefit. */
 interface BenefitInfo {
     /**
-     * Price of the benefit in credits. The price is the same for all of this benefit's items.
+     * Cost of the benefit in credits. The cost is the same for all items in this benefit.
+     *
+     * Credits are a configurable unit defined on the parent pool definition. The unit type is set in the pool definition's credit configuration. Absent when no credit-based pricing is configured for this benefit.
      * @decimalValue options { gte:0, maxScale:4 }
      */
     price?: string | null;
     /**
-     * Unique identifier for this benefit.
+     * Unique identifier for this benefit. Same value as `poolItem.benefitKey`.
      * @maxLength 64
      */
     benefitKey?: string;
     /**
-     * Benefit name.
+     * Benefit's display name.
      * @maxLength 40
      */
     displayName?: string | null;
@@ -270,15 +304,21 @@ interface BenefitInfo {
      */
     description?: string | null;
 }
+/** Deprecated: use `PoolItemRemoved` instead. Will be removed on 2026-05-31 after clients have migrated. */
 interface PoolItemDeactivated {
-    /** The pool item that was deactivated. */
+    /** Pool item that was deactivated. */
+    poolItem?: PoolItem;
+}
+/** Payload for the `PoolItemRemoved` action event. */
+interface PoolItemRemoved {
+    /** Pool item that was removed from its benefit. */
     poolItem?: PoolItem;
 }
 interface QueryPoolItemsRequest {
-    /** Query to select benefit items. */
+    /** Query options. */
     query?: CursorQuery;
     /**
-     * Fields to be included in the response.
+     * Optional enrichments to include in the response.
      * @maxSize 5
      */
     fields?: RequestedFieldsWithLiterals[];
@@ -338,18 +378,23 @@ interface CursorPaging {
     cursor?: string | null;
 }
 declare enum RequestedFields {
+    /** Populates the `pool` field with the pool's display name and description. */
     POOL = "POOL",
+    /** Populates the `program` field with the program's display name. */
     PROGRAM = "PROGRAM",
+    /** Populates the `programDefinition` field with the program definition's display name and description. */
     PROGRAM_DEFINITION = "PROGRAM_DEFINITION",
+    /** Populates the `itemInfo` field with the catalog item's display name. */
     ITEM = "ITEM",
+    /** Populates the `benefitInfo` field with the benefit's credit price, name, and description. */
     BENEFIT = "BENEFIT"
 }
 /** @enumType */
 type RequestedFieldsWithLiterals = RequestedFields | 'POOL' | 'PROGRAM' | 'PROGRAM_DEFINITION' | 'ITEM' | 'BENEFIT';
 interface QueryPoolItemsResponse {
-    /** List of items. */
+    /** List of retrieved pool items. */
     poolItems?: PoolItem[];
-    /** Metadata for paginated results. */
+    /** Paging metadata. */
     metadata?: CursorPagingMetadata;
 }
 interface CursorPagingMetadata {
@@ -379,12 +424,12 @@ interface Cursors {
 }
 interface InvalidatePoolItemsRequest {
     /**
-     * The pool ID whose items are to be invalidated
+     * ID of the pool whose items are invalidated.
      * @format GUID
      */
     poolId?: string;
     /**
-     * List of item set ids whose items are to be invalidated
+     * IDs of the item sets to invalidate. When empty, items for all benefits in the pool are invalidated.
      * @maxSize 10
      * @format GUID
      */
@@ -546,11 +591,20 @@ interface AccountInfo {
     siteId?: string | null;
 }
 /**
- * Retrieves a list of benefit items, given the provided paging, filtering, and sorting. Returns up to 1000 item per request.
+ * Retrieves a list of up to 1,000 pool items, given the provided paging, filtering, and sorting.
+ *
+ * Returns only active pool items — soft-deleted pool items are automatically excluded from the response.
+ *
+ * When called by a logged-in member without an explicit `beneficiary.memberId` filter, the response is automatically scoped to the calling member. App callers must include a `beneficiary.memberId` filter to scope the response to a specific beneficiary.
+ *
+ * Query Pool Items runs with these defaults, which you can override:
+ *
+ * - `createdDate` is sorted in `DESC` order
+ * - `cursorPaging.limit` is `50`
  *
- * 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 about working with Query methods, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language), [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging), and [Field Projection](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-field-projection).
  *
- * To learn how to query program definitions, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+ * For a detailed list of supported filters, see [Pool Items: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/item-v1/filtering-and-sorting).
  * @public
  * @documentationMaturity preview
  * @permissionId benefit_programs:v1:pool_item:query_pool_items
@@ -561,7 +615,7 @@ interface AccountInfo {
 declare function queryPoolItems(options?: QueryPoolItemsOptions): PoolItemsQueryBuilder;
 interface QueryPoolItemsOptions {
     /**
-     * Fields to be included in the response.
+     * Optional enrichments to include in the response.
      * @maxSize 5
      */
     fields?: RequestedFieldsWithLiterals[] | undefined;
@@ -648,7 +702,7 @@ interface PoolItemsQueryBuilder {
  * @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>>;
+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}.pool.displayName` | `poolItems.${number}.program._id` | `poolItems.${number}.programDefinition._id` | `poolItems.${number}.itemId` | `poolItems.${number}.benefitInfo.benefitKey` | `poolItems.${number}.benefitKey` | `poolItems.${number}.itemReferenceSearchKey`, 5>>;
 interface PoolItemQuerySpec extends QuerySpec {
     paging: 'cursor';
     wql: [
@@ -730,4 +784,4 @@ declare const utils: {
     };
 };
 
-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 };
+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 PoolItemRemoved, 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 };

package/build/cjs/index.typings.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../index.typings.ts","../../src/benefit-programs-v1-pool-item-pool-items.universal.ts","../../src/benefit-programs-v1-pool-item-pool-items.http.ts"],"sourcesContent":["export * from './src/benefit-programs-v1-pool-item-pool-items.universal.js';\n","import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport { queryBuilder } from '@wix/sdk-runtime/query-builder';\nimport {\n  renameKeysFromSDKRequestToRESTRequest,\n  renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport {\n  HttpClient,\n  HttpResponse,\n  NonNullablePaths,\n  QuerySpec,\n  Query as QuerySdkType,\n} from '@wix/sdk-types';\nimport * as ambassadorWixBenefitProgramsV1PoolItem from './benefit-programs-v1-pool-item-pool-items.http.js';\n// @ts-ignore\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { createQueryUtils } from '@wix/sdk-runtime/query-builder-utils';\n\nexport interface PoolItem {\n  /**\n   * Benefit item ID.\n   * @format GUID\n   * @readonly\n   */\n  _id?: string;\n  /**\n   * Revision number, which increments by 1 each time the benefit item is updated.\n   * To prevent conflicting changes, the current revision must be passed when updating the item.\n   *\n   * Ignored when creating an item.\n   * @readonly\n   */\n  revision?: string | null;\n  /**\n   * Date and time the item was created.\n   * @readonly\n   */\n  _createdDate?: Date | null;\n  /**\n   * Date and time the item was updated.\n   * @readonly\n   */\n  _updatedDate?: Date | null;\n  /**\n   * External item ID assigned by the provider of the items.\n   *\n   * For example, if the benefit items are products, this ID corresponds to the specific product ID in the supplier's system.\n   * @format GUID\n   * @immutable\n   * @readonly\n   */\n  externalId?: string;\n  /**\n   * Item category. Groups benefit items together for organization and management purposes. For example, classes, posts, groups.\n   * @maxLength 20\n   * @immutable\n   * @readonly\n   */\n  category?: string;\n  /**\n   * ID of the application providing the benefit item.\n   *\n   * ID of the external application supplying the items. Each item's external ID is unique to its respective provider's application.\n   * @format GUID\n   * @immutable\n   * @readonly\n   */\n  providerAppId?: string;\n  /**\n   * Module name of the item provider's application that originated the items.\n   *\n   * For example, `store-inventory` or `fitness-resources`.\n   * @minLength 1\n   * @maxLength 20\n   * @immutable\n   * @readonly\n   */\n  namespace?: string;\n  /**\n   * Pool id\n   * @format GUID\n   * @immutable\n   * @readonly\n   */\n  poolId?: string;\n  /**\n   * Program id\n   * @format GUID\n   * @immutable\n   * @readonly\n   */\n  programId?: string | null;\n  /**\n   * Program external id\n   * @format GUID\n   * @readonly\n   */\n  externalProgramId?: string | null;\n  /**\n   * Program definition id\n   * @format GUID\n   * @immutable\n   * @readonly\n   */\n  programDefinitionId?: string | null;\n  /**\n   * Program definition external id\n   * @format GUID\n   * @immutable\n   * @readonly\n   */\n  externalProgramDefinitionId?: string | null;\n  /**\n   * Pool definition id\n   * @format GUID\n   * @immutable\n   * @readonly\n   */\n  poolDefinitionId?: string | null;\n  /**\n   * Item set ID.\n   * @format GUID\n   * @immutable\n   * @readonly\n   */\n  itemSetId?: string;\n  /**\n   * Who is getting the benefit\n   * @readonly\n   * @immutable\n   */\n  beneficiary?: CommonIdentificationData;\n  /**\n   * Additional pool data related to the benefit item.\n   * @internal\n   * @readonly\n   */\n  pool?: PoolInfo;\n  /**\n   * Additional program data related to the benefit item\n   * @internal\n   * @readonly\n   */\n  program?: ProgramInfo;\n  /**\n   * Additional program definition data related to the benefit item\n   * @internal\n   * @readonly\n   */\n  programDefinition?: ProgramDefinitionInfo;\n  /**\n   * Item set ID.\n   * @format GUID\n   * @immutable\n   * @readonly\n   */\n  itemId?: string;\n  /**\n   * Additional item data related to the benefit item.\n   * @internal\n   * @readonly\n   */\n  itemInfo?: ItemInfo;\n  /**\n   * Benefit information\n   * @internal\n   * @readonly\n   */\n  benefitInfo?: BenefitInfo;\n  /**\n   * Unique identifier for the benefit associated with this item.\n   * @maxLength 64\n   * @immutable\n   * @readonly\n   */\n  benefitKey?: string;\n  /**\n   * Search key for the item reference, which is a unique identifier for searching and referencing the item within the provider's system.\n   * It's build by concatenating the following fields in this order, separated by a separator (e.g., \"/\"):\n   * - providerAppId\n   * - category\n   * - externalId\n   * @maxLength 94\n   * @immutable\n   * @readonly\n   */\n  itemReferenceSearchKey?: string;\n}\n\nexport interface CommonIdentificationData\n  extends CommonIdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that hasn't logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site member.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user.\n   * @format GUID\n   */\n  wixUserId?: string;\n}\n\n/** @oneof */\nexport interface CommonIdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that hasn't logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site member.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user.\n   * @format GUID\n   */\n  wixUserId?: string;\n}\n\nexport enum IdentityType {\n  /** Unknown type. This value is not used. */\n  UNKNOWN = 'UNKNOWN',\n  /** A site visitor who has not logged in. */\n  ANONYMOUS_VISITOR = 'ANONYMOUS_VISITOR',\n  /** A logged-in site member. */\n  MEMBER = 'MEMBER',\n  /** A Wix account holder, such as a site owner or contributor. */\n  WIX_USER = 'WIX_USER',\n}\n\n/** @enumType */\nexport type IdentityTypeWithLiterals =\n  | IdentityType\n  | 'UNKNOWN'\n  | 'ANONYMOUS_VISITOR'\n  | 'MEMBER'\n  | 'WIX_USER';\n\nexport interface PoolInfo {\n  /**\n   * Pool name.\n   *\n   * You may want to use the same name that's used in the associated pool definition.\n   * @maxLength 64\n   */\n  displayName?: string;\n  /**\n   * Pool description.\n   * @maxLength 450\n   */\n  description?: string | null;\n}\n\nexport interface ProgramInfo {\n  /**\n   * Program id\n   * @format GUID\n   */\n  _id?: string;\n  /**\n   * Program external id\n   * @format GUID\n   */\n  externalId?: string | null;\n  /**\n   * Program name.\n   * @maxLength 64\n   */\n  displayName?: string | null;\n}\n\nexport interface ProgramDefinitionInfo {\n  /**\n   * Program definition id\n   * @format GUID\n   */\n  _id?: string;\n  /**\n   * Program definition external id\n   * @format GUID\n   */\n  externalId?: string | null;\n  /**\n   * Program definition name\n   * @maxLength 64\n   */\n  displayName?: string | null;\n  /**\n   * Program definition description.\n   * @maxLength 450\n   */\n  description?: string | null;\n}\n\nexport interface ItemInfo {\n  /**\n   * Item display name.\n   * @maxLength 64\n   */\n  displayName?: string | null;\n}\n\nexport interface BenefitInfo {\n  /**\n   * Price of the benefit in credits. The price is the same for all of this benefit's items.\n   * @decimalValue options { gte:0, maxScale:4 }\n   */\n  price?: string | null;\n  /**\n   * Unique identifier for this benefit.\n   * @maxLength 64\n   */\n  benefitKey?: string;\n  /**\n   * Benefit name.\n   * @maxLength 40\n   */\n  displayName?: string | null;\n  /**\n   * Benefit description.\n   * @maxLength 255\n   */\n  description?: string | null;\n}\n\nexport interface PoolItemDeactivated {\n  /** The pool item that was deactivated. */\n  poolItem?: PoolItem;\n}\n\nexport interface QueryPoolItemsRequest {\n  /** Query to select benefit items. */\n  query?: CursorQuery;\n  /**\n   * Fields to be included in the response.\n   * @maxSize 5\n   */\n  fields?: RequestedFieldsWithLiterals[];\n}\n\nexport interface CursorQuery extends CursorQueryPagingMethodOneOf {\n  /** 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`. */\n  cursorPaging?: CursorPaging;\n  /**\n   * Filter object in the following format:\n   * `\"filter\" : {\n   * \"fieldName1\": \"value1\",\n   * \"fieldName2\":{\"$operator\":\"value2\"}\n   * }`\n   * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n   */\n  filter?: Record<string, any> | null;\n  /**\n   * Sort object in the following format:\n   * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n   * @maxSize 5\n   */\n  sort?: Sorting[];\n}\n\n/** @oneof */\nexport interface CursorQueryPagingMethodOneOf {\n  /** 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`. */\n  cursorPaging?: CursorPaging;\n}\n\nexport interface Sorting {\n  /**\n   * Name of the field to sort by.\n   * @maxLength 512\n   */\n  fieldName?: string;\n  /** Sort order. */\n  order?: SortOrderWithLiterals;\n}\n\nexport enum SortOrder {\n  ASC = 'ASC',\n  DESC = 'DESC',\n}\n\n/** @enumType */\nexport type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';\n\nexport interface CursorPaging {\n  /**\n   * Maximum number of items to return in the results.\n   * @max 1000\n   */\n  limit?: number | null;\n  /**\n   * Pointer to the next or previous page in the list of results.\n   *\n   * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n   * Not relevant for the first request.\n   * @maxLength 16000\n   */\n  cursor?: string | null;\n}\n\nexport enum RequestedFields {\n  POOL = 'POOL',\n  PROGRAM = 'PROGRAM',\n  PROGRAM_DEFINITION = 'PROGRAM_DEFINITION',\n  ITEM = 'ITEM',\n  BENEFIT = 'BENEFIT',\n}\n\n/** @enumType */\nexport type RequestedFieldsWithLiterals =\n  | RequestedFields\n  | 'POOL'\n  | 'PROGRAM'\n  | 'PROGRAM_DEFINITION'\n  | 'ITEM'\n  | 'BENEFIT';\n\nexport interface QueryPoolItemsResponse {\n  /** List of items. */\n  poolItems?: PoolItem[];\n  /** Metadata for paginated results. */\n  metadata?: CursorPagingMetadata;\n}\n\nexport interface CursorPagingMetadata {\n  /** Number of items returned in the response. */\n  count?: number | null;\n  /** Cursor strings that point to the next page, previous page, or both. */\n  cursors?: Cursors;\n  /**\n   * Whether there are more pages to retrieve following the current page.\n   *\n   * + `true`: Another page of results can be retrieved.\n   * + `false`: This is the last page.\n   */\n  hasNext?: boolean | null;\n}\n\nexport interface Cursors {\n  /**\n   * Cursor string pointing to the next page in the list of results.\n   * @maxLength 16000\n   */\n  next?: string | null;\n  /**\n   * Cursor pointing to the previous page in the list of results.\n   * @maxLength 16000\n   */\n  prev?: string | null;\n}\n\nexport interface InvalidatePoolItemsRequest {\n  /**\n   * The pool ID whose items are to be invalidated\n   * @format GUID\n   */\n  poolId?: string;\n  /**\n   * List of item set ids whose items are to be invalidated\n   * @maxSize 10\n   * @format GUID\n   */\n  itemSetIds?: string[];\n}\n\nexport interface InvalidatePoolItemsResponse {}\n\nexport interface DomainEvent extends DomainEventBodyOneOf {\n  createdEvent?: EntityCreatedEvent;\n  updatedEvent?: EntityUpdatedEvent;\n  deletedEvent?: EntityDeletedEvent;\n  actionEvent?: ActionEvent;\n  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */\n  _id?: string;\n  /**\n   * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.\n   * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.\n   */\n  entityFqdn?: string;\n  /**\n   * Event action name, placed at the top level to make it easier for users to dispatch messages.\n   * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.\n   */\n  slug?: string;\n  /** ID of the entity associated with the event. */\n  entityId?: string;\n  /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */\n  eventTime?: Date | null;\n  /**\n   * Whether the event was triggered as a result of a privacy regulation application\n   * (for example, GDPR).\n   */\n  triggeredByAnonymizeRequest?: boolean | null;\n  /** If present, indicates the action that triggered the event. */\n  originatedFrom?: string | null;\n  /**\n   * 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.\n   * 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.\n   */\n  entityEventSequence?: string | null;\n}\n\n/** @oneof */\nexport interface DomainEventBodyOneOf {\n  createdEvent?: EntityCreatedEvent;\n  updatedEvent?: EntityUpdatedEvent;\n  deletedEvent?: EntityDeletedEvent;\n  actionEvent?: ActionEvent;\n}\n\nexport interface EntityCreatedEvent {\n  entity?: string;\n}\n\nexport interface RestoreInfo {\n  deletedDate?: Date | null;\n}\n\nexport interface EntityUpdatedEvent {\n  /**\n   * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n   * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n   * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n   */\n  currentEntity?: string;\n}\n\nexport interface EntityDeletedEvent {\n  /** Entity that was deleted. */\n  deletedEntity?: string | null;\n}\n\nexport interface ActionEvent {\n  body?: string;\n}\n\nexport interface MessageEnvelope {\n  /**\n   * App instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n  /**\n   * Event type.\n   * @maxLength 150\n   */\n  eventType?: string;\n  /** The identification type and identity data. */\n  identity?: IdentificationData;\n  /** Stringify payload. */\n  data?: string;\n  /** Details related to the account */\n  accountInfo?: AccountInfo;\n}\n\nexport interface IdentificationData extends IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n  /** @readonly */\n  identityType?: WebhookIdentityTypeWithLiterals;\n}\n\n/** @oneof */\nexport interface IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n}\n\nexport enum WebhookIdentityType {\n  UNKNOWN = 'UNKNOWN',\n  ANONYMOUS_VISITOR = 'ANONYMOUS_VISITOR',\n  MEMBER = 'MEMBER',\n  WIX_USER = 'WIX_USER',\n  APP = 'APP',\n}\n\n/** @enumType */\nexport type WebhookIdentityTypeWithLiterals =\n  | WebhookIdentityType\n  | 'UNKNOWN'\n  | 'ANONYMOUS_VISITOR'\n  | 'MEMBER'\n  | 'WIX_USER'\n  | 'APP';\n\nexport interface AccountInfo {\n  /**\n   * ID of the Wix account associated with the event.\n   * @format GUID\n   */\n  accountId?: string | null;\n  /**\n   * ID of the parent Wix account. Only included when accountId belongs to a child account.\n   * @format GUID\n   */\n  parentAccountId?: string | null;\n  /**\n   * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.\n   * @format GUID\n   */\n  siteId?: string | null;\n}\n\n/**\n * Retrieves a list of benefit items, given the provided paging, filtering, and sorting. Returns up to 1000 item per request.\n *\n * 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).\n *\n * To learn how to query program definitions, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).\n * @public\n * @documentationMaturity preview\n * @permissionId benefit_programs:v1:pool_item:query_pool_items\n * @permissionId BENEFIT_PROGRAMS.POOL_READ\n * @applicableIdentity APP\n * @fqn wix.benefit_programs.v1.pool_item.PoolItemService.QueryPoolItems\n */\nexport function queryPoolItems(\n  options?: QueryPoolItemsOptions\n): PoolItemsQueryBuilder {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[1] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  return queryBuilder<\n    PoolItem,\n    'CURSOR',\n    QueryPoolItemsRequest,\n    QueryPoolItemsResponse\n  >({\n    func: async (payload: QueryPoolItemsRequest) => {\n      const reqOpts = ambassadorWixBenefitProgramsV1PoolItem.queryPoolItems({\n        ...payload,\n        ...(options ?? {}),\n      });\n\n      sideEffects?.onSiteCall?.();\n      try {\n        const result = await httpClient.request(reqOpts);\n        sideEffects?.onSuccess?.(result);\n        return result;\n      } catch (err) {\n        sideEffects?.onError?.(err);\n        throw err;\n      }\n    },\n    requestTransformer: (query: QueryPoolItemsRequest['query']) => {\n      const args = [query, options] as [\n        QueryPoolItemsRequest['query'],\n        QueryPoolItemsOptions\n      ];\n      return renameKeysFromSDKRequestToRESTRequest({\n        ...args?.[1],\n        query: args?.[0],\n      });\n    },\n    responseTransformer: ({ data }: HttpResponse<QueryPoolItemsResponse>) => {\n      const transformedData = renameKeysFromRESTResponseToSDKResponse(\n        transformPaths(data, [])\n      );\n\n      return {\n        items: transformedData?.poolItems,\n        pagingMetadata: transformedData?.metadata,\n      };\n    },\n    errorTransformer: (err: unknown) => {\n      const transformedError = sdkTransformError(err, {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: { query: '$[0]' },\n        singleArgumentUnchanged: false,\n      });\n\n      throw transformedError;\n    },\n    pagingMethod: 'CURSOR',\n    transformationPaths: {},\n  });\n}\n\nexport interface QueryPoolItemsOptions {\n  /**\n   * Fields to be included in the response.\n   * @maxSize 5\n   */\n  fields?: RequestedFieldsWithLiterals[] | undefined;\n}\n\ninterface QueryCursorResult {\n  cursors: Cursors;\n  hasNext: () => boolean;\n  hasPrev: () => boolean;\n  length: number;\n  pageSize: number;\n}\n\nexport interface PoolItemsQueryResult extends QueryCursorResult {\n  items: PoolItem[];\n  query: PoolItemsQueryBuilder;\n  next: () => Promise<PoolItemsQueryResult>;\n  prev: () => Promise<PoolItemsQueryResult>;\n}\n\nexport interface PoolItemsQueryBuilder {\n  /** @param propertyName - Property whose value is compared with `value`.\n   * @param value - Value to compare against.\n   * @documentationMaturity preview\n   */\n  eq: (\n    propertyName:\n      | '_id'\n      | '_createdDate'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey',\n    value: any\n  ) => PoolItemsQueryBuilder;\n  /** @param propertyName - Property whose value is compared with `value`.\n   * @param value - Value to compare against.\n   * @documentationMaturity preview\n   */\n  ne: (\n    propertyName:\n      | '_id'\n      | '_createdDate'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey',\n    value: any\n  ) => PoolItemsQueryBuilder;\n  /** @param propertyName - Property whose value is compared with `value`.\n   * @param value - Value to compare against.\n   * @documentationMaturity preview\n   */\n  ge: (\n    propertyName:\n      | '_id'\n      | '_createdDate'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey',\n    value: any\n  ) => PoolItemsQueryBuilder;\n  /** @param propertyName - Property whose value is compared with `value`.\n   * @param value - Value to compare against.\n   * @documentationMaturity preview\n   */\n  gt: (\n    propertyName:\n      | '_id'\n      | '_createdDate'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey',\n    value: any\n  ) => PoolItemsQueryBuilder;\n  /** @param propertyName - Property whose value is compared with `value`.\n   * @param value - Value to compare against.\n   * @documentationMaturity preview\n   */\n  le: (\n    propertyName:\n      | '_id'\n      | '_createdDate'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey',\n    value: any\n  ) => PoolItemsQueryBuilder;\n  /** @param propertyName - Property whose value is compared with `value`.\n   * @param value - Value to compare against.\n   * @documentationMaturity preview\n   */\n  lt: (\n    propertyName:\n      | '_id'\n      | '_createdDate'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey',\n    value: any\n  ) => PoolItemsQueryBuilder;\n  /** @param propertyName - Property whose value is compared with `string`.\n   * @param string - String to compare against. Case-insensitive.\n   * @documentationMaturity preview\n   */\n  startsWith: (\n    propertyName:\n      | '_id'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey',\n    value: string\n  ) => PoolItemsQueryBuilder;\n  /** @param propertyName - Property whose value is compared with `values`.\n   * @param values - List of values to compare against.\n   * @documentationMaturity preview\n   */\n  hasSome: (\n    propertyName:\n      | '_id'\n      | '_createdDate'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey',\n    value: any[]\n  ) => PoolItemsQueryBuilder;\n  /** @documentationMaturity preview */\n  in: (\n    propertyName:\n      | '_id'\n      | '_createdDate'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey',\n    value: any\n  ) => PoolItemsQueryBuilder;\n  /** @documentationMaturity preview */\n  exists: (\n    propertyName:\n      | '_id'\n      | '_createdDate'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey',\n    value: boolean\n  ) => PoolItemsQueryBuilder;\n  /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n   * @documentationMaturity preview\n   */\n  ascending: (\n    ...propertyNames: Array<\n      | '_id'\n      | '_createdDate'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey'\n    >\n  ) => PoolItemsQueryBuilder;\n  /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n   * @documentationMaturity preview\n   */\n  descending: (\n    ...propertyNames: Array<\n      | '_id'\n      | '_createdDate'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey'\n    >\n  ) => PoolItemsQueryBuilder;\n  /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n   * @documentationMaturity preview\n   */\n  limit: (limit: number) => PoolItemsQueryBuilder;\n  /** @param cursor - A pointer to specific record\n   * @documentationMaturity preview\n   */\n  skipTo: (cursor: string) => PoolItemsQueryBuilder;\n  /** @documentationMaturity preview */\n  find: () => Promise<PoolItemsQueryResult>;\n}\n\n/**\n * @hidden\n * @fqn wix.benefit_programs.v1.pool_item.PoolItemService.QueryPoolItems\n * @requiredField query\n */\nexport async function typedQueryPoolItems(\n  query: PoolItemQuery,\n  options?: QueryPoolItemsOptions\n): Promise<\n  NonNullablePaths<\n    QueryPoolItemsResponse,\n    | `poolItems`\n    | `poolItems.${number}._id`\n    | `poolItems.${number}.externalId`\n    | `poolItems.${number}.category`\n    | `poolItems.${number}.providerAppId`\n    | `poolItems.${number}.namespace`\n    | `poolItems.${number}.poolId`\n    | `poolItems.${number}.itemSetId`\n    | `poolItems.${number}.beneficiary.anonymousVisitorId`\n    | `poolItems.${number}.beneficiary.memberId`\n    | `poolItems.${number}.beneficiary.wixUserId`\n    | `poolItems.${number}.itemId`\n    | `poolItems.${number}.benefitKey`\n    | `poolItems.${number}.itemReferenceSearchKey`,\n    5\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[2] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    query: query,\n    ...options,\n  });\n\n  const reqOpts =\n    ambassadorWixBenefitProgramsV1PoolItem.queryPoolItems(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: { query: '$[0]' },\n        singleArgumentUnchanged: false,\n      },\n      ['query', 'options']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\nexport interface PoolItemQuerySpec extends QuerySpec {\n  paging: 'cursor';\n  wql: [\n    {\n      fields: [\n        '_createdDate',\n        '_id',\n        'beneficiary.memberId',\n        'benefitKey',\n        'category',\n        'externalId',\n        'externalProgramDefinitionId',\n        'externalProgramId',\n        'itemReferenceSearchKey',\n        'itemSetId',\n        'namespace',\n        'poolDefinitionId',\n        'poolId',\n        'programDefinitionId',\n        'programId',\n        'providerAppId'\n      ];\n      operators: '*';\n      sort: 'BOTH';\n    }\n  ];\n}\n\nexport type CommonQueryWithEntityContext = QuerySdkType<\n  PoolItem,\n  PoolItemQuerySpec\n>;\nexport type PoolItemQuery = {\n  /** \n  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`.  \n  */\n  cursorPaging?: {\n    /** \n  Maximum number of items to return in the results. \n  @max: 1000 \n  */\n    limit?:\n      | NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit']\n      | null;\n    /** \n  Pointer to the next or previous page in the list of results.\n\n  Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n  Not relevant for the first request. \n  @maxLength: 16000 \n  */\n    cursor?:\n      | NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor']\n      | null;\n  };\n  /** \n  Filter object in the following format:\n  `\"filter\" : {\n  \"fieldName1\": \"value1\",\n  \"fieldName2\":{\"$operator\":\"value2\"}\n  }`\n  Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`  \n  */\n  filter?: CommonQueryWithEntityContext['filter'] | null;\n  /** \n  Sort object in the following format:\n  `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]` \n  @maxSize: 5 \n  */\n  sort?: {\n    /** \n  Name of the field to sort by. \n  @maxLength: 512 \n  */\n    fieldName?: NonNullable<\n      CommonQueryWithEntityContext['sort']\n    >[number]['fieldName'];\n    /** \n  Sort order.  \n  */\n    order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];\n  }[];\n};\n\nexport const utils = {\n  query: {\n    ...createQueryUtils<PoolItem, PoolItemQuerySpec, PoolItemQuery>(),\n  },\n};\n","import { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixBenefitProgramsV1PoolItemPoolItemServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    _: [\n      {\n        srcPath: '/_api/benefit-programs/v1/pool-items',\n        destPath: '/v1/pool-items',\n      },\n    ],\n    'www.wixapis.com': [\n      {\n        srcPath: '/benefit-programs/v1/pool-items',\n        destPath: '/v1/pool-items',\n      },\n    ],\n    '*.dev.wix-code.com': [\n      {\n        srcPath: '/_api/benefit-programs/v1/pool-items',\n        destPath: '/v1/pool-items',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_benefit-programs_pool-items';\n\n/**\n * Retrieves a list of benefit items, given the provided paging, filtering, and sorting. Returns up to 1000 item per request.\n *\n * 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).\n *\n * To learn how to query program definitions, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).\n */\nexport function queryPoolItems(payload: object): RequestOptionsFactory<any> {\n  function __queryPoolItems({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.benefit_programs.v1.pool_item',\n      method: 'POST' as any,\n      methodFqn:\n        'wix.benefit_programs.v1.pool_item.PoolItemService.QueryPoolItems',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixBenefitProgramsV1PoolItemPoolItemServiceUrl({\n        protoPath: '/v1/pool-items/query',\n        data: payload,\n        host,\n      }),\n      data: payload,\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [\n              { path: 'poolItems.createdDate' },\n              { path: 'poolItems.updatedDate' },\n            ],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __queryPoolItems;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAAAA;AAAA,EAAA;AAAA;AAAA;AAAA;;;ACAA,6BAAoD;AACpD,2BAA6B;AAC7B,oCAGO;;;ACLP,uBAAqD;AACrD,6BAA+B;AAC/B,0BAA2B;AAI3B,SAAS,sDACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,GAAG;AAAA,MACD;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,sBAAsB;AAAA,MACpB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,gCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AASd,SAAS,eAAe,SAA6C;AAC1E,WAAS,iBAAiB,EAAE,KAAK,GAAQ;AACvC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,sDAAsD;AAAA,QACzD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,MACN,mBAAmB,CAACC,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,YACL,EAAE,MAAM,wBAAwB;AAAA,YAChC,EAAE,MAAM,wBAAwB;AAAA,UAClC;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;AD5DA,IAAAC,0BAA+B;AAC/B,iCAAiC;AAmN1B,IAAK,eAAL,kBAAKC,kBAAL;AAEL,EAAAA,cAAA,aAAU;AAEV,EAAAA,cAAA,uBAAoB;AAEpB,EAAAA,cAAA,YAAS;AAET,EAAAA,cAAA,cAAW;AARD,SAAAA;AAAA,GAAA;AA6JL,IAAK,YAAL,kBAAKC,eAAL;AACL,EAAAA,WAAA,SAAM;AACN,EAAAA,WAAA,UAAO;AAFG,SAAAA;AAAA,GAAA;AAwBL,IAAK,kBAAL,kBAAKC,qBAAL;AACL,EAAAA,iBAAA,UAAO;AACP,EAAAA,iBAAA,aAAU;AACV,EAAAA,iBAAA,wBAAqB;AACrB,EAAAA,iBAAA,UAAO;AACP,EAAAA,iBAAA,aAAU;AALA,SAAAA;AAAA,GAAA;AA4ML,IAAK,sBAAL,kBAAKC,yBAAL;AACL,EAAAA,qBAAA,aAAU;AACV,EAAAA,qBAAA,uBAAoB;AACpB,EAAAA,qBAAA,YAAS;AACT,EAAAA,qBAAA,cAAW;AACX,EAAAA,qBAAA,SAAM;AALI,SAAAA;AAAA,GAAA;AAgDL,SAASC,gBACd,SACuB;AAEvB,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,aAAO,mCAKL;AAAA,IACA,MAAM,OAAO,YAAmC;AAC9C,YAAM,UAAiD,eAAe;AAAA,QACpE,GAAG;AAAA,QACH,GAAI,WAAW,CAAC;AAAA,MAClB,CAAC;AAED,mBAAa,aAAa;AAC1B,UAAI;AACF,cAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,qBAAa,YAAY,MAAM;AAC/B,eAAO;AAAA,MACT,SAAS,KAAK;AACZ,qBAAa,UAAU,GAAG;AAC1B,cAAM;AAAA,MACR;AAAA,IACF;AAAA,IACA,oBAAoB,CAAC,UAA0C;AAC7D,YAAM,OAAO,CAAC,OAAO,OAAO;AAI5B,iBAAO,qEAAsC;AAAA,QAC3C,GAAG,OAAO,CAAC;AAAA,QACX,OAAO,OAAO,CAAC;AAAA,MACjB,CAAC;AAAA,IACH;AAAA,IACA,qBAAqB,CAAC,EAAE,KAAK,MAA4C;AACvE,YAAM,sBAAkB;AAAA,YACtB,wCAAe,MAAM,CAAC,CAAC;AAAA,MACzB;AAEA,aAAO;AAAA,QACL,OAAO,iBAAiB;AAAA,QACxB,gBAAgB,iBAAiB;AAAA,MACnC;AAAA,IACF;AAAA,IACA,kBAAkB,CAAC,QAAiB;AAClC,YAAM,uBAAmB,uBAAAC,gBAAkB,KAAK;AAAA,QAC9C,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,OAAO,OAAO;AAAA,QAC1C,yBAAyB;AAAA,MAC3B,CAAC;AAED,YAAM;AAAA,IACR;AAAA,IACA,cAAc;AAAA,IACd,qBAAqB,CAAC;AAAA,EACxB,CAAC;AACH;AA0VA,eAAsB,oBACpB,OACA,SAoBA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC;AAAA,IACpD;AAAA,IACA,GAAG;AAAA,EACL,CAAC;AAED,QAAM,UACmC,eAAe,OAAO;AAE/D,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAA;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,OAAO,OAAO;AAAA,QAC1C,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,SAAS,SAAS;AAAA,IACrB;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AAsFO,IAAM,QAAQ;AAAA,EACnB,OAAO;AAAA,IACL,OAAG,6CAA6D;AAAA,EAClE;AACF;","names":["queryPoolItems","payload","import_transform_paths","IdentityType","SortOrder","RequestedFields","WebhookIdentityType","queryPoolItems","sdkTransformError"]}
+{"version":3,"sources":["../../index.typings.ts","../../src/benefit-programs-v1-pool-item-pool-items.universal.ts","../../src/benefit-programs-v1-pool-item-pool-items.http.ts"],"sourcesContent":["export * from './src/benefit-programs-v1-pool-item-pool-items.universal.js';\n","import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport { queryBuilder } from '@wix/sdk-runtime/query-builder';\nimport {\n  renameKeysFromSDKRequestToRESTRequest,\n  renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport {\n  HttpClient,\n  HttpResponse,\n  NonNullablePaths,\n  QuerySpec,\n  Query as QuerySdkType,\n} from '@wix/sdk-types';\nimport * as ambassadorWixBenefitProgramsV1PoolItem from './benefit-programs-v1-pool-item-pool-items.http.js';\n// @ts-ignore\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { createQueryUtils } from '@wix/sdk-runtime/query-builder-utils';\n\n/**\n * A pool item represents a specific catalog item that a beneficiary can access as part of a benefit in their pool. Pool items are created automatically when items become available to a beneficiary, and they're removed when the items are revoked.\n *\n * Each pool item links a beneficiary's pool to a single catalog item, surfacing pricing, display details, and references to the underlying pool, program, pool definition, and program definition.\n */\nexport interface PoolItem {\n  /**\n   * Pool item ID. Generated deterministically from `poolId` and `itemId`.\n   * @format GUID\n   * @readonly\n   */\n  _id?: string;\n  /**\n   * Revision number, which increments by 1 each time the pool item is updated.\n   * @readonly\n   */\n  revision?: string | null;\n  /**\n   * Date and time the pool item was created.\n   * @readonly\n   */\n  _createdDate?: Date | null;\n  /**\n   * Date and time the pool item was updated.\n   * @readonly\n   */\n  _updatedDate?: Date | null;\n  /**\n   * External item ID assigned by the provider of the items.\n   *\n   * For example, if the items are products, this ID corresponds to the specific product ID in the provider's system.\n   * @format GUID\n   * @immutable\n   * @readonly\n   */\n  externalId?: string;\n  /**\n   * Item category. Groups benefit items together for organization and management. For example, `classes`, `posts`, or `groups`.\n   * @maxLength 20\n   * @immutable\n   * @readonly\n   */\n  category?: string;\n  /**\n   * ID of the application that provides the benefit items. Each item's `externalId` is unique within its provider application.\n   * @format GUID\n   * @immutable\n   * @readonly\n   */\n  providerAppId?: string;\n  /**\n   * Namespace for your app or site's benefit programs. Namespaces let you distinguish between entities that you created and entities that other apps created.\n   * @minLength 1\n   * @maxLength 20\n   * @immutable\n   * @readonly\n   */\n  namespace?: string;\n  /**\n   * ID of the pool that contains this item. A pool is the runtime container of benefits and items provisioned for a beneficiary.\n   * @format GUID\n   * @immutable\n   * @readonly\n   */\n  poolId?: string;\n  /**\n   * ID of the program that contains this pool item. The program is the runtime instance of a program definition for a specific beneficiary.\n   * @format GUID\n   * @immutable\n   * @readonly\n   */\n  programId?: string | null;\n  /**\n   * External program ID assigned by the provider.\n   * @format GUID\n   * @readonly\n   */\n  externalProgramId?: string | null;\n  /**\n   * ID of the program definition that's the template for this pool item's program.\n   * @format GUID\n   * @immutable\n   * @readonly\n   */\n  programDefinitionId?: string | null;\n  /**\n   * External program definition ID assigned by the provider.\n   * @format GUID\n   * @immutable\n   * @readonly\n   */\n  externalProgramDefinitionId?: string | null;\n  /**\n   * ID of the pool definition that's the template for this pool item's pool.\n   * @format GUID\n   * @immutable\n   * @readonly\n   */\n  poolDefinitionId?: string | null;\n  /**\n   * Internal grouping identifier for this benefit's item set. Use `poolId` together with `benefitKey` to identify a benefit — `itemSetId` is an implementation detail.\n   * @format GUID\n   * @immutable\n   * @readonly\n   */\n  itemSetId?: string;\n  /**\n   * Beneficiary of the pool — the member, contact, or visitor who holds this pool item.\n   * @readonly\n   * @immutable\n   */\n  beneficiary?: CommonIdentificationData;\n  /**\n   * Pool details, including display name and description.\n   *\n   * Returned only when `POOL` is included in the `fields` request parameter.\n   * @readonly\n   */\n  pool?: PoolInfo;\n  /**\n   * Program details — `id`, `externalId`, and `displayName`.\n   *\n   * Returned only when `PROGRAM` is included in the `fields` request parameter.\n   * @readonly\n   */\n  program?: ProgramInfo;\n  /**\n   * Program definition that includes this item as an accessible benefit.\n   *\n   * Returned only when `PROGRAM_DEFINITION` is included in the `fields` request parameter.\n   * @readonly\n   */\n  programDefinition?: ProgramDefinitionInfo;\n  /**\n   * Item ID.\n   * @format GUID\n   * @immutable\n   * @readonly\n   */\n  itemId?: string;\n  /**\n   * Display name for the catalog item.\n   *\n   * Returned only when `ITEM` is included in the `fields` request parameter.\n   * @readonly\n   */\n  itemInfo?: ItemInfo;\n  /**\n   * Pricing and display information for the associated benefit, including credit price, name, and description.\n   *\n   * Returned only when `BENEFIT` is included in the `fields` request parameter.\n   * @readonly\n   */\n  benefitInfo?: BenefitInfo;\n  /**\n   * Unique identifier for the benefit that grants access to this item.\n   * @maxLength 64\n   * @immutable\n   * @readonly\n   */\n  benefitKey?: string;\n  /**\n   * Pre-computed search key for the item reference, built by concatenating `providerAppId`, `category`, and `externalId` separated by `/`. Use this field for efficient single-field filtering instead of composing three separate conditions.\n   * @maxLength 94\n   * @immutable\n   * @readonly\n   */\n  itemReferenceSearchKey?: string;\n}\n\nexport interface CommonIdentificationData\n  extends CommonIdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that hasn't logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site member.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user.\n   * @format GUID\n   */\n  wixUserId?: string;\n}\n\n/** @oneof */\nexport interface CommonIdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that hasn't logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site member.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user.\n   * @format GUID\n   */\n  wixUserId?: string;\n}\n\nexport enum IdentityType {\n  /** Unknown type. This value is not used. */\n  UNKNOWN = 'UNKNOWN',\n  /** A site visitor who has not logged in. */\n  ANONYMOUS_VISITOR = 'ANONYMOUS_VISITOR',\n  /** A logged-in site member. */\n  MEMBER = 'MEMBER',\n  /** A Wix account holder, such as a site owner or contributor. */\n  WIX_USER = 'WIX_USER',\n}\n\n/** @enumType */\nexport type IdentityTypeWithLiterals =\n  | IdentityType\n  | 'UNKNOWN'\n  | 'ANONYMOUS_VISITOR'\n  | 'MEMBER'\n  | 'WIX_USER';\n\n/** Pool's display details. */\nexport interface PoolInfo {\n  /**\n   * Pool's display name. Often matches the name on the associated pool definition.\n   * @maxLength 64\n   */\n  displayName?: string;\n  /**\n   * Pool description.\n   * @maxLength 450\n   */\n  description?: string | null;\n}\n\n/** Program's identifying details. */\nexport interface ProgramInfo {\n  /**\n   * Program ID.\n   * @format GUID\n   */\n  _id?: string;\n  /**\n   * External program ID assigned by the provider.\n   * @format GUID\n   */\n  externalId?: string | null;\n  /**\n   * Program's display name.\n   * @maxLength 64\n   */\n  displayName?: string | null;\n}\n\n/** Program definition's display details. */\nexport interface ProgramDefinitionInfo {\n  /**\n   * Program definition ID.\n   * @format GUID\n   */\n  _id?: string;\n  /**\n   * External program definition ID assigned by the provider.\n   * @format GUID\n   */\n  externalId?: string | null;\n  /**\n   * Program definition's display name.\n   * @maxLength 64\n   */\n  displayName?: string | null;\n  /**\n   * Program definition description.\n   * @maxLength 450\n   */\n  description?: string | null;\n}\n\n/** Catalog item's display details. */\nexport interface ItemInfo {\n  /**\n   * Item's display name.\n   * @maxLength 64\n   */\n  displayName?: string | null;\n}\n\n/** Pricing and display information for a benefit. */\nexport interface BenefitInfo {\n  /**\n   * Cost of the benefit in credits. The cost is the same for all items in this benefit.\n   *\n   * Credits are a configurable unit defined on the parent pool definition. The unit type is set in the pool definition's credit configuration. Absent when no credit-based pricing is configured for this benefit.\n   * @decimalValue options { gte:0, maxScale:4 }\n   */\n  price?: string | null;\n  /**\n   * Unique identifier for this benefit. Same value as `poolItem.benefitKey`.\n   * @maxLength 64\n   */\n  benefitKey?: string;\n  /**\n   * Benefit's display name.\n   * @maxLength 40\n   */\n  displayName?: string | null;\n  /**\n   * Benefit description.\n   * @maxLength 255\n   */\n  description?: string | null;\n}\n\n/** Deprecated: use `PoolItemRemoved` instead. Will be removed on 2026-05-31 after clients have migrated. */\nexport interface PoolItemDeactivated {\n  /** Pool item that was deactivated. */\n  poolItem?: PoolItem;\n}\n\n/** Payload for the `PoolItemRemoved` action event. */\nexport interface PoolItemRemoved {\n  /** Pool item that was removed from its benefit. */\n  poolItem?: PoolItem;\n}\n\nexport interface QueryPoolItemsRequest {\n  /** Query options. */\n  query?: CursorQuery;\n  /**\n   * Optional enrichments to include in the response.\n   * @maxSize 5\n   */\n  fields?: RequestedFieldsWithLiterals[];\n}\n\nexport interface CursorQuery extends CursorQueryPagingMethodOneOf {\n  /** 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`. */\n  cursorPaging?: CursorPaging;\n  /**\n   * Filter object in the following format:\n   * `\"filter\" : {\n   * \"fieldName1\": \"value1\",\n   * \"fieldName2\":{\"$operator\":\"value2\"}\n   * }`\n   * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n   */\n  filter?: Record<string, any> | null;\n  /**\n   * Sort object in the following format:\n   * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n   * @maxSize 5\n   */\n  sort?: Sorting[];\n}\n\n/** @oneof */\nexport interface CursorQueryPagingMethodOneOf {\n  /** 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`. */\n  cursorPaging?: CursorPaging;\n}\n\nexport interface Sorting {\n  /**\n   * Name of the field to sort by.\n   * @maxLength 512\n   */\n  fieldName?: string;\n  /** Sort order. */\n  order?: SortOrderWithLiterals;\n}\n\nexport enum SortOrder {\n  ASC = 'ASC',\n  DESC = 'DESC',\n}\n\n/** @enumType */\nexport type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';\n\nexport interface CursorPaging {\n  /**\n   * Maximum number of items to return in the results.\n   * @max 1000\n   */\n  limit?: number | null;\n  /**\n   * Pointer to the next or previous page in the list of results.\n   *\n   * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n   * Not relevant for the first request.\n   * @maxLength 16000\n   */\n  cursor?: string | null;\n}\n\nexport enum RequestedFields {\n  /** Populates the `pool` field with the pool's display name and description. */\n  POOL = 'POOL',\n  /** Populates the `program` field with the program's display name. */\n  PROGRAM = 'PROGRAM',\n  /** Populates the `programDefinition` field with the program definition's display name and description. */\n  PROGRAM_DEFINITION = 'PROGRAM_DEFINITION',\n  /** Populates the `itemInfo` field with the catalog item's display name. */\n  ITEM = 'ITEM',\n  /** Populates the `benefitInfo` field with the benefit's credit price, name, and description. */\n  BENEFIT = 'BENEFIT',\n}\n\n/** @enumType */\nexport type RequestedFieldsWithLiterals =\n  | RequestedFields\n  | 'POOL'\n  | 'PROGRAM'\n  | 'PROGRAM_DEFINITION'\n  | 'ITEM'\n  | 'BENEFIT';\n\nexport interface QueryPoolItemsResponse {\n  /** List of retrieved pool items. */\n  poolItems?: PoolItem[];\n  /** Paging metadata. */\n  metadata?: CursorPagingMetadata;\n}\n\nexport interface CursorPagingMetadata {\n  /** Number of items returned in the response. */\n  count?: number | null;\n  /** Cursor strings that point to the next page, previous page, or both. */\n  cursors?: Cursors;\n  /**\n   * Whether there are more pages to retrieve following the current page.\n   *\n   * + `true`: Another page of results can be retrieved.\n   * + `false`: This is the last page.\n   */\n  hasNext?: boolean | null;\n}\n\nexport interface Cursors {\n  /**\n   * Cursor string pointing to the next page in the list of results.\n   * @maxLength 16000\n   */\n  next?: string | null;\n  /**\n   * Cursor pointing to the previous page in the list of results.\n   * @maxLength 16000\n   */\n  prev?: string | null;\n}\n\nexport interface InvalidatePoolItemsRequest {\n  /**\n   * ID of the pool whose items are invalidated.\n   * @format GUID\n   */\n  poolId?: string;\n  /**\n   * IDs of the item sets to invalidate. When empty, items for all benefits in the pool are invalidated.\n   * @maxSize 10\n   * @format GUID\n   */\n  itemSetIds?: string[];\n}\n\nexport interface InvalidatePoolItemsResponse {}\n\nexport interface DomainEvent extends DomainEventBodyOneOf {\n  createdEvent?: EntityCreatedEvent;\n  updatedEvent?: EntityUpdatedEvent;\n  deletedEvent?: EntityDeletedEvent;\n  actionEvent?: ActionEvent;\n  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */\n  _id?: string;\n  /**\n   * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.\n   * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.\n   */\n  entityFqdn?: string;\n  /**\n   * Event action name, placed at the top level to make it easier for users to dispatch messages.\n   * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.\n   */\n  slug?: string;\n  /** ID of the entity associated with the event. */\n  entityId?: string;\n  /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */\n  eventTime?: Date | null;\n  /**\n   * Whether the event was triggered as a result of a privacy regulation application\n   * (for example, GDPR).\n   */\n  triggeredByAnonymizeRequest?: boolean | null;\n  /** If present, indicates the action that triggered the event. */\n  originatedFrom?: string | null;\n  /**\n   * 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.\n   * 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.\n   */\n  entityEventSequence?: string | null;\n}\n\n/** @oneof */\nexport interface DomainEventBodyOneOf {\n  createdEvent?: EntityCreatedEvent;\n  updatedEvent?: EntityUpdatedEvent;\n  deletedEvent?: EntityDeletedEvent;\n  actionEvent?: ActionEvent;\n}\n\nexport interface EntityCreatedEvent {\n  entity?: string;\n}\n\nexport interface RestoreInfo {\n  deletedDate?: Date | null;\n}\n\nexport interface EntityUpdatedEvent {\n  /**\n   * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n   * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n   * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n   */\n  currentEntity?: string;\n}\n\nexport interface EntityDeletedEvent {\n  /** Entity that was deleted. */\n  deletedEntity?: string | null;\n}\n\nexport interface ActionEvent {\n  body?: string;\n}\n\nexport interface MessageEnvelope {\n  /**\n   * App instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n  /**\n   * Event type.\n   * @maxLength 150\n   */\n  eventType?: string;\n  /** The identification type and identity data. */\n  identity?: IdentificationData;\n  /** Stringify payload. */\n  data?: string;\n  /** Details related to the account */\n  accountInfo?: AccountInfo;\n}\n\nexport interface IdentificationData extends IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n  /** @readonly */\n  identityType?: WebhookIdentityTypeWithLiterals;\n}\n\n/** @oneof */\nexport interface IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n}\n\nexport enum WebhookIdentityType {\n  UNKNOWN = 'UNKNOWN',\n  ANONYMOUS_VISITOR = 'ANONYMOUS_VISITOR',\n  MEMBER = 'MEMBER',\n  WIX_USER = 'WIX_USER',\n  APP = 'APP',\n}\n\n/** @enumType */\nexport type WebhookIdentityTypeWithLiterals =\n  | WebhookIdentityType\n  | 'UNKNOWN'\n  | 'ANONYMOUS_VISITOR'\n  | 'MEMBER'\n  | 'WIX_USER'\n  | 'APP';\n\nexport interface AccountInfo {\n  /**\n   * ID of the Wix account associated with the event.\n   * @format GUID\n   */\n  accountId?: string | null;\n  /**\n   * ID of the parent Wix account. Only included when accountId belongs to a child account.\n   * @format GUID\n   */\n  parentAccountId?: string | null;\n  /**\n   * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.\n   * @format GUID\n   */\n  siteId?: string | null;\n}\n\n/**\n * Retrieves a list of up to 1,000 pool items, given the provided paging, filtering, and sorting.\n *\n * Returns only active pool items — soft-deleted pool items are automatically excluded from the response.\n *\n * When called by a logged-in member without an explicit `beneficiary.memberId` filter, the response is automatically scoped to the calling member. App callers must include a `beneficiary.memberId` filter to scope the response to a specific beneficiary.\n *\n * Query Pool Items runs with these defaults, which you can override:\n *\n * - `createdDate` is sorted in `DESC` order\n * - `cursorPaging.limit` is `50`\n *\n * To learn about working with Query methods, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language), [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging), and [Field Projection](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-field-projection).\n *\n * For a detailed list of supported filters, see [Pool Items: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/item-v1/filtering-and-sorting).\n * @public\n * @documentationMaturity preview\n * @permissionId benefit_programs:v1:pool_item:query_pool_items\n * @permissionId BENEFIT_PROGRAMS.POOL_READ\n * @applicableIdentity APP\n * @fqn wix.benefit_programs.v1.pool_item.PoolItemService.QueryPoolItems\n */\nexport function queryPoolItems(\n  options?: QueryPoolItemsOptions\n): PoolItemsQueryBuilder {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[1] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  return queryBuilder<\n    PoolItem,\n    'CURSOR',\n    QueryPoolItemsRequest,\n    QueryPoolItemsResponse\n  >({\n    func: async (payload: QueryPoolItemsRequest) => {\n      const reqOpts = ambassadorWixBenefitProgramsV1PoolItem.queryPoolItems({\n        ...payload,\n        ...(options ?? {}),\n      });\n\n      sideEffects?.onSiteCall?.();\n      try {\n        const result = await httpClient.request(reqOpts);\n        sideEffects?.onSuccess?.(result);\n        return result;\n      } catch (err) {\n        sideEffects?.onError?.(err);\n        throw err;\n      }\n    },\n    requestTransformer: (query: QueryPoolItemsRequest['query']) => {\n      const args = [query, options] as [\n        QueryPoolItemsRequest['query'],\n        QueryPoolItemsOptions\n      ];\n      return renameKeysFromSDKRequestToRESTRequest({\n        ...args?.[1],\n        query: args?.[0],\n      });\n    },\n    responseTransformer: ({ data }: HttpResponse<QueryPoolItemsResponse>) => {\n      const transformedData = renameKeysFromRESTResponseToSDKResponse(\n        transformPaths(data, [])\n      );\n\n      return {\n        items: transformedData?.poolItems,\n        pagingMetadata: transformedData?.metadata,\n      };\n    },\n    errorTransformer: (err: unknown) => {\n      const transformedError = sdkTransformError(err, {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: { query: '$[0]' },\n        singleArgumentUnchanged: false,\n      });\n\n      throw transformedError;\n    },\n    pagingMethod: 'CURSOR',\n    transformationPaths: {},\n  });\n}\n\nexport interface QueryPoolItemsOptions {\n  /**\n   * Optional enrichments to include in the response.\n   * @maxSize 5\n   */\n  fields?: RequestedFieldsWithLiterals[] | undefined;\n}\n\ninterface QueryCursorResult {\n  cursors: Cursors;\n  hasNext: () => boolean;\n  hasPrev: () => boolean;\n  length: number;\n  pageSize: number;\n}\n\nexport interface PoolItemsQueryResult extends QueryCursorResult {\n  items: PoolItem[];\n  query: PoolItemsQueryBuilder;\n  next: () => Promise<PoolItemsQueryResult>;\n  prev: () => Promise<PoolItemsQueryResult>;\n}\n\nexport interface PoolItemsQueryBuilder {\n  /** @param propertyName - Property whose value is compared with `value`.\n   * @param value - Value to compare against.\n   * @documentationMaturity preview\n   */\n  eq: (\n    propertyName:\n      | '_id'\n      | '_createdDate'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey',\n    value: any\n  ) => PoolItemsQueryBuilder;\n  /** @param propertyName - Property whose value is compared with `value`.\n   * @param value - Value to compare against.\n   * @documentationMaturity preview\n   */\n  ne: (\n    propertyName:\n      | '_id'\n      | '_createdDate'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey',\n    value: any\n  ) => PoolItemsQueryBuilder;\n  /** @param propertyName - Property whose value is compared with `value`.\n   * @param value - Value to compare against.\n   * @documentationMaturity preview\n   */\n  ge: (\n    propertyName:\n      | '_id'\n      | '_createdDate'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey',\n    value: any\n  ) => PoolItemsQueryBuilder;\n  /** @param propertyName - Property whose value is compared with `value`.\n   * @param value - Value to compare against.\n   * @documentationMaturity preview\n   */\n  gt: (\n    propertyName:\n      | '_id'\n      | '_createdDate'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey',\n    value: any\n  ) => PoolItemsQueryBuilder;\n  /** @param propertyName - Property whose value is compared with `value`.\n   * @param value - Value to compare against.\n   * @documentationMaturity preview\n   */\n  le: (\n    propertyName:\n      | '_id'\n      | '_createdDate'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey',\n    value: any\n  ) => PoolItemsQueryBuilder;\n  /** @param propertyName - Property whose value is compared with `value`.\n   * @param value - Value to compare against.\n   * @documentationMaturity preview\n   */\n  lt: (\n    propertyName:\n      | '_id'\n      | '_createdDate'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey',\n    value: any\n  ) => PoolItemsQueryBuilder;\n  /** @param propertyName - Property whose value is compared with `string`.\n   * @param string - String to compare against. Case-insensitive.\n   * @documentationMaturity preview\n   */\n  startsWith: (\n    propertyName:\n      | '_id'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey',\n    value: string\n  ) => PoolItemsQueryBuilder;\n  /** @param propertyName - Property whose value is compared with `values`.\n   * @param values - List of values to compare against.\n   * @documentationMaturity preview\n   */\n  hasSome: (\n    propertyName:\n      | '_id'\n      | '_createdDate'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey',\n    value: any[]\n  ) => PoolItemsQueryBuilder;\n  /** @documentationMaturity preview */\n  in: (\n    propertyName:\n      | '_id'\n      | '_createdDate'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey',\n    value: any\n  ) => PoolItemsQueryBuilder;\n  /** @documentationMaturity preview */\n  exists: (\n    propertyName:\n      | '_id'\n      | '_createdDate'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey',\n    value: boolean\n  ) => PoolItemsQueryBuilder;\n  /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n   * @documentationMaturity preview\n   */\n  ascending: (\n    ...propertyNames: Array<\n      | '_id'\n      | '_createdDate'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey'\n    >\n  ) => PoolItemsQueryBuilder;\n  /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.\n   * @documentationMaturity preview\n   */\n  descending: (\n    ...propertyNames: Array<\n      | '_id'\n      | '_createdDate'\n      | 'externalId'\n      | 'category'\n      | 'providerAppId'\n      | 'namespace'\n      | 'poolId'\n      | 'programId'\n      | 'externalProgramId'\n      | 'programDefinitionId'\n      | 'externalProgramDefinitionId'\n      | 'poolDefinitionId'\n      | 'itemSetId'\n      | 'beneficiary.memberId'\n      | 'program.id'\n      | 'programDefinition.id'\n      | 'benefitKey'\n      | 'itemReferenceSearchKey'\n    >\n  ) => PoolItemsQueryBuilder;\n  /** @param limit - Number of items to return, which is also the `pageSize` of the results object.\n   * @documentationMaturity preview\n   */\n  limit: (limit: number) => PoolItemsQueryBuilder;\n  /** @param cursor - A pointer to specific record\n   * @documentationMaturity preview\n   */\n  skipTo: (cursor: string) => PoolItemsQueryBuilder;\n  /** @documentationMaturity preview */\n  find: () => Promise<PoolItemsQueryResult>;\n}\n\n/**\n * @hidden\n * @fqn wix.benefit_programs.v1.pool_item.PoolItemService.QueryPoolItems\n * @requiredField query\n */\nexport async function typedQueryPoolItems(\n  query: PoolItemQuery,\n  options?: QueryPoolItemsOptions\n): Promise<\n  NonNullablePaths<\n    QueryPoolItemsResponse,\n    | `poolItems`\n    | `poolItems.${number}._id`\n    | `poolItems.${number}.externalId`\n    | `poolItems.${number}.category`\n    | `poolItems.${number}.providerAppId`\n    | `poolItems.${number}.namespace`\n    | `poolItems.${number}.poolId`\n    | `poolItems.${number}.itemSetId`\n    | `poolItems.${number}.beneficiary.anonymousVisitorId`\n    | `poolItems.${number}.beneficiary.memberId`\n    | `poolItems.${number}.beneficiary.wixUserId`\n    | `poolItems.${number}.pool.displayName`\n    | `poolItems.${number}.program._id`\n    | `poolItems.${number}.programDefinition._id`\n    | `poolItems.${number}.itemId`\n    | `poolItems.${number}.benefitInfo.benefitKey`\n    | `poolItems.${number}.benefitKey`\n    | `poolItems.${number}.itemReferenceSearchKey`,\n    5\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[2] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    query: query,\n    ...options,\n  });\n\n  const reqOpts =\n    ambassadorWixBenefitProgramsV1PoolItem.queryPoolItems(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: { query: '$[0]' },\n        singleArgumentUnchanged: false,\n      },\n      ['query', 'options']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\nexport interface PoolItemQuerySpec extends QuerySpec {\n  paging: 'cursor';\n  wql: [\n    {\n      fields: [\n        '_createdDate',\n        '_id',\n        'beneficiary.memberId',\n        'benefitKey',\n        'category',\n        'externalId',\n        'externalProgramDefinitionId',\n        'externalProgramId',\n        'itemReferenceSearchKey',\n        'itemSetId',\n        'namespace',\n        'poolDefinitionId',\n        'poolId',\n        'programDefinitionId',\n        'programId',\n        'providerAppId'\n      ];\n      operators: '*';\n      sort: 'BOTH';\n    }\n  ];\n}\n\nexport type CommonQueryWithEntityContext = QuerySdkType<\n  PoolItem,\n  PoolItemQuerySpec\n>;\nexport type PoolItemQuery = {\n  /** \n  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`.  \n  */\n  cursorPaging?: {\n    /** \n  Maximum number of items to return in the results. \n  @max: 1000 \n  */\n    limit?:\n      | NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit']\n      | null;\n    /** \n  Pointer to the next or previous page in the list of results.\n\n  Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n  Not relevant for the first request. \n  @maxLength: 16000 \n  */\n    cursor?:\n      | NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor']\n      | null;\n  };\n  /** \n  Filter object in the following format:\n  `\"filter\" : {\n  \"fieldName1\": \"value1\",\n  \"fieldName2\":{\"$operator\":\"value2\"}\n  }`\n  Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`  \n  */\n  filter?: CommonQueryWithEntityContext['filter'] | null;\n  /** \n  Sort object in the following format:\n  `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]` \n  @maxSize: 5 \n  */\n  sort?: {\n    /** \n  Name of the field to sort by. \n  @maxLength: 512 \n  */\n    fieldName?: NonNullable<\n      CommonQueryWithEntityContext['sort']\n    >[number]['fieldName'];\n    /** \n  Sort order.  \n  */\n    order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];\n  }[];\n};\n\nexport const utils = {\n  query: {\n    ...createQueryUtils<PoolItem, PoolItemQuerySpec, PoolItemQuery>(),\n  },\n};\n","import { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixBenefitProgramsV1PoolItemPoolItemServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    _: [\n      {\n        srcPath: '/_api/benefit-programs/v1/pool-items',\n        destPath: '/v1/pool-items',\n      },\n    ],\n    'www.wixapis.com': [\n      {\n        srcPath: '/benefit-programs/v1/pool-items',\n        destPath: '/v1/pool-items',\n      },\n    ],\n    '*.dev.wix-code.com': [\n      {\n        srcPath: '/_api/benefit-programs/v1/pool-items',\n        destPath: '/v1/pool-items',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_benefit-programs_pool-items';\n\n/**\n * Retrieves a list of up to 1,000 pool items, given the provided paging, filtering, and sorting.\n *\n * Returns only active pool items — soft-deleted pool items are automatically excluded from the response.\n *\n * When called by a logged-in member without an explicit `beneficiary.memberId` filter, the response is automatically scoped to the calling member. App callers must include a `beneficiary.memberId` filter to scope the response to a specific beneficiary.\n *\n * Query Pool Items runs with these defaults, which you can override:\n *\n * - `createdDate` is sorted in `DESC` order\n * - `cursorPaging.limit` is `50`\n *\n * To learn about working with Query methods, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language), [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging), and [Field Projection](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-field-projection).\n *\n * For a detailed list of supported filters, see [Pool Items: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/item-v1/filtering-and-sorting).\n */\nexport function queryPoolItems(payload: object): RequestOptionsFactory<any> {\n  function __queryPoolItems({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.benefit_programs.v1.pool_item',\n      method: 'POST' as any,\n      methodFqn:\n        'wix.benefit_programs.v1.pool_item.PoolItemService.QueryPoolItems',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixBenefitProgramsV1PoolItemPoolItemServiceUrl({\n        protoPath: '/v1/pool-items/query',\n        data: payload,\n        host,\n      }),\n      data: payload,\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [\n              { path: 'poolItems.createdDate' },\n              { path: 'poolItems.updatedDate' },\n            ],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __queryPoolItems;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAAAA;AAAA,EAAA;AAAA;AAAA;AAAA;;;ACAA,6BAAoD;AACpD,2BAA6B;AAC7B,oCAGO;;;ACLP,uBAAqD;AACrD,6BAA+B;AAC/B,0BAA2B;AAI3B,SAAS,sDACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,GAAG;AAAA,MACD;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,sBAAsB;AAAA,MACpB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,gCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAkBd,SAAS,eAAe,SAA6C;AAC1E,WAAS,iBAAiB,EAAE,KAAK,GAAQ;AACvC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,sDAAsD;AAAA,QACzD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,MACN,mBAAmB,CAACC,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,YACL,EAAE,MAAM,wBAAwB;AAAA,YAChC,EAAE,MAAM,wBAAwB;AAAA,UAClC;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADrEA,IAAAC,0BAA+B;AAC/B,iCAAiC;AAkN1B,IAAK,eAAL,kBAAKC,kBAAL;AAEL,EAAAA,cAAA,aAAU;AAEV,EAAAA,cAAA,uBAAoB;AAEpB,EAAAA,cAAA,YAAS;AAET,EAAAA,cAAA,cAAW;AARD,SAAAA;AAAA,GAAA;AAyKL,IAAK,YAAL,kBAAKC,eAAL;AACL,EAAAA,WAAA,SAAM;AACN,EAAAA,WAAA,UAAO;AAFG,SAAAA;AAAA,GAAA;AAwBL,IAAK,kBAAL,kBAAKC,qBAAL;AAEL,EAAAA,iBAAA,UAAO;AAEP,EAAAA,iBAAA,aAAU;AAEV,EAAAA,iBAAA,wBAAqB;AAErB,EAAAA,iBAAA,UAAO;AAEP,EAAAA,iBAAA,aAAU;AAVA,SAAAA;AAAA,GAAA;AAiNL,IAAK,sBAAL,kBAAKC,yBAAL;AACL,EAAAA,qBAAA,aAAU;AACV,EAAAA,qBAAA,uBAAoB;AACpB,EAAAA,qBAAA,YAAS;AACT,EAAAA,qBAAA,cAAW;AACX,EAAAA,qBAAA,SAAM;AALI,SAAAA;AAAA,GAAA;AAyDL,SAASC,gBACd,SACuB;AAEvB,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,aAAO,mCAKL;AAAA,IACA,MAAM,OAAO,YAAmC;AAC9C,YAAM,UAAiD,eAAe;AAAA,QACpE,GAAG;AAAA,QACH,GAAI,WAAW,CAAC;AAAA,MAClB,CAAC;AAED,mBAAa,aAAa;AAC1B,UAAI;AACF,cAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,qBAAa,YAAY,MAAM;AAC/B,eAAO;AAAA,MACT,SAAS,KAAK;AACZ,qBAAa,UAAU,GAAG;AAC1B,cAAM;AAAA,MACR;AAAA,IACF;AAAA,IACA,oBAAoB,CAAC,UAA0C;AAC7D,YAAM,OAAO,CAAC,OAAO,OAAO;AAI5B,iBAAO,qEAAsC;AAAA,QAC3C,GAAG,OAAO,CAAC;AAAA,QACX,OAAO,OAAO,CAAC;AAAA,MACjB,CAAC;AAAA,IACH;AAAA,IACA,qBAAqB,CAAC,EAAE,KAAK,MAA4C;AACvE,YAAM,sBAAkB;AAAA,YACtB,wCAAe,MAAM,CAAC,CAAC;AAAA,MACzB;AAEA,aAAO;AAAA,QACL,OAAO,iBAAiB;AAAA,QACxB,gBAAgB,iBAAiB;AAAA,MACnC;AAAA,IACF;AAAA,IACA,kBAAkB,CAAC,QAAiB;AAClC,YAAM,uBAAmB,uBAAAC,gBAAkB,KAAK;AAAA,QAC9C,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,OAAO,OAAO;AAAA,QAC1C,yBAAyB;AAAA,MAC3B,CAAC;AAED,YAAM;AAAA,IACR;AAAA,IACA,cAAc;AAAA,IACd,qBAAqB,CAAC;AAAA,EACxB,CAAC;AACH;AA0VA,eAAsB,oBACpB,OACA,SAwBA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC;AAAA,IACpD;AAAA,IACA,GAAG;AAAA,EACL,CAAC;AAED,QAAM,UACmC,eAAe,OAAO;AAE/D,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAA;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,OAAO,OAAO;AAAA,QAC1C,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,SAAS,SAAS;AAAA,IACrB;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AAsFO,IAAM,QAAQ;AAAA,EACnB,OAAO;AAAA,IACL,OAAG,6CAA6D;AAAA,EAClE;AACF;","names":["queryPoolItems","payload","import_transform_paths","IdentityType","SortOrder","RequestedFields","WebhookIdentityType","queryPoolItems","sdkTransformError"]}