@wix/auto_sdk_benefit-programs_pools 1.0.74 → 1.0.76

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

@@ -934,6 +934,12 @@ interface PoolInfo {
      * @format GUID
      */
     poolDefinitionId?: string;
+    /**
+     * Credit unit type.
+     * @internal
+     * @maxLength 16
+     */
+    creditUnitType?: string | null;
 }
 interface BalanceAmount {
     /**
@@ -965,6 +971,12 @@ interface BenefitInfo {
      * @maxLength 64
      */
     benefitKey?: string;
+    /**
+     * Price of the benefit in credits.
+     * @internal
+     * @decimalValue options { gte:0, maxScale:4 }
+     */
+    price?: string | null;
 }
 interface PolicyExpressionEvaluatedToFalse {
     /**
@@ -1406,74 +1418,6 @@ interface GetEligibleBenefitsResponse {
     /** Retrieved benefits that can be redeemed. */
     eligibleBenefits?: EligibleBenefit[];
 }
-interface ListPoolsRequest {
-    /** The filter */
-    filter?: Filter;
-    /** Cursor paging */
-    cursorPaging?: CursorPaging;
-}
-declare enum ListPoolsRequestType {
-    BY_ITEM_REFERENCE = "BY_ITEM_REFERENCE"
-}
-/** @enumType */
-type ListPoolsRequestTypeWithLiterals = ListPoolsRequestType | 'BY_ITEM_REFERENCE';
-interface ByItemReference {
-    /**
-     * A list of filters
-     * @maxSize 100
-     */
-    filters?: ByItemReferenceFilter[];
-    /** Beneficiary of the pool */
-    beneficiary?: CommonIdentificationData;
-    /**
-     * Returns pools that are in the following statuses
-     * @maxSize 10
-     */
-    poolStatuses?: PoolStatusWithLiterals[];
-}
-interface ByItemReferenceFilter {
-    /** Reference of the item */
-    itemReference?: ItemReference;
-}
-interface Filter extends FilterFilterOneOf {
-    /** A list of filters by reference */
-    byItemReferenceOptions?: ByItemReference;
-    /** Type of the filter */
-    type?: ListPoolsRequestTypeWithLiterals;
-    /**
-     * Module that is the source of the benefit pool creation.
-     *
-     * This value must correspond with the previously defined namespace established when creating the associated pool definition.
-     *
-     * It ensures efficient processing and management of pools and benefits.
-     * @minLength 1
-     * @maxLength 20
-     */
-    namespace?: string;
-}
-/** @oneof */
-interface FilterFilterOneOf {
-    /** A list of filters by reference */
-    byItemReferenceOptions?: ByItemReference;
-}
-interface ListPoolsResponse {
-    /**
-     * The retrieved pools
-     * @maxSize 100
-     */
-    pools?: PoolWithItems[];
-    /** Paging information */
-    metadata?: CursorPagingMetadata;
-}
-interface PoolWithItems {
-    /** The pool */
-    pool?: Pool;
-    /**
-     * The items in the pool
-     * @maxSize 100
-     */
-    itemReference?: ItemReference[];
-}
 interface BulkUpdatePoolsRequest {
     /**
      * Pools to update.
@@ -1699,6 +1643,16 @@ interface CheckBenefitEligibilityByFilterRequest {
      * The filter selects pools using the same fields supported by Query Pools. For field support, see [Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/pools/filtering-and-sorting).
      *
      * When omitted, eligibility is checked across all pools in the namespace that match the provided `beneficiary`. Combined with `beneficiary` and `namespace`, the filter further narrows which pools are checked.
+     *
+     * Deprecated: use `pool_selector` instead. Can't be combined with `pool_selector`.
+     * @deprecated Defines filtering and sorting criteria used to select pools when checking eligibility.
+     *
+     * The filter selects pools using the same fields supported by Query Pools. For field support, see [Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/pools/filtering-and-sorting).
+     *
+     * When omitted, eligibility is checked across all pools in the namespace that match the provided `beneficiary`. Combined with `beneficiary` and `namespace`, the filter further narrows which pools are checked.
+     *
+     * Deprecated: use `pool_selector` instead. Can't be combined with `pool_selector`.
+     * @targetRemovalDate 2026-08-01
      */
     poolFilter?: PoolFilter;
     /**
@@ -1726,6 +1680,14 @@ interface CheckBenefitEligibilityByFilterRequest {
     beneficiary?: CommonIdentificationData;
     /** Additional information. */
     additionalData?: Record<string, any> | null;
+    /**
+     * Predefined attributes used to select the pools to check eligibility in.
+     *
+     * When omitted, eligibility is checked across all pools in the namespace that match the provided `beneficiary`. Combined with `beneficiary` and `namespace`, the selector further narrows which pools are checked.
+     *
+     * Can't be combined with `pool_filter`.
+     */
+    poolSelector?: PoolSelector;
 }
 interface PoolFilter {
     /**
@@ -1740,6 +1702,19 @@ interface PoolFilter {
      */
     sort?: Sorting[];
 }
+/**
+ * Predefined pool-selection attributes used to select the pools to check eligibility in.
+ *
+ * All provided attributes must match for a pool to be selected, while the values within each attribute are alternatives.
+ * An empty selector selects all pools in the namespace that match the provided `beneficiary`.
+ */
+interface PoolSelector {
+    /**
+     * Only pools in these statuses are checked. When empty, pools in all statuses are checked.
+     * @maxSize 10
+     */
+    poolStatuses?: PoolStatusWithLiterals[];
+}
 interface CheckBenefitEligibilityByFilterResponse {
     /**
      * Results of the eligibility check for the benefits in the pools that matched the filter. A pool that contains multiple benefits for the requested item produces one result per benefit.
@@ -1952,6 +1927,10 @@ type CheckBenefitEligibilityByFilterApplicationErrors = {
     code?: 'INVALID_ITEM_REFERENCE';
     description?: string;
     data?: Record<string, any>;
+} | {
+    code?: 'POOL_FILTER_AND_POOL_SELECTOR_PROVIDED';
+    description?: string;
+    data?: Record<string, any>;
 };
 /**
  * Retrieves a pool.
@@ -2477,6 +2456,16 @@ interface CheckBenefitEligibilityByFilterOptions {
      * The filter selects pools using the same fields supported by Query Pools. For field support, see [Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/pools/filtering-and-sorting).
      *
      * When omitted, eligibility is checked across all pools in the namespace that match the provided `beneficiary`. Combined with `beneficiary` and `namespace`, the filter further narrows which pools are checked.
+     *
+     * Deprecated: use `pool_selector` instead. Can't be combined with `pool_selector`.
+     * @deprecated Defines filtering and sorting criteria used to select pools when checking eligibility.
+     *
+     * The filter selects pools using the same fields supported by Query Pools. For field support, see [Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/pools/filtering-and-sorting).
+     *
+     * When omitted, eligibility is checked across all pools in the namespace that match the provided `beneficiary`. Combined with `beneficiary` and `namespace`, the filter further narrows which pools are checked.
+     *
+     * Deprecated: use `pool_selector` instead. Can't be combined with `pool_selector`.
+     * @targetRemovalDate 2026-08-01
      */
     poolFilter?: PoolFilter;
     /**
@@ -2504,6 +2493,14 @@ interface CheckBenefitEligibilityByFilterOptions {
     beneficiary?: CommonIdentificationData;
     /** Additional information. */
     additionalData?: Record<string, any> | null;
+    /**
+     * Predefined attributes used to select the pools to check eligibility in.
+     *
+     * When omitted, eligibility is checked across all pools in the namespace that match the provided `beneficiary`. Combined with `beneficiary` and `namespace`, the selector further narrows which pools are checked.
+     *
+     * Can't be combined with `pool_filter`.
+     */
+    poolSelector?: PoolSelector;
 }
 
-export { type AccountInfo, type ActionEvent, type ApplicationError, type AsyncResult, type BalanceAmount, type Benefit, type BenefitAlreadyRedeemed, type BenefitInfo, type BenefitNotFound, type BenefitRedeemed, type BenefitReservationCanceled, type BenefitReservationReleased, type BenefitReserved, type BenefitResult, type BenefitResultResultOneOf, BenefitResultType, type BenefitResultTypeWithLiterals, type BenefitSelector, type BulkActionMetadata, type BulkCheckBenefitEligibilityOptions, type BulkCheckBenefitEligibilityRequest, type BulkCheckBenefitEligibilityResponse, type BulkEligibilityCheckResult, type BulkPoolResult, type BulkUpdatePoolsOptions, type BulkUpdatePoolsRequest, type BulkUpdatePoolsResponse, type ByItemReference, type ByItemReferenceFilter, type ByPoolDefinitionIdAndProgramDefinitionIdOptions, type ByProgramIdOptions, type CancelBenefitReservationRequest, type CancelBenefitReservationResponse, type CheckBenefitEligibilityByFilterApplicationErrors, type CheckBenefitEligibilityByFilterOptions, type CheckBenefitEligibilityByFilterRequest, type CheckBenefitEligibilityByFilterResponse, type CheckBenefitEligibilityOptions, type CheckBenefitEligibilityRequest, type CheckBenefitEligibilityResponse, type CommonIdentificationData, type CommonIdentificationDataIdOneOf, type CommonQueryWithEntityContext, type CountNumberOfPoolsInProvisioningStatusRequest, type CountNumberOfPoolsInProvisioningStatusResponse, type CreatePoolRequest, type CreatePoolResponse, type CreditConfiguration, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomPolicy, type DeletePoolRequest, type DeletePoolResponse, type Details, type DomainEvent, type DomainEventBodyOneOf, type EligibilityCheckResult, type EligibleBenefit, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type FailureDetails, type Filter, type FilterFilterOneOf, type FixedIntervalPolicy, type GetEligibleBenefitsApplicationErrors, type GetEligibleBenefitsOptions, type GetEligibleBenefitsRequest, type GetEligibleBenefitsResponse, type GetPoolRequest, type GetPoolResponse, type HealPoolRequest, type HealPoolResponse, type HealPoolTenantRequest, type HealPoolTenantResponse, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type IdentityTypeWithLiterals, type InvalidPoolDefinitionReference, type ItemMetadata, type ItemReference, type ListPoolsRequest, ListPoolsRequestType, type ListPoolsRequestTypeWithLiterals, type ListPoolsResponse, type MaskedPool, type MessageEnvelope, type NotEnoughBalance, type Policy, type PolicyExpression, type PolicyExpressionAnd, type PolicyExpressionEvaluatedToFalse, type PolicyExpressionExpressionOneOf, type PolicyExpressionNot, type PolicyExpressionOr, PolicyExpressionType, type PolicyExpressionTypeWithLiterals, type PolicyPolicyOneOf, type Pool, type PoolDefinitionAndProgramDefinition, type PoolDefinitionLookupId, type PoolDefinitionLookupIdIdOneOf, type PoolEnded, type PoolFilter, type PoolInfo, type PoolNotActive, type PoolNotFound, PoolOrigin, type PoolOriginWithLiterals, type PoolPaused, type PoolProgramInfo, type PoolProvisionJobFinished, type PoolProvisioned, type PoolQuery, type PoolQuerySpec, type PoolRenewalAction, type PoolRenewalActionActionOneOf, PoolRenewalActionType, type PoolRenewalActionTypeWithLiterals, type PoolRenewed, type PoolResumed, PoolSelectorType, type PoolSelectorTypeWithLiterals, PoolStatus, type PoolStatusUpdateJobFinished, type PoolStatusUpdateJobFinishedContextOneOf, type PoolStatusUpdateParamsPoolInfo, type PoolStatusWithLiterals, type PoolWithItems, type PoolsQueryBuilder, type PoolsQueryResult, type ProgramDefinitionInfo, type ProgramInfo, type ProvisionPoolsForProgramRequest, type ProvisionPoolsForProgramResponse, type ProvisionPoolsForProgramResponseResultOneOf, ProvisionPoolsForProgramResponseType, type ProvisionPoolsForProgramResponseTypeWithLiterals, type QueryPoolsOptions, type QueryPoolsRequest, type QueryPoolsResponse, type RateLimitedPolicy, type RedeemBenefitApplicationErrors, type RedeemBenefitOptions, type RedeemBenefitRequest, type RedeemBenefitResponse, type RedemptionDetails, type ReleaseBenefitReservationRequest, type ReleaseBenefitReservationResponse, type RenewPoolsForProgramRequest, type RenewPoolsForProgramResponse, type ReserveBenefitRequest, type ReserveBenefitResponse, type RestoreInfo, type RolloverConfiguration, SortOrder, type SortOrderWithLiterals, type Sorting, type SyncResult, TimePeriod, type TimePeriodWithLiterals, Type, type TypeWithLiterals, type Update, type UpdatePool, type UpdatePoolRequest, type UpdatePoolResponse, type UpdatePoolStatusRequest, type UpdatePoolStatusRequestPoolSelectorOneOf, type UpdatePoolStatusResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeekDay, type WeekDayWithLiterals, bulkCheckBenefitEligibility, bulkUpdatePools, checkBenefitEligibility, checkBenefitEligibilityByFilter, getEligibleBenefits, getPool, queryPools, redeemBenefit, typedQueryPools, updatePool, utils };
+export { type AccountInfo, type ActionEvent, type ApplicationError, type AsyncResult, type BalanceAmount, type Benefit, type BenefitAlreadyRedeemed, type BenefitInfo, type BenefitNotFound, type BenefitRedeemed, type BenefitReservationCanceled, type BenefitReservationReleased, type BenefitReserved, type BenefitResult, type BenefitResultResultOneOf, BenefitResultType, type BenefitResultTypeWithLiterals, type BenefitSelector, type BulkActionMetadata, type BulkCheckBenefitEligibilityOptions, type BulkCheckBenefitEligibilityRequest, type BulkCheckBenefitEligibilityResponse, type BulkEligibilityCheckResult, type BulkPoolResult, type BulkUpdatePoolsOptions, type BulkUpdatePoolsRequest, type BulkUpdatePoolsResponse, type ByPoolDefinitionIdAndProgramDefinitionIdOptions, type ByProgramIdOptions, type CancelBenefitReservationRequest, type CancelBenefitReservationResponse, type CheckBenefitEligibilityByFilterApplicationErrors, type CheckBenefitEligibilityByFilterOptions, type CheckBenefitEligibilityByFilterRequest, type CheckBenefitEligibilityByFilterResponse, type CheckBenefitEligibilityOptions, type CheckBenefitEligibilityRequest, type CheckBenefitEligibilityResponse, type CommonIdentificationData, type CommonIdentificationDataIdOneOf, type CommonQueryWithEntityContext, type CountNumberOfPoolsInProvisioningStatusRequest, type CountNumberOfPoolsInProvisioningStatusResponse, type CreatePoolRequest, type CreatePoolResponse, type CreditConfiguration, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomPolicy, type DeletePoolRequest, type DeletePoolResponse, type Details, type DomainEvent, type DomainEventBodyOneOf, type EligibilityCheckResult, type EligibleBenefit, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type FailureDetails, type FixedIntervalPolicy, type GetEligibleBenefitsApplicationErrors, type GetEligibleBenefitsOptions, type GetEligibleBenefitsRequest, type GetEligibleBenefitsResponse, type GetPoolRequest, type GetPoolResponse, type HealPoolRequest, type HealPoolResponse, type HealPoolTenantRequest, type HealPoolTenantResponse, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type IdentityTypeWithLiterals, type InvalidPoolDefinitionReference, type ItemMetadata, type ItemReference, type MaskedPool, type MessageEnvelope, type NotEnoughBalance, type Policy, type PolicyExpression, type PolicyExpressionAnd, type PolicyExpressionEvaluatedToFalse, type PolicyExpressionExpressionOneOf, type PolicyExpressionNot, type PolicyExpressionOr, PolicyExpressionType, type PolicyExpressionTypeWithLiterals, type PolicyPolicyOneOf, type Pool, type PoolDefinitionAndProgramDefinition, type PoolDefinitionLookupId, type PoolDefinitionLookupIdIdOneOf, type PoolEnded, type PoolFilter, type PoolInfo, type PoolNotActive, type PoolNotFound, PoolOrigin, type PoolOriginWithLiterals, type PoolPaused, type PoolProgramInfo, type PoolProvisionJobFinished, type PoolProvisioned, type PoolQuery, type PoolQuerySpec, type PoolRenewalAction, type PoolRenewalActionActionOneOf, PoolRenewalActionType, type PoolRenewalActionTypeWithLiterals, type PoolRenewed, type PoolResumed, type PoolSelector, PoolSelectorType, type PoolSelectorTypeWithLiterals, PoolStatus, type PoolStatusUpdateJobFinished, type PoolStatusUpdateJobFinishedContextOneOf, type PoolStatusUpdateParamsPoolInfo, type PoolStatusWithLiterals, type PoolsQueryBuilder, type PoolsQueryResult, type ProgramDefinitionInfo, type ProgramInfo, type ProvisionPoolsForProgramRequest, type ProvisionPoolsForProgramResponse, type ProvisionPoolsForProgramResponseResultOneOf, ProvisionPoolsForProgramResponseType, type ProvisionPoolsForProgramResponseTypeWithLiterals, type QueryPoolsOptions, type QueryPoolsRequest, type QueryPoolsResponse, type RateLimitedPolicy, type RedeemBenefitApplicationErrors, type RedeemBenefitOptions, type RedeemBenefitRequest, type RedeemBenefitResponse, type RedemptionDetails, type ReleaseBenefitReservationRequest, type ReleaseBenefitReservationResponse, type RenewPoolsForProgramRequest, type RenewPoolsForProgramResponse, type ReserveBenefitRequest, type ReserveBenefitResponse, type RestoreInfo, type RolloverConfiguration, SortOrder, type SortOrderWithLiterals, type Sorting, type SyncResult, TimePeriod, type TimePeriodWithLiterals, Type, type TypeWithLiterals, type Update, type UpdatePool, type UpdatePoolRequest, type UpdatePoolResponse, type UpdatePoolStatusRequest, type UpdatePoolStatusRequestPoolSelectorOneOf, type UpdatePoolStatusResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeekDay, type WeekDayWithLiterals, bulkCheckBenefitEligibility, bulkUpdatePools, checkBenefitEligibility, checkBenefitEligibilityByFilter, getEligibleBenefits, getPool, queryPools, redeemBenefit, typedQueryPools, updatePool, utils };

package/build/internal/es/index.typings.mjs

@@ -565,10 +565,6 @@ var BenefitResultType = /* @__PURE__ */ ((BenefitResultType2) => {
   BenefitResultType2["POOL_NOT_FOUND"] = "POOL_NOT_FOUND";
   return BenefitResultType2;
 })(BenefitResultType || {});
-var ListPoolsRequestType = /* @__PURE__ */ ((ListPoolsRequestType2) => {
-  ListPoolsRequestType2["BY_ITEM_REFERENCE"] = "BY_ITEM_REFERENCE";
-  return ListPoolsRequestType2;
-})(ListPoolsRequestType || {});
 var ProvisionPoolsForProgramResponseType = /* @__PURE__ */ ((ProvisionPoolsForProgramResponseType2) => {
   ProvisionPoolsForProgramResponseType2["SYNC"] = "SYNC";
   ProvisionPoolsForProgramResponseType2["ASYNC"] = "ASYNC";
@@ -902,7 +898,8 @@ async function checkBenefitEligibilityByFilter2(options) {
     count: options?.count,
     targetDate: options?.targetDate,
     beneficiary: options?.beneficiary,
-    additionalData: options?.additionalData
+    additionalData: options?.additionalData,
+    poolSelector: options?.poolSelector
   });
   const reqOpts = checkBenefitEligibilityByFilter(payload);
   sideEffects?.onSiteCall?.();
@@ -922,7 +919,8 @@ async function checkBenefitEligibilityByFilter2(options) {
           count: "$[0].count",
           targetDate: "$[0].targetDate",
           beneficiary: "$[0].beneficiary",
-          additionalData: "$[0].additionalData"
+          additionalData: "$[0].additionalData",
+          poolSelector: "$[0].poolSelector"
         },
         singleArgumentUnchanged: false
       },
@@ -935,7 +933,6 @@ async function checkBenefitEligibilityByFilter2(options) {
 export {
   BenefitResultType,
   IdentityType,
-  ListPoolsRequestType,
   PolicyExpressionType,
   PoolOrigin,
   PoolRenewalActionType,