@wix/auto_sdk_benefit-programs_pool-items 1.0.2 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +17 -17
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +2 -2
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.d.ts +1 -1
- package/build/cjs/schemas.js +2 -2
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +17 -17
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +2 -2
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.d.mts +1 -1
- package/build/es/schemas.mjs +2 -2
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +17 -17
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +2 -2
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.d.ts +1 -1
- package/build/internal/cjs/schemas.js +2 -2
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +17 -17
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +2 -2
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.d.mts +1 -1
- package/build/internal/es/schemas.mjs +2 -2
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -1 +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\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"]}
|
|
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\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 itemSearchKey?: 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 400\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/pool-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 | 'itemSearchKey',\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 | 'itemSearchKey',\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 | 'itemSearchKey',\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 | 'itemSearchKey',\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 | 'itemSearchKey',\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 | 'itemSearchKey',\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 | 'itemSearchKey',\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 | 'itemSearchKey',\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 | 'itemSearchKey',\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 | 'itemSearchKey',\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 | 'itemSearchKey'\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 | 'itemSearchKey'\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}.itemSearchKey`,\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 'itemSearchKey',\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/pool-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"]}
|
package/build/cjs/meta.d.ts
CHANGED
|
@@ -168,7 +168,7 @@ interface PoolItem {
|
|
|
168
168
|
* @immutable
|
|
169
169
|
* @readonly
|
|
170
170
|
*/
|
|
171
|
-
|
|
171
|
+
itemSearchKey?: string;
|
|
172
172
|
}
|
|
173
173
|
interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
|
|
174
174
|
/**
|
|
@@ -275,7 +275,7 @@ interface ProgramDefinitionInfo {
|
|
|
275
275
|
interface ItemInfo {
|
|
276
276
|
/**
|
|
277
277
|
* Item's display name.
|
|
278
|
-
* @maxLength
|
|
278
|
+
* @maxLength 400
|
|
279
279
|
*/
|
|
280
280
|
displayName?: string | null;
|
|
281
281
|
}
|
package/build/cjs/meta.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../meta.ts","../../src/benefit-programs-v1-pool-item-pool-items.http.ts","../../src/benefit-programs-v1-pool-item-pool-items.types.ts","../../src/benefit-programs-v1-pool-item-pool-items.meta.ts"],"sourcesContent":["export * from './src/benefit-programs-v1-pool-item-pool-items.meta.js';\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","/**\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 entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\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 currentEntityAsJson?: string;\n}\n\nexport interface EntityDeletedEvent {\n /** Entity that was deleted. */\n deletedEntityAsJson?: string | null;\n}\n\nexport interface ActionEvent {\n bodyAsJson?: 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","import * as ambassadorWixBenefitProgramsV1PoolItem from './benefit-programs-v1-pool-item-pool-items.http.js';\nimport * as ambassadorWixBenefitProgramsV1PoolItemTypes from './benefit-programs-v1-pool-item-pool-items.types.js';\nimport * as ambassadorWixBenefitProgramsV1PoolItemUniversalTypes from './benefit-programs-v1-pool-item-pool-items.universal.js';\n\nexport type __PublicMethodMetaInfo<\n K = string,\n M = unknown,\n T = unknown,\n S = unknown,\n Q = unknown,\n R = unknown\n> = {\n getUrl: (context: any) => string;\n httpMethod: K;\n path: string;\n pathParams: M;\n __requestType: T;\n __originalRequestType: S;\n __responseType: Q;\n __originalResponseType: R;\n};\n\nexport function queryPoolItems(): __PublicMethodMetaInfo<\n 'POST',\n {},\n ambassadorWixBenefitProgramsV1PoolItemUniversalTypes.QueryPoolItemsRequest,\n ambassadorWixBenefitProgramsV1PoolItemTypes.QueryPoolItemsRequest,\n ambassadorWixBenefitProgramsV1PoolItemUniversalTypes.QueryPoolItemsResponse,\n ambassadorWixBenefitProgramsV1PoolItemTypes.QueryPoolItemsResponse\n> {\n const payload = {} as any;\n\n const getRequestOptions =\n ambassadorWixBenefitProgramsV1PoolItem.queryPoolItems(payload);\n\n const getUrl = (context: any): string => {\n const { url } = getRequestOptions(context);\n return url!;\n };\n\n return {\n getUrl,\n httpMethod: 'POST',\n path: '/v1/pool-items/query',\n pathParams: {},\n __requestType: null as any,\n __originalRequestType: null as any,\n __responseType: null as any,\n __originalResponseType: null as any,\n };\n}\n\nexport {\n PoolItem as PoolItemOriginal,\n CommonIdentificationData as CommonIdentificationDataOriginal,\n CommonIdentificationDataIdOneOf as CommonIdentificationDataIdOneOfOriginal,\n IdentityType as IdentityTypeOriginal,\n IdentityTypeWithLiterals as IdentityTypeWithLiteralsOriginal,\n PoolInfo as PoolInfoOriginal,\n ProgramInfo as ProgramInfoOriginal,\n ProgramDefinitionInfo as ProgramDefinitionInfoOriginal,\n ItemInfo as ItemInfoOriginal,\n BenefitInfo as BenefitInfoOriginal,\n PoolItemDeactivated as PoolItemDeactivatedOriginal,\n PoolItemRemoved as PoolItemRemovedOriginal,\n QueryPoolItemsRequest as QueryPoolItemsRequestOriginal,\n CursorQuery as CursorQueryOriginal,\n CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal,\n Sorting as SortingOriginal,\n SortOrder as SortOrderOriginal,\n SortOrderWithLiterals as SortOrderWithLiteralsOriginal,\n CursorPaging as CursorPagingOriginal,\n RequestedFields as RequestedFieldsOriginal,\n RequestedFieldsWithLiterals as RequestedFieldsWithLiteralsOriginal,\n QueryPoolItemsResponse as QueryPoolItemsResponseOriginal,\n CursorPagingMetadata as CursorPagingMetadataOriginal,\n Cursors as CursorsOriginal,\n InvalidatePoolItemsRequest as InvalidatePoolItemsRequestOriginal,\n InvalidatePoolItemsResponse as InvalidatePoolItemsResponseOriginal,\n DomainEvent as DomainEventOriginal,\n DomainEventBodyOneOf as DomainEventBodyOneOfOriginal,\n EntityCreatedEvent as EntityCreatedEventOriginal,\n RestoreInfo as RestoreInfoOriginal,\n EntityUpdatedEvent as EntityUpdatedEventOriginal,\n EntityDeletedEvent as EntityDeletedEventOriginal,\n ActionEvent as ActionEventOriginal,\n MessageEnvelope as MessageEnvelopeOriginal,\n IdentificationData as IdentificationDataOriginal,\n IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal,\n WebhookIdentityType as WebhookIdentityTypeOriginal,\n WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal,\n AccountInfo as AccountInfoOriginal,\n} from './benefit-programs-v1-pool-item-pool-items.types.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAAAA;AAAA;AAAA;;;ACAA,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;;;AC4HO,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;AAmNL,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;;;AC9kBL,SAASC,kBAOd;AACA,QAAM,UAAU,CAAC;AAEjB,QAAM,oBACmC,eAAe,OAAO;AAE/D,QAAM,SAAS,CAAC,YAAyB;AACvC,UAAM,EAAE,IAAI,IAAI,kBAAkB,OAAO;AACzC,WAAO;AAAA,EACT;AAEA,SAAO;AAAA,IACL;AAAA,IACA,YAAY;AAAA,IACZ,MAAM;AAAA,IACN,YAAY,CAAC;AAAA,IACb,eAAe;AAAA,IACf,uBAAuB;AAAA,IACvB,gBAAgB;AAAA,IAChB,wBAAwB;AAAA,EAC1B;AACF;","names":["queryPoolItems","payload","IdentityType","SortOrder","RequestedFields","WebhookIdentityType","queryPoolItems"]}
|
|
1
|
+
{"version":3,"sources":["../../meta.ts","../../src/benefit-programs-v1-pool-item-pool-items.http.ts","../../src/benefit-programs-v1-pool-item-pool-items.types.ts","../../src/benefit-programs-v1-pool-item-pool-items.meta.ts"],"sourcesContent":["export * from './src/benefit-programs-v1-pool-item-pool-items.meta.js';\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/pool-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","/**\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 itemSearchKey?: 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 400\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 entityAsJson?: string;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\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 currentEntityAsJson?: string;\n}\n\nexport interface EntityDeletedEvent {\n /** Entity that was deleted. */\n deletedEntityAsJson?: string | null;\n}\n\nexport interface ActionEvent {\n bodyAsJson?: 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","import * as ambassadorWixBenefitProgramsV1PoolItem from './benefit-programs-v1-pool-item-pool-items.http.js';\nimport * as ambassadorWixBenefitProgramsV1PoolItemTypes from './benefit-programs-v1-pool-item-pool-items.types.js';\nimport * as ambassadorWixBenefitProgramsV1PoolItemUniversalTypes from './benefit-programs-v1-pool-item-pool-items.universal.js';\n\nexport type __PublicMethodMetaInfo<\n K = string,\n M = unknown,\n T = unknown,\n S = unknown,\n Q = unknown,\n R = unknown\n> = {\n getUrl: (context: any) => string;\n httpMethod: K;\n path: string;\n pathParams: M;\n __requestType: T;\n __originalRequestType: S;\n __responseType: Q;\n __originalResponseType: R;\n};\n\nexport function queryPoolItems(): __PublicMethodMetaInfo<\n 'POST',\n {},\n ambassadorWixBenefitProgramsV1PoolItemUniversalTypes.QueryPoolItemsRequest,\n ambassadorWixBenefitProgramsV1PoolItemTypes.QueryPoolItemsRequest,\n ambassadorWixBenefitProgramsV1PoolItemUniversalTypes.QueryPoolItemsResponse,\n ambassadorWixBenefitProgramsV1PoolItemTypes.QueryPoolItemsResponse\n> {\n const payload = {} as any;\n\n const getRequestOptions =\n ambassadorWixBenefitProgramsV1PoolItem.queryPoolItems(payload);\n\n const getUrl = (context: any): string => {\n const { url } = getRequestOptions(context);\n return url!;\n };\n\n return {\n getUrl,\n httpMethod: 'POST',\n path: '/v1/pool-items/query',\n pathParams: {},\n __requestType: null as any,\n __originalRequestType: null as any,\n __responseType: null as any,\n __originalResponseType: null as any,\n };\n}\n\nexport {\n PoolItem as PoolItemOriginal,\n CommonIdentificationData as CommonIdentificationDataOriginal,\n CommonIdentificationDataIdOneOf as CommonIdentificationDataIdOneOfOriginal,\n IdentityType as IdentityTypeOriginal,\n IdentityTypeWithLiterals as IdentityTypeWithLiteralsOriginal,\n PoolInfo as PoolInfoOriginal,\n ProgramInfo as ProgramInfoOriginal,\n ProgramDefinitionInfo as ProgramDefinitionInfoOriginal,\n ItemInfo as ItemInfoOriginal,\n BenefitInfo as BenefitInfoOriginal,\n PoolItemDeactivated as PoolItemDeactivatedOriginal,\n PoolItemRemoved as PoolItemRemovedOriginal,\n QueryPoolItemsRequest as QueryPoolItemsRequestOriginal,\n CursorQuery as CursorQueryOriginal,\n CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal,\n Sorting as SortingOriginal,\n SortOrder as SortOrderOriginal,\n SortOrderWithLiterals as SortOrderWithLiteralsOriginal,\n CursorPaging as CursorPagingOriginal,\n RequestedFields as RequestedFieldsOriginal,\n RequestedFieldsWithLiterals as RequestedFieldsWithLiteralsOriginal,\n QueryPoolItemsResponse as QueryPoolItemsResponseOriginal,\n CursorPagingMetadata as CursorPagingMetadataOriginal,\n Cursors as CursorsOriginal,\n InvalidatePoolItemsRequest as InvalidatePoolItemsRequestOriginal,\n InvalidatePoolItemsResponse as InvalidatePoolItemsResponseOriginal,\n DomainEvent as DomainEventOriginal,\n DomainEventBodyOneOf as DomainEventBodyOneOfOriginal,\n EntityCreatedEvent as EntityCreatedEventOriginal,\n RestoreInfo as RestoreInfoOriginal,\n EntityUpdatedEvent as EntityUpdatedEventOriginal,\n EntityDeletedEvent as EntityDeletedEventOriginal,\n ActionEvent as ActionEventOriginal,\n MessageEnvelope as MessageEnvelopeOriginal,\n IdentificationData as IdentificationDataOriginal,\n IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal,\n WebhookIdentityType as WebhookIdentityTypeOriginal,\n WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal,\n AccountInfo as AccountInfoOriginal,\n} from './benefit-programs-v1-pool-item-pool-items.types.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAAAA;AAAA;AAAA;;;ACAA,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;;;AC4HO,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;AAmNL,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;;;AC9kBL,SAASC,kBAOd;AACA,QAAM,UAAU,CAAC;AAEjB,QAAM,oBACmC,eAAe,OAAO;AAE/D,QAAM,SAAS,CAAC,YAAyB;AACvC,UAAM,EAAE,IAAI,IAAI,kBAAkB,OAAO;AACzC,WAAO;AAAA,EACT;AAEA,SAAO;AAAA,IACL;AAAA,IACA,YAAY;AAAA,IACZ,MAAM;AAAA,IACN,YAAY,CAAC;AAAA,IACb,eAAe;AAAA,IACf,uBAAuB;AAAA,IACvB,gBAAgB;AAAA,IAChB,wBAAwB;AAAA,EAC1B;AACF;","names":["queryPoolItems","payload","IdentityType","SortOrder","RequestedFields","WebhookIdentityType","queryPoolItems"]}
|
package/build/cjs/schemas.d.ts
CHANGED
|
@@ -88,7 +88,7 @@ declare const QueryPoolItemsResponse: z.ZodObject<{
|
|
|
88
88
|
description: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
89
89
|
}, z.core.$strip>>;
|
|
90
90
|
benefitKey: z.ZodOptional<z.ZodString>;
|
|
91
|
-
|
|
91
|
+
itemSearchKey: z.ZodOptional<z.ZodString>;
|
|
92
92
|
}, z.core.$strip>>>;
|
|
93
93
|
metadata: z.ZodOptional<z.ZodObject<{
|
|
94
94
|
count: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
package/build/cjs/schemas.js
CHANGED
|
@@ -220,7 +220,7 @@ var QueryPoolItemsResponse = z.object({
|
|
|
220
220
|
"Must be a valid GUID"
|
|
221
221
|
).optional(),
|
|
222
222
|
itemInfo: z.object({
|
|
223
|
-
displayName: z.string().describe("Item's display name.").max(
|
|
223
|
+
displayName: z.string().describe("Item's display name.").max(400).optional().nullable()
|
|
224
224
|
}).describe(
|
|
225
225
|
"Display name for the catalog item.\n\nReturned only when `ITEM` is included in the `fields` request parameter."
|
|
226
226
|
).optional(),
|
|
@@ -239,7 +239,7 @@ var QueryPoolItemsResponse = z.object({
|
|
|
239
239
|
benefitKey: z.string().describe(
|
|
240
240
|
"Unique identifier for the benefit that grants access to this item."
|
|
241
241
|
).max(64).optional(),
|
|
242
|
-
|
|
242
|
+
itemSearchKey: z.string().describe(
|
|
243
243
|
"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."
|
|
244
244
|
).max(94).optional()
|
|
245
245
|
})
|
package/build/cjs/schemas.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../schemas.ts","../../src/benefit-programs-v1-pool-item-pool-items.schemas.ts"],"sourcesContent":["export * from './src/benefit-programs-v1-pool-item-pool-items.schemas.js';\n","import * as z from 'zod';\n\nexport const QueryPoolItemsRequest = z.object({\n query: z\n .intersection(\n z.object({\n filter: z\n .record(z.string(), z.any())\n .describe(\n 'Filter object in the following format:\\n`\"filter\" : {\\n\"fieldName1\": \"value1\",\\n\"fieldName2\":{\"$operator\":\"value2\"}\\n}`\\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`'\n )\n .optional()\n .nullable(),\n sort: z\n .array(\n z.object({\n fieldName: z\n .string()\n .describe('Name of the field to sort by.')\n .max(512)\n .optional(),\n order: z.enum(['ASC', 'DESC']).optional(),\n })\n )\n .max(5)\n .optional(),\n }),\n z.xor([\n z.object({ cursorPaging: z.never().optional() }),\n z.object({\n cursorPaging: z\n .object({\n limit: z\n .number()\n .int()\n .describe('Maximum number of items to return in the results.')\n .min(0)\n .max(1000)\n .optional()\n .nullable(),\n cursor: z\n .string()\n .describe(\n \"Pointer to the next or previous page in the list of results.\\n\\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\\nNot relevant for the first request.\"\n )\n .max(16000)\n .optional()\n .nullable(),\n })\n .describe(\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 }),\n ])\n )\n .describe('Query options.'),\n options: z\n .object({\n fields: z\n .array(\n z.enum(['POOL', 'PROGRAM', 'PROGRAM_DEFINITION', 'ITEM', 'BENEFIT'])\n )\n .max(5)\n .optional(),\n })\n .optional(),\n});\nexport const QueryPoolItemsResponse = z.object({\n poolItems: z\n .array(\n z.object({\n _id: z\n .string()\n .describe(\n 'Pool item ID. Generated deterministically from `poolId` and `itemId`.'\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n revision: z\n .string()\n .regex(/^-?\\d+$/, 'Must be a valid Int64 string')\n .describe(\n 'Revision number, which increments by 1 each time the pool item is updated.'\n )\n .optional()\n .nullable(),\n _createdDate: z\n .date()\n .describe('Date and time the pool item was created.')\n .optional()\n .nullable(),\n _updatedDate: z\n .date()\n .describe('Date and time the pool item was updated.')\n .optional()\n .nullable(),\n externalId: z\n .string()\n .describe(\n \"External item ID assigned by the provider of the items.\\n\\nFor example, if the items are products, this ID corresponds to the specific product ID in the provider's system.\"\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n category: z\n .string()\n .describe(\n 'Item category. Groups benefit items together for organization and management. For example, `classes`, `posts`, or `groups`.'\n )\n .max(20)\n .optional(),\n providerAppId: z\n .string()\n .describe(\n \"ID of the application that provides the benefit items. Each item's `externalId` is unique within its provider application.\"\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n namespace: z\n .string()\n .describe(\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 )\n .min(1)\n .max(20)\n .optional(),\n poolId: z\n .string()\n .describe(\n 'ID of the pool that contains this item. A pool is the runtime container of benefits and items provisioned for a beneficiary.'\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n programId: z\n .string()\n .describe(\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 )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n externalProgramId: z\n .string()\n .describe('External program ID assigned by the provider.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n programDefinitionId: z\n .string()\n .describe(\n \"ID of the program definition that's the template for this pool item's program.\"\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n externalProgramDefinitionId: z\n .string()\n .describe('External program definition ID assigned by the provider.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n poolDefinitionId: z\n .string()\n .describe(\n \"ID of the pool definition that's the template for this pool item's pool.\"\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n itemSetId: z\n .string()\n .describe(\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 )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n beneficiary: z\n .intersection(\n z.object({}),\n z.xor([\n z.object({\n anonymousVisitorId: z.never().optional(),\n memberId: z.never().optional(),\n wixUserId: z.never().optional(),\n }),\n z.object({\n memberId: z.never().optional(),\n wixUserId: z.never().optional(),\n anonymousVisitorId: z\n .string()\n .describe(\n \"ID of a site visitor that hasn't logged in to the site.\"\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n ),\n }),\n z.object({\n anonymousVisitorId: z.never().optional(),\n wixUserId: z.never().optional(),\n memberId: z\n .string()\n .describe('ID of a site member.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n ),\n }),\n z.object({\n anonymousVisitorId: z.never().optional(),\n memberId: z.never().optional(),\n wixUserId: z\n .string()\n .describe('ID of a Wix user.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n ),\n }),\n ])\n )\n .describe(\n 'Beneficiary of the pool — the member, contact, or visitor who holds this pool item.'\n )\n .optional(),\n pool: z\n .object({\n displayName: z\n .string()\n .describe(\n \"Pool's display name. Often matches the name on the associated pool definition.\"\n )\n .max(64)\n .optional(),\n description: z\n .string()\n .describe('Pool description.')\n .max(450)\n .optional()\n .nullable(),\n })\n .describe(\n 'Pool details, including display name and description.\\n\\nReturned only when `POOL` is included in the `fields` request parameter.'\n )\n .optional(),\n program: z\n .object({\n _id: z\n .string()\n .describe('Program ID.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n externalId: z\n .string()\n .describe('External program ID assigned by the provider.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n displayName: z\n .string()\n .describe(\"Program's display name.\")\n .max(64)\n .optional()\n .nullable(),\n })\n .describe(\n 'Program details — `id`, `externalId`, and `displayName`.\\n\\nReturned only when `PROGRAM` is included in the `fields` request parameter.'\n )\n .optional(),\n programDefinition: z\n .object({\n _id: z\n .string()\n .describe('Program definition ID.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n externalId: z\n .string()\n .describe(\n 'External program definition ID assigned by the provider.'\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n displayName: z\n .string()\n .describe(\"Program definition's display name.\")\n .max(64)\n .optional()\n .nullable(),\n description: z\n .string()\n .describe('Program definition description.')\n .max(450)\n .optional()\n .nullable(),\n })\n .describe(\n 'Program definition that includes this item as an accessible benefit.\\n\\nReturned only when `PROGRAM_DEFINITION` is included in the `fields` request parameter.'\n )\n .optional(),\n itemId: z\n .string()\n .describe('Item ID.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n itemInfo: z\n .object({\n displayName: z\n .string()\n .describe(\"Item's display name.\")\n .max(64)\n .optional()\n .nullable(),\n })\n .describe(\n 'Display name for the catalog item.\\n\\nReturned only when `ITEM` is included in the `fields` request parameter.'\n )\n .optional(),\n benefitInfo: z\n .object({\n price: z\n .string()\n .describe(\n \"Cost of the benefit in credits. The cost is the same for all items in this benefit.\\n\\nCredits 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 )\n .optional()\n .nullable(),\n benefitKey: z\n .string()\n .describe(\n 'Unique identifier for this benefit. Same value as `poolItem.benefitKey`.'\n )\n .max(64)\n .optional(),\n displayName: z\n .string()\n .describe(\"Benefit's display name.\")\n .max(40)\n .optional()\n .nullable(),\n description: z\n .string()\n .describe('Benefit description.')\n .max(255)\n .optional()\n .nullable(),\n })\n .describe(\n 'Pricing and display information for the associated benefit, including credit price, name, and description.\\n\\nReturned only when `BENEFIT` is included in the `fields` request parameter.'\n )\n .optional(),\n benefitKey: z\n .string()\n .describe(\n 'Unique identifier for the benefit that grants access to this item.'\n )\n .max(64)\n .optional(),\n itemReferenceSearchKey: z\n .string()\n .describe(\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 )\n .max(94)\n .optional(),\n })\n )\n .optional(),\n metadata: z\n .object({\n count: z\n .number()\n .int()\n .describe('Number of items returned in the response.')\n .optional()\n .nullable(),\n cursors: z\n .object({\n next: z\n .string()\n .describe(\n 'Cursor string pointing to the next page in the list of results.'\n )\n .max(16000)\n .optional()\n .nullable(),\n prev: z\n .string()\n .describe(\n 'Cursor pointing to the previous page in the list of results.'\n )\n .max(16000)\n .optional()\n .nullable(),\n })\n .describe(\n 'Cursor strings that point to the next page, previous page, or both.'\n )\n .optional(),\n hasNext: z\n .boolean()\n .describe(\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 .optional()\n .nullable(),\n })\n .describe('Paging metadata.')\n .optional(),\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,QAAmB;AAEZ,IAAM,wBAA0B,SAAO;AAAA,EAC5C,OACG;AAAA,IACG,SAAO;AAAA,MACP,QACG,SAAS,SAAO,GAAK,MAAI,CAAC,EAC1B;AAAA,QACC;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,MACG;AAAA,QACG,SAAO;AAAA,UACP,WACG,SAAO,EACP,SAAS,+BAA+B,EACxC,IAAI,GAAG,EACP,SAAS;AAAA,UACZ,OAAS,OAAK,CAAC,OAAO,MAAM,CAAC,EAAE,SAAS;AAAA,QAC1C,CAAC;AAAA,MACH,EACC,IAAI,CAAC,EACL,SAAS;AAAA,IACd,CAAC;AAAA,IACC,MAAI;AAAA,MACF,SAAO,EAAE,cAAgB,QAAM,EAAE,SAAS,EAAE,CAAC;AAAA,MAC7C,SAAO;AAAA,QACP,cACG,SAAO;AAAA,UACN,OACG,SAAO,EACP,IAAI,EACJ,SAAS,mDAAmD,EAC5D,IAAI,CAAC,EACL,IAAI,GAAI,EACR,SAAS,EACT,SAAS;AAAA,UACZ,QACG,SAAO,EACP;AAAA,YACC;AAAA,UACF,EACC,IAAI,IAAK,EACT,SAAS,EACT,SAAS;AAAA,QACd,CAAC,EACA;AAAA,UACC;AAAA,QACF;AAAA,MACJ,CAAC;AAAA,IACH,CAAC;AAAA,EACH,EACC,SAAS,gBAAgB;AAAA,EAC5B,SACG,SAAO;AAAA,IACN,QACG;AAAA,MACG,OAAK,CAAC,QAAQ,WAAW,sBAAsB,QAAQ,SAAS,CAAC;AAAA,IACrE,EACC,IAAI,CAAC,EACL,SAAS;AAAA,EACd,CAAC,EACA,SAAS;AACd,CAAC;AACM,IAAM,yBAA2B,SAAO;AAAA,EAC7C,WACG;AAAA,IACG,SAAO;AAAA,MACP,KACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS;AAAA,MACZ,UACG,SAAO,EACP,MAAM,WAAW,8BAA8B,EAC/C;AAAA,QACC;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,cACG,OAAK,EACL,SAAS,0CAA0C,EACnD,SAAS,EACT,SAAS;AAAA,MACZ,cACG,OAAK,EACL,SAAS,0CAA0C,EACnD,SAAS,EACT,SAAS;AAAA,MACZ,YACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS;AAAA,MACZ,UACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,IAAI,EAAE,EACN,SAAS;AAAA,MACZ,eACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS;AAAA,MACZ,WACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,IAAI,CAAC,EACL,IAAI,EAAE,EACN,SAAS;AAAA,MACZ,QACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS;AAAA,MACZ,WACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,mBACG,SAAO,EACP,SAAS,+CAA+C,EACxD;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,qBACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,6BACG,SAAO,EACP,SAAS,0DAA0D,EACnE;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,kBACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,WACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS;AAAA,MACZ,aACG;AAAA,QACG,SAAO,CAAC,CAAC;AAAA,QACT,MAAI;AAAA,UACF,SAAO;AAAA,YACP,oBAAsB,QAAM,EAAE,SAAS;AAAA,YACvC,UAAY,QAAM,EAAE,SAAS;AAAA,YAC7B,WAAa,QAAM,EAAE,SAAS;AAAA,UAChC,CAAC;AAAA,UACC,SAAO;AAAA,YACP,UAAY,QAAM,EAAE,SAAS;AAAA,YAC7B,WAAa,QAAM,EAAE,SAAS;AAAA,YAC9B,oBACG,SAAO,EACP;AAAA,cACC;AAAA,YACF,EACC;AAAA,cACC;AAAA,cACA;AAAA,YACF;AAAA,UACJ,CAAC;AAAA,UACC,SAAO;AAAA,YACP,oBAAsB,QAAM,EAAE,SAAS;AAAA,YACvC,WAAa,QAAM,EAAE,SAAS;AAAA,YAC9B,UACG,SAAO,EACP,SAAS,sBAAsB,EAC/B;AAAA,cACC;AAAA,cACA;AAAA,YACF;AAAA,UACJ,CAAC;AAAA,UACC,SAAO;AAAA,YACP,oBAAsB,QAAM,EAAE,SAAS;AAAA,YACvC,UAAY,QAAM,EAAE,SAAS;AAAA,YAC7B,WACG,SAAO,EACP,SAAS,mBAAmB,EAC5B;AAAA,cACC;AAAA,cACA;AAAA,YACF;AAAA,UACJ,CAAC;AAAA,QACH,CAAC;AAAA,MACH,EACC;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,MACZ,MACG,SAAO;AAAA,QACN,aACG,SAAO,EACP;AAAA,UACC;AAAA,QACF,EACC,IAAI,EAAE,EACN,SAAS;AAAA,QACZ,aACG,SAAO,EACP,SAAS,mBAAmB,EAC5B,IAAI,GAAG,EACP,SAAS,EACT,SAAS;AAAA,MACd,CAAC,EACA;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,MACZ,SACG,SAAO;AAAA,QACN,KACG,SAAO,EACP,SAAS,aAAa,EACtB;AAAA,UACC;AAAA,UACA;AAAA,QACF,EACC,SAAS;AAAA,QACZ,YACG,SAAO,EACP,SAAS,+CAA+C,EACxD;AAAA,UACC;AAAA,UACA;AAAA,QACF,EACC,SAAS,EACT,SAAS;AAAA,QACZ,aACG,SAAO,EACP,SAAS,yBAAyB,EAClC,IAAI,EAAE,EACN,SAAS,EACT,SAAS;AAAA,MACd,CAAC,EACA;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,MACZ,mBACG,SAAO;AAAA,QACN,KACG,SAAO,EACP,SAAS,wBAAwB,EACjC;AAAA,UACC;AAAA,UACA;AAAA,QACF,EACC,SAAS;AAAA,QACZ,YACG,SAAO,EACP;AAAA,UACC;AAAA,QACF,EACC;AAAA,UACC;AAAA,UACA;AAAA,QACF,EACC,SAAS,EACT,SAAS;AAAA,QACZ,aACG,SAAO,EACP,SAAS,oCAAoC,EAC7C,IAAI,EAAE,EACN,SAAS,EACT,SAAS;AAAA,QACZ,aACG,SAAO,EACP,SAAS,iCAAiC,EAC1C,IAAI,GAAG,EACP,SAAS,EACT,SAAS;AAAA,MACd,CAAC,EACA;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,MACZ,QACG,SAAO,EACP,SAAS,UAAU,EACnB;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS;AAAA,MACZ,UACG,SAAO;AAAA,QACN,aACG,SAAO,EACP,SAAS,sBAAsB,EAC/B,IAAI,EAAE,EACN,SAAS,EACT,SAAS;AAAA,MACd,CAAC,EACA;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,MACZ,aACG,SAAO;AAAA,QACN,OACG,SAAO,EACP;AAAA,UACC;AAAA,QACF,EACC,SAAS,EACT,SAAS;AAAA,QACZ,YACG,SAAO,EACP;AAAA,UACC;AAAA,QACF,EACC,IAAI,EAAE,EACN,SAAS;AAAA,QACZ,aACG,SAAO,EACP,SAAS,yBAAyB,EAClC,IAAI,EAAE,EACN,SAAS,EACT,SAAS;AAAA,QACZ,aACG,SAAO,EACP,SAAS,sBAAsB,EAC/B,IAAI,GAAG,EACP,SAAS,EACT,SAAS;AAAA,MACd,CAAC,EACA;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,MACZ,YACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,IAAI,EAAE,EACN,SAAS;AAAA,MACZ,wBACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,IAAI,EAAE,EACN,SAAS;AAAA,IACd,CAAC;AAAA,EACH,EACC,SAAS;AAAA,EACZ,UACG,SAAO;AAAA,IACN,OACG,SAAO,EACP,IAAI,EACJ,SAAS,2CAA2C,EACpD,SAAS,EACT,SAAS;AAAA,IACZ,SACG,SAAO;AAAA,MACN,MACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,IAAI,IAAK,EACT,SAAS,EACT,SAAS;AAAA,MACZ,MACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,IAAI,IAAK,EACT,SAAS,EACT,SAAS;AAAA,IACd,CAAC,EACA;AAAA,MACC;AAAA,IACF,EACC,SAAS;AAAA,IACZ,SACG,UAAQ,EACR;AAAA,MACC;AAAA,IACF,EACC,SAAS,EACT,SAAS;AAAA,EACd,CAAC,EACA,SAAS,kBAAkB,EAC3B,SAAS;AACd,CAAC;","names":[]}
|
|
1
|
+
{"version":3,"sources":["../../schemas.ts","../../src/benefit-programs-v1-pool-item-pool-items.schemas.ts"],"sourcesContent":["export * from './src/benefit-programs-v1-pool-item-pool-items.schemas.js';\n","import * as z from 'zod';\n\nexport const QueryPoolItemsRequest = z.object({\n query: z\n .intersection(\n z.object({\n filter: z\n .record(z.string(), z.any())\n .describe(\n 'Filter object in the following format:\\n`\"filter\" : {\\n\"fieldName1\": \"value1\",\\n\"fieldName2\":{\"$operator\":\"value2\"}\\n}`\\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`'\n )\n .optional()\n .nullable(),\n sort: z\n .array(\n z.object({\n fieldName: z\n .string()\n .describe('Name of the field to sort by.')\n .max(512)\n .optional(),\n order: z.enum(['ASC', 'DESC']).optional(),\n })\n )\n .max(5)\n .optional(),\n }),\n z.xor([\n z.object({ cursorPaging: z.never().optional() }),\n z.object({\n cursorPaging: z\n .object({\n limit: z\n .number()\n .int()\n .describe('Maximum number of items to return in the results.')\n .min(0)\n .max(1000)\n .optional()\n .nullable(),\n cursor: z\n .string()\n .describe(\n \"Pointer to the next or previous page in the list of results.\\n\\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\\nNot relevant for the first request.\"\n )\n .max(16000)\n .optional()\n .nullable(),\n })\n .describe(\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 }),\n ])\n )\n .describe('Query options.'),\n options: z\n .object({\n fields: z\n .array(\n z.enum(['POOL', 'PROGRAM', 'PROGRAM_DEFINITION', 'ITEM', 'BENEFIT'])\n )\n .max(5)\n .optional(),\n })\n .optional(),\n});\nexport const QueryPoolItemsResponse = z.object({\n poolItems: z\n .array(\n z.object({\n _id: z\n .string()\n .describe(\n 'Pool item ID. Generated deterministically from `poolId` and `itemId`.'\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n revision: z\n .string()\n .regex(/^-?\\d+$/, 'Must be a valid Int64 string')\n .describe(\n 'Revision number, which increments by 1 each time the pool item is updated.'\n )\n .optional()\n .nullable(),\n _createdDate: z\n .date()\n .describe('Date and time the pool item was created.')\n .optional()\n .nullable(),\n _updatedDate: z\n .date()\n .describe('Date and time the pool item was updated.')\n .optional()\n .nullable(),\n externalId: z\n .string()\n .describe(\n \"External item ID assigned by the provider of the items.\\n\\nFor example, if the items are products, this ID corresponds to the specific product ID in the provider's system.\"\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n category: z\n .string()\n .describe(\n 'Item category. Groups benefit items together for organization and management. For example, `classes`, `posts`, or `groups`.'\n )\n .max(20)\n .optional(),\n providerAppId: z\n .string()\n .describe(\n \"ID of the application that provides the benefit items. Each item's `externalId` is unique within its provider application.\"\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n namespace: z\n .string()\n .describe(\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 )\n .min(1)\n .max(20)\n .optional(),\n poolId: z\n .string()\n .describe(\n 'ID of the pool that contains this item. A pool is the runtime container of benefits and items provisioned for a beneficiary.'\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n programId: z\n .string()\n .describe(\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 )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n externalProgramId: z\n .string()\n .describe('External program ID assigned by the provider.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n programDefinitionId: z\n .string()\n .describe(\n \"ID of the program definition that's the template for this pool item's program.\"\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n externalProgramDefinitionId: z\n .string()\n .describe('External program definition ID assigned by the provider.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n poolDefinitionId: z\n .string()\n .describe(\n \"ID of the pool definition that's the template for this pool item's pool.\"\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n itemSetId: z\n .string()\n .describe(\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 )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n beneficiary: z\n .intersection(\n z.object({}),\n z.xor([\n z.object({\n anonymousVisitorId: z.never().optional(),\n memberId: z.never().optional(),\n wixUserId: z.never().optional(),\n }),\n z.object({\n memberId: z.never().optional(),\n wixUserId: z.never().optional(),\n anonymousVisitorId: z\n .string()\n .describe(\n \"ID of a site visitor that hasn't logged in to the site.\"\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n ),\n }),\n z.object({\n anonymousVisitorId: z.never().optional(),\n wixUserId: z.never().optional(),\n memberId: z\n .string()\n .describe('ID of a site member.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n ),\n }),\n z.object({\n anonymousVisitorId: z.never().optional(),\n memberId: z.never().optional(),\n wixUserId: z\n .string()\n .describe('ID of a Wix user.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n ),\n }),\n ])\n )\n .describe(\n 'Beneficiary of the pool — the member, contact, or visitor who holds this pool item.'\n )\n .optional(),\n pool: z\n .object({\n displayName: z\n .string()\n .describe(\n \"Pool's display name. Often matches the name on the associated pool definition.\"\n )\n .max(64)\n .optional(),\n description: z\n .string()\n .describe('Pool description.')\n .max(450)\n .optional()\n .nullable(),\n })\n .describe(\n 'Pool details, including display name and description.\\n\\nReturned only when `POOL` is included in the `fields` request parameter.'\n )\n .optional(),\n program: z\n .object({\n _id: z\n .string()\n .describe('Program ID.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n externalId: z\n .string()\n .describe('External program ID assigned by the provider.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n displayName: z\n .string()\n .describe(\"Program's display name.\")\n .max(64)\n .optional()\n .nullable(),\n })\n .describe(\n 'Program details — `id`, `externalId`, and `displayName`.\\n\\nReturned only when `PROGRAM` is included in the `fields` request parameter.'\n )\n .optional(),\n programDefinition: z\n .object({\n _id: z\n .string()\n .describe('Program definition ID.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n externalId: z\n .string()\n .describe(\n 'External program definition ID assigned by the provider.'\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n displayName: z\n .string()\n .describe(\"Program definition's display name.\")\n .max(64)\n .optional()\n .nullable(),\n description: z\n .string()\n .describe('Program definition description.')\n .max(450)\n .optional()\n .nullable(),\n })\n .describe(\n 'Program definition that includes this item as an accessible benefit.\\n\\nReturned only when `PROGRAM_DEFINITION` is included in the `fields` request parameter.'\n )\n .optional(),\n itemId: z\n .string()\n .describe('Item ID.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n itemInfo: z\n .object({\n displayName: z\n .string()\n .describe(\"Item's display name.\")\n .max(400)\n .optional()\n .nullable(),\n })\n .describe(\n 'Display name for the catalog item.\\n\\nReturned only when `ITEM` is included in the `fields` request parameter.'\n )\n .optional(),\n benefitInfo: z\n .object({\n price: z\n .string()\n .describe(\n \"Cost of the benefit in credits. The cost is the same for all items in this benefit.\\n\\nCredits 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 )\n .optional()\n .nullable(),\n benefitKey: z\n .string()\n .describe(\n 'Unique identifier for this benefit. Same value as `poolItem.benefitKey`.'\n )\n .max(64)\n .optional(),\n displayName: z\n .string()\n .describe(\"Benefit's display name.\")\n .max(40)\n .optional()\n .nullable(),\n description: z\n .string()\n .describe('Benefit description.')\n .max(255)\n .optional()\n .nullable(),\n })\n .describe(\n 'Pricing and display information for the associated benefit, including credit price, name, and description.\\n\\nReturned only when `BENEFIT` is included in the `fields` request parameter.'\n )\n .optional(),\n benefitKey: z\n .string()\n .describe(\n 'Unique identifier for the benefit that grants access to this item.'\n )\n .max(64)\n .optional(),\n itemSearchKey: z\n .string()\n .describe(\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 )\n .max(94)\n .optional(),\n })\n )\n .optional(),\n metadata: z\n .object({\n count: z\n .number()\n .int()\n .describe('Number of items returned in the response.')\n .optional()\n .nullable(),\n cursors: z\n .object({\n next: z\n .string()\n .describe(\n 'Cursor string pointing to the next page in the list of results.'\n )\n .max(16000)\n .optional()\n .nullable(),\n prev: z\n .string()\n .describe(\n 'Cursor pointing to the previous page in the list of results.'\n )\n .max(16000)\n .optional()\n .nullable(),\n })\n .describe(\n 'Cursor strings that point to the next page, previous page, or both.'\n )\n .optional(),\n hasNext: z\n .boolean()\n .describe(\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 .optional()\n .nullable(),\n })\n .describe('Paging metadata.')\n .optional(),\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,QAAmB;AAEZ,IAAM,wBAA0B,SAAO;AAAA,EAC5C,OACG;AAAA,IACG,SAAO;AAAA,MACP,QACG,SAAS,SAAO,GAAK,MAAI,CAAC,EAC1B;AAAA,QACC;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,MACG;AAAA,QACG,SAAO;AAAA,UACP,WACG,SAAO,EACP,SAAS,+BAA+B,EACxC,IAAI,GAAG,EACP,SAAS;AAAA,UACZ,OAAS,OAAK,CAAC,OAAO,MAAM,CAAC,EAAE,SAAS;AAAA,QAC1C,CAAC;AAAA,MACH,EACC,IAAI,CAAC,EACL,SAAS;AAAA,IACd,CAAC;AAAA,IACC,MAAI;AAAA,MACF,SAAO,EAAE,cAAgB,QAAM,EAAE,SAAS,EAAE,CAAC;AAAA,MAC7C,SAAO;AAAA,QACP,cACG,SAAO;AAAA,UACN,OACG,SAAO,EACP,IAAI,EACJ,SAAS,mDAAmD,EAC5D,IAAI,CAAC,EACL,IAAI,GAAI,EACR,SAAS,EACT,SAAS;AAAA,UACZ,QACG,SAAO,EACP;AAAA,YACC;AAAA,UACF,EACC,IAAI,IAAK,EACT,SAAS,EACT,SAAS;AAAA,QACd,CAAC,EACA;AAAA,UACC;AAAA,QACF;AAAA,MACJ,CAAC;AAAA,IACH,CAAC;AAAA,EACH,EACC,SAAS,gBAAgB;AAAA,EAC5B,SACG,SAAO;AAAA,IACN,QACG;AAAA,MACG,OAAK,CAAC,QAAQ,WAAW,sBAAsB,QAAQ,SAAS,CAAC;AAAA,IACrE,EACC,IAAI,CAAC,EACL,SAAS;AAAA,EACd,CAAC,EACA,SAAS;AACd,CAAC;AACM,IAAM,yBAA2B,SAAO;AAAA,EAC7C,WACG;AAAA,IACG,SAAO;AAAA,MACP,KACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS;AAAA,MACZ,UACG,SAAO,EACP,MAAM,WAAW,8BAA8B,EAC/C;AAAA,QACC;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,cACG,OAAK,EACL,SAAS,0CAA0C,EACnD,SAAS,EACT,SAAS;AAAA,MACZ,cACG,OAAK,EACL,SAAS,0CAA0C,EACnD,SAAS,EACT,SAAS;AAAA,MACZ,YACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS;AAAA,MACZ,UACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,IAAI,EAAE,EACN,SAAS;AAAA,MACZ,eACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS;AAAA,MACZ,WACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,IAAI,CAAC,EACL,IAAI,EAAE,EACN,SAAS;AAAA,MACZ,QACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS;AAAA,MACZ,WACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,mBACG,SAAO,EACP,SAAS,+CAA+C,EACxD;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,qBACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,6BACG,SAAO,EACP,SAAS,0DAA0D,EACnE;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,kBACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,WACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS;AAAA,MACZ,aACG;AAAA,QACG,SAAO,CAAC,CAAC;AAAA,QACT,MAAI;AAAA,UACF,SAAO;AAAA,YACP,oBAAsB,QAAM,EAAE,SAAS;AAAA,YACvC,UAAY,QAAM,EAAE,SAAS;AAAA,YAC7B,WAAa,QAAM,EAAE,SAAS;AAAA,UAChC,CAAC;AAAA,UACC,SAAO;AAAA,YACP,UAAY,QAAM,EAAE,SAAS;AAAA,YAC7B,WAAa,QAAM,EAAE,SAAS;AAAA,YAC9B,oBACG,SAAO,EACP;AAAA,cACC;AAAA,YACF,EACC;AAAA,cACC;AAAA,cACA;AAAA,YACF;AAAA,UACJ,CAAC;AAAA,UACC,SAAO;AAAA,YACP,oBAAsB,QAAM,EAAE,SAAS;AAAA,YACvC,WAAa,QAAM,EAAE,SAAS;AAAA,YAC9B,UACG,SAAO,EACP,SAAS,sBAAsB,EAC/B;AAAA,cACC;AAAA,cACA;AAAA,YACF;AAAA,UACJ,CAAC;AAAA,UACC,SAAO;AAAA,YACP,oBAAsB,QAAM,EAAE,SAAS;AAAA,YACvC,UAAY,QAAM,EAAE,SAAS;AAAA,YAC7B,WACG,SAAO,EACP,SAAS,mBAAmB,EAC5B;AAAA,cACC;AAAA,cACA;AAAA,YACF;AAAA,UACJ,CAAC;AAAA,QACH,CAAC;AAAA,MACH,EACC;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,MACZ,MACG,SAAO;AAAA,QACN,aACG,SAAO,EACP;AAAA,UACC;AAAA,QACF,EACC,IAAI,EAAE,EACN,SAAS;AAAA,QACZ,aACG,SAAO,EACP,SAAS,mBAAmB,EAC5B,IAAI,GAAG,EACP,SAAS,EACT,SAAS;AAAA,MACd,CAAC,EACA;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,MACZ,SACG,SAAO;AAAA,QACN,KACG,SAAO,EACP,SAAS,aAAa,EACtB;AAAA,UACC;AAAA,UACA;AAAA,QACF,EACC,SAAS;AAAA,QACZ,YACG,SAAO,EACP,SAAS,+CAA+C,EACxD;AAAA,UACC;AAAA,UACA;AAAA,QACF,EACC,SAAS,EACT,SAAS;AAAA,QACZ,aACG,SAAO,EACP,SAAS,yBAAyB,EAClC,IAAI,EAAE,EACN,SAAS,EACT,SAAS;AAAA,MACd,CAAC,EACA;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,MACZ,mBACG,SAAO;AAAA,QACN,KACG,SAAO,EACP,SAAS,wBAAwB,EACjC;AAAA,UACC;AAAA,UACA;AAAA,QACF,EACC,SAAS;AAAA,QACZ,YACG,SAAO,EACP;AAAA,UACC;AAAA,QACF,EACC;AAAA,UACC;AAAA,UACA;AAAA,QACF,EACC,SAAS,EACT,SAAS;AAAA,QACZ,aACG,SAAO,EACP,SAAS,oCAAoC,EAC7C,IAAI,EAAE,EACN,SAAS,EACT,SAAS;AAAA,QACZ,aACG,SAAO,EACP,SAAS,iCAAiC,EAC1C,IAAI,GAAG,EACP,SAAS,EACT,SAAS;AAAA,MACd,CAAC,EACA;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,MACZ,QACG,SAAO,EACP,SAAS,UAAU,EACnB;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS;AAAA,MACZ,UACG,SAAO;AAAA,QACN,aACG,SAAO,EACP,SAAS,sBAAsB,EAC/B,IAAI,GAAG,EACP,SAAS,EACT,SAAS;AAAA,MACd,CAAC,EACA;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,MACZ,aACG,SAAO;AAAA,QACN,OACG,SAAO,EACP;AAAA,UACC;AAAA,QACF,EACC,SAAS,EACT,SAAS;AAAA,QACZ,YACG,SAAO,EACP;AAAA,UACC;AAAA,QACF,EACC,IAAI,EAAE,EACN,SAAS;AAAA,QACZ,aACG,SAAO,EACP,SAAS,yBAAyB,EAClC,IAAI,EAAE,EACN,SAAS,EACT,SAAS;AAAA,QACZ,aACG,SAAO,EACP,SAAS,sBAAsB,EAC/B,IAAI,GAAG,EACP,SAAS,EACT,SAAS;AAAA,MACd,CAAC,EACA;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,MACZ,YACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,IAAI,EAAE,EACN,SAAS;AAAA,MACZ,eACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,IAAI,EAAE,EACN,SAAS;AAAA,IACd,CAAC;AAAA,EACH,EACC,SAAS;AAAA,EACZ,UACG,SAAO;AAAA,IACN,OACG,SAAO,EACP,IAAI,EACJ,SAAS,2CAA2C,EACpD,SAAS,EACT,SAAS;AAAA,IACZ,SACG,SAAO;AAAA,MACN,MACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,IAAI,IAAK,EACT,SAAS,EACT,SAAS;AAAA,MACZ,MACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,IAAI,IAAK,EACT,SAAS,EACT,SAAS;AAAA,IACd,CAAC,EACA;AAAA,MACC;AAAA,IACF,EACC,SAAS;AAAA,IACZ,SACG,UAAQ,EACR;AAAA,MACC;AAAA,IACF,EACC,SAAS,EACT,SAAS;AAAA,EACd,CAAC,EACA,SAAS,kBAAkB,EAC3B,SAAS;AACd,CAAC;","names":[]}
|