@wix/auto_sdk_benefit-programs_pools 1.0.82 → 1.0.83

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

@@ -1711,14 +1711,14 @@ 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_selector` are checked. */
+    /** Pool beneficiary. Defaults to the calling identity. Only the beneficiary's pools that also match `pool_selector` are checked. */
     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.
+     * When omitted, pools in all statuses are checked. Combined with `beneficiary`, `namespace`, and `item_reference`, the selector further narrows which pools are checked.
      */
     poolSelector?: PoolSelector;
 }
@@ -2527,9 +2527,9 @@ interface BulkUpdatePoolsOptions {
     returnEntity?: boolean;
 }
 /**
- * Checks benefit eligibility across the pools that match the filter.
+ * Checks benefit eligibility across the beneficiary's pools that contain a benefit for the given item.
  *
- * The filter selects pools (not individual benefits), 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).
+ * Pools are matched by `itemReference` within `namespace` and must belong to `beneficiary`, which defaults to the calling identity. `poolSelector` narrows the matched pools further.
  *
  * To be redeemed, a benefit's pool must be active and the associated balance must be greater than the cost of the benefit.
  *
@@ -2564,14 +2564,14 @@ 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_selector` are checked. */
+    /** Pool beneficiary. Defaults to the calling identity. Only the beneficiary's pools that also match `pool_selector` are checked. */
     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.
+     * When omitted, pools in all statuses are checked. Combined with `beneficiary`, `namespace`, and `item_reference`, the selector further narrows which pools are checked.
      */
     poolSelector?: PoolSelector;
 }