@wix/auto_sdk_benefit-programs_pools 1.0.81 → 1.0.82

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

@@ -1103,7 +1103,7 @@ interface ReallocateBenefitRequest {
      */
     idempotencyKey: string;
     /** Beneficiary of the pool containing the benefit to reallocate. Must match the beneficiary of the original redemption. */
-    beneficiary?: CommonIdentificationData;
+    beneficiary: CommonIdentificationData;
     /**
      * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
      * @minLength 1
@@ -1690,24 +1690,6 @@ interface CountNumberOfPoolsInProvisioningStatusResponse {
     count?: number;
 }
 interface CheckBenefitEligibilityByFilterRequest {
-    /**
-     * 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`.
-     * @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;
     /**
      * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
      * @minLength 1
@@ -1729,7 +1711,7 @@ interface CheckBenefitEligibilityByFilterRequest {
      * This parameter should be used to manage the potential logistics of providing the item.
      */
     targetDate?: Date | null;
-    /** Pool beneficiary. When provided, only the beneficiary's pools that also match `pool_filter` are checked. */
+    /** Pool beneficiary. When provided, only the beneficiary's pools that also match `pool_selector` are checked. */
     beneficiary?: CommonIdentificationData;
     /** Additional information. */
     additionalData?: Record<string, any> | null;
@@ -1737,24 +1719,9 @@ interface CheckBenefitEligibilityByFilterRequest {
      * 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 {
-    /**
-     * Filter object. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more information.
-     *
-     * For supported filterable and sortable fields, see [Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/pools/filtering-and-sorting).
-     */
-    filter?: Record<string, any> | null;
-    /**
-     * Sorting to apply to the matched pools. Determines the order of the returned results, and which results are kept when more than 100 are produced.
-     * @maxSize 5
-     */
-    sort?: Sorting[];
-}
 /**
  * Predefined pool-selection attributes used to select the pools to check eligibility in.
  *
@@ -1770,9 +1737,9 @@ interface PoolSelector {
 }
 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.
+     * Results of the eligibility check for the benefits in the pools that match the request. A pool that contains multiple benefits for the requested item produces one result per benefit.
      *
-     * Empty when no pools match the filter. Capped at 100 results. When more than 100 results are produced, only the first 100, in the order specified by `poolFilter.sort`, are returned.
+     * Empty when no pools match. Capped at 100 results. When more than 100 results are produced, which results are returned isn't guaranteed.
      * @maxSize 100
      */
     results?: EligibilityCheckResult[];
@@ -2044,10 +2011,6 @@ 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.
@@ -2400,7 +2363,7 @@ interface ReallocateBenefitOptions {
      */
     idempotencyKey: string;
     /** Beneficiary of the pool containing the benefit to reallocate. Must match the beneficiary of the original redemption. */
-    beneficiary?: CommonIdentificationData;
+    beneficiary: CommonIdentificationData;
     /**
      * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
      * @minLength 1
@@ -2571,44 +2534,21 @@ interface BulkUpdatePoolsOptions {
  * To be redeemed, a benefit's pool must be active and the associated balance must be greater than the cost of the benefit.
  *
  * Each benefit is checked independently. For example, if there is a benefit with a price of 3 credits and a benefit with a price of 4 credits, and there are 5 available credits, both benefits would be returned as eligible, but they can't both be redeemed.
+ * @param namespace - Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
  * @public
+ * @requiredField namespace
  * @requiredField options.count
  * @requiredField options.itemReference
  * @requiredField options.itemReference.externalId
  * @requiredField options.itemReference.providerAppId
- * @requiredField options.namespace
  * @permissionId benefit_programs:v1:pool:check_benefit_eligibility_by_filter
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool.PoolService.CheckBenefitEligibilityByFilter
  */
-declare function checkBenefitEligibilityByFilter(options?: NonNullablePaths<CheckBenefitEligibilityByFilterOptions, `count` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 3>): Promise<NonNullablePaths<CheckBenefitEligibilityByFilterResponse, `results`, 2> & {
+declare function checkBenefitEligibilityByFilter(namespace: string, options?: NonNullablePaths<CheckBenefitEligibilityByFilterOptions, `count` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId`, 3>): Promise<NonNullablePaths<CheckBenefitEligibilityByFilterResponse, `results`, 2> & {
     __applicationErrorsType?: CheckBenefitEligibilityByFilterApplicationErrors;
 }>;
 interface CheckBenefitEligibilityByFilterOptions {
-    /**
-     * 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`.
-     * @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;
-    /**
-     * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
-     * @minLength 1
-     * @maxLength 20
-     */
-    namespace: string;
     /** Information about the item to check. */
     itemReference: ItemReference;
     /**
@@ -2624,7 +2564,7 @@ interface CheckBenefitEligibilityByFilterOptions {
      * This parameter should be used to manage the potential logistics of providing the item.
      */
     targetDate?: Date | null;
-    /** Pool beneficiary. When provided, only the beneficiary's pools that also match `pool_filter` are checked. */
+    /** Pool beneficiary. When provided, only the beneficiary's pools that also match `pool_selector` are checked. */
     beneficiary?: CommonIdentificationData;
     /** Additional information. */
     additionalData?: Record<string, any> | null;
@@ -2632,10 +2572,8 @@ interface CheckBenefitEligibilityByFilterOptions {
      * 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 AlreadyExecuted, type ApplicationError, type AsyncResult, type BalanceAmount, type Benefit, type BenefitAlreadyRedeemed, type BenefitInfo, type BenefitNotFound, type BenefitReallocated, 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 CancelRedemptionApplicationErrors, type CancelRedemptionOptions, type CancelRedemptionRequest, type CancelRedemptionResponse, type CancellationDetails, type ChainOperationInProgress, 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, Intent, type IntentWithLiterals, type InvalidPoolDefinitionReference, type ItemMetadata, type ItemReference, type MaskedPool, type MessageEnvelope, type NotEnoughBalance, type NotLatestTransaction, 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 ReallocateBenefitApplicationErrors, type ReallocateBenefitOptions, type ReallocateBenefitRequest, type ReallocateBenefitResponse, type ReallocationDetails, type RedeemBenefitApplicationErrors, type RedeemBenefitOptions, type RedeemBenefitRequest, type RedeemBenefitResponse, type RedemptionAlreadyCanceled, type RedemptionCanceled, 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 TransactionNotFound, 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 AlreadyExecuted, type ApplicationError, type AsyncResult, type BalanceAmount, type Benefit, type BenefitAlreadyRedeemed, type BenefitInfo, type BenefitNotFound, type BenefitReallocated, 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 CancelRedemptionApplicationErrors, type CancelRedemptionOptions, type CancelRedemptionRequest, type CancelRedemptionResponse, type CancellationDetails, type ChainOperationInProgress, 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, Intent, type IntentWithLiterals, type InvalidPoolDefinitionReference, type ItemMetadata, type ItemReference, type MaskedPool, type MessageEnvelope, type NotEnoughBalance, type NotLatestTransaction, 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 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 ReallocateBenefitApplicationErrors, type ReallocateBenefitOptions, type ReallocateBenefitRequest, type ReallocateBenefitResponse, type ReallocationDetails, type RedeemBenefitApplicationErrors, type RedeemBenefitOptions, type RedeemBenefitRequest, type RedeemBenefitResponse, type RedemptionAlreadyCanceled, type RedemptionCanceled, 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 TransactionNotFound, 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/cjs/index.typings.js

@@ -1056,11 +1056,10 @@ async function bulkUpdatePools2(options) {
     throw transformedError;
   }
 }
-async function checkBenefitEligibilityByFilter2(options) {
-  const { httpClient, sideEffects } = arguments[1];
+async function checkBenefitEligibilityByFilter2(namespace, options) {
+  const { httpClient, sideEffects } = arguments[2];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
-    poolFilter: options?.poolFilter,
-    namespace: options?.namespace,
+    namespace,
     itemReference: options?.itemReference,
     count: options?.count,
     targetDate: options?.targetDate,
@@ -1080,18 +1079,17 @@ async function checkBenefitEligibilityByFilter2(options) {
       {
         spreadPathsToArguments: {},
         explicitPathsToArguments: {
-          poolFilter: "$[0].poolFilter",
-          namespace: "$[0].namespace",
-          itemReference: "$[0].itemReference",
-          count: "$[0].count",
-          targetDate: "$[0].targetDate",
-          beneficiary: "$[0].beneficiary",
-          additionalData: "$[0].additionalData",
-          poolSelector: "$[0].poolSelector"
+          namespace: "$[0]",
+          itemReference: "$[1].itemReference",
+          count: "$[1].count",
+          targetDate: "$[1].targetDate",
+          beneficiary: "$[1].beneficiary",
+          additionalData: "$[1].additionalData",
+          poolSelector: "$[1].poolSelector"
         },
         singleArgumentUnchanged: false
       },
-      ["options"]
+      ["namespace", "options"]
     );
     sideEffects?.onError?.(err);
     throw transformedError;