@wix/auto_sdk_benefit-programs_pools 1.0.82 → 1.0.83

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.
@@ -112,9 +112,9 @@ interface BulkUpdatePoolsSignature {
112
112
  declare function checkBenefitEligibilityByFilter$1(httpClient: HttpClient): CheckBenefitEligibilityByFilterSignature;
113
113
  interface CheckBenefitEligibilityByFilterSignature {
114
114
  /**
115
- * Checks benefit eligibility across the pools that match the filter.
115
+ * Checks benefit eligibility across the beneficiary's pools that contain a benefit for the given item.
116
116
  *
117
- * 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).
117
+ * Pools are matched by `itemReference` within `namespace` and must belong to `beneficiary`, which defaults to the calling identity. `poolSelector` narrows the matched pools further.
118
118
  *
119
119
  * To be redeemed, a benefit's pool must be active and the associated balance must be greater than the cost of the benefit.
120
120
  *
@@ -1915,14 +1915,14 @@ interface CheckBenefitEligibilityByFilterRequest {
1915
1915
  * This parameter should be used to manage the potential logistics of providing the item.
1916
1916
  */
1917
1917
  targetDate?: Date | null;
1918
- /** Pool beneficiary. When provided, only the beneficiary's pools that also match `pool_selector` are checked. */
1918
+ /** Pool beneficiary. Defaults to the calling identity. Only the beneficiary's pools that also match `pool_selector` are checked. */
1919
1919
  beneficiary?: CommonIdentificationData;
1920
1920
  /** Additional information. */
1921
1921
  additionalData?: Record<string, any> | null;
1922
1922
  /**
1923
1923
  * Predefined attributes used to select the pools to check eligibility in.
1924
1924
  *
1925
- * 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.
1925
+ * When omitted, pools in all statuses are checked. Combined with `beneficiary`, `namespace`, and `item_reference`, the selector further narrows which pools are checked.
1926
1926
  */
1927
1927
  poolSelector?: PoolSelector;
1928
1928
  }
@@ -2829,9 +2829,9 @@ interface BulkUpdatePoolsOptions {
2829
2829
  returnEntity?: boolean;
2830
2830
  }
2831
2831
  /**
2832
- * Checks benefit eligibility across the pools that match the filter.
2832
+ * Checks benefit eligibility across the beneficiary's pools that contain a benefit for the given item.
2833
2833
  *
2834
- * 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).
2834
+ * Pools are matched by `itemReference` within `namespace` and must belong to `beneficiary`, which defaults to the calling identity. `poolSelector` narrows the matched pools further.
2835
2835
  *
2836
2836
  * To be redeemed, a benefit's pool must be active and the associated balance must be greater than the cost of the benefit.
2837
2837
  *
@@ -2866,14 +2866,14 @@ interface CheckBenefitEligibilityByFilterOptions {
2866
2866
  * This parameter should be used to manage the potential logistics of providing the item.
2867
2867
  */
2868
2868
  targetDate?: Date | null;
2869
- /** Pool beneficiary. When provided, only the beneficiary's pools that also match `pool_selector` are checked. */
2869
+ /** Pool beneficiary. Defaults to the calling identity. Only the beneficiary's pools that also match `pool_selector` are checked. */
2870
2870
  beneficiary?: CommonIdentificationData;
2871
2871
  /** Additional information. */
2872
2872
  additionalData?: Record<string, any> | null;
2873
2873
  /**
2874
2874
  * Predefined attributes used to select the pools to check eligibility in.
2875
2875
  *
2876
- * 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.
2876
+ * When omitted, pools in all statuses are checked. Combined with `beneficiary`, `namespace`, and `item_reference`, the selector further narrows which pools are checked.
2877
2877
  */
2878
2878
  poolSelector?: PoolSelector;
2879
2879
  }
@@ -1915,14 +1915,14 @@ interface CheckBenefitEligibilityByFilterRequest {
1915
1915
  * This parameter should be used to manage the potential logistics of providing the item.
1916
1916
  */
1917
1917
  targetDate?: Date | null;
1918
- /** Pool beneficiary. When provided, only the beneficiary's pools that also match `pool_selector` are checked. */
1918
+ /** Pool beneficiary. Defaults to the calling identity. Only the beneficiary's pools that also match `pool_selector` are checked. */
1919
1919
  beneficiary?: CommonIdentificationData;
1920
1920
  /** Additional information. */
1921
1921
  additionalData?: Record<string, any> | null;
1922
1922
  /**
1923
1923
  * Predefined attributes used to select the pools to check eligibility in.
1924
1924
  *
1925
- * 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.
1925
+ * When omitted, pools in all statuses are checked. Combined with `beneficiary`, `namespace`, and `item_reference`, the selector further narrows which pools are checked.
1926
1926
  */
1927
1927
  poolSelector?: PoolSelector;
1928
1928
  }
@@ -112,9 +112,9 @@ interface BulkUpdatePoolsSignature {
112
112
  declare function checkBenefitEligibilityByFilter$1(httpClient: HttpClient): CheckBenefitEligibilityByFilterSignature;
113
113
  interface CheckBenefitEligibilityByFilterSignature {
114
114
  /**
115
- * Checks benefit eligibility across the pools that match the filter.
115
+ * Checks benefit eligibility across the beneficiary's pools that contain a benefit for the given item.
116
116
  *
117
- * 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).
117
+ * Pools are matched by `itemReference` within `namespace` and must belong to `beneficiary`, which defaults to the calling identity. `poolSelector` narrows the matched pools further.
118
118
  *
119
119
  * To be redeemed, a benefit's pool must be active and the associated balance must be greater than the cost of the benefit.
120
120
  *
@@ -1915,14 +1915,14 @@ interface CheckBenefitEligibilityByFilterRequest {
1915
1915
  * This parameter should be used to manage the potential logistics of providing the item.
1916
1916
  */
1917
1917
  targetDate?: Date | null;
1918
- /** Pool beneficiary. When provided, only the beneficiary's pools that also match `pool_selector` are checked. */
1918
+ /** Pool beneficiary. Defaults to the calling identity. Only the beneficiary's pools that also match `pool_selector` are checked. */
1919
1919
  beneficiary?: CommonIdentificationData;
1920
1920
  /** Additional information. */
1921
1921
  additionalData?: Record<string, any> | null;
1922
1922
  /**
1923
1923
  * Predefined attributes used to select the pools to check eligibility in.
1924
1924
  *
1925
- * 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.
1925
+ * When omitted, pools in all statuses are checked. Combined with `beneficiary`, `namespace`, and `item_reference`, the selector further narrows which pools are checked.
1926
1926
  */
1927
1927
  poolSelector?: PoolSelector;
1928
1928
  }
@@ -2829,9 +2829,9 @@ interface BulkUpdatePoolsOptions {
2829
2829
  returnEntity?: boolean;
2830
2830
  }
2831
2831
  /**
2832
- * Checks benefit eligibility across the pools that match the filter.
2832
+ * Checks benefit eligibility across the beneficiary's pools that contain a benefit for the given item.
2833
2833
  *
2834
- * 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).
2834
+ * Pools are matched by `itemReference` within `namespace` and must belong to `beneficiary`, which defaults to the calling identity. `poolSelector` narrows the matched pools further.
2835
2835
  *
2836
2836
  * To be redeemed, a benefit's pool must be active and the associated balance must be greater than the cost of the benefit.
2837
2837
  *
@@ -2866,14 +2866,14 @@ interface CheckBenefitEligibilityByFilterOptions {
2866
2866
  * This parameter should be used to manage the potential logistics of providing the item.
2867
2867
  */
2868
2868
  targetDate?: Date | null;
2869
- /** Pool beneficiary. When provided, only the beneficiary's pools that also match `pool_selector` are checked. */
2869
+ /** Pool beneficiary. Defaults to the calling identity. Only the beneficiary's pools that also match `pool_selector` are checked. */
2870
2870
  beneficiary?: CommonIdentificationData;
2871
2871
  /** Additional information. */
2872
2872
  additionalData?: Record<string, any> | null;
2873
2873
  /**
2874
2874
  * Predefined attributes used to select the pools to check eligibility in.
2875
2875
  *
2876
- * 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.
2876
+ * When omitted, pools in all statuses are checked. Combined with `beneficiary`, `namespace`, and `item_reference`, the selector further narrows which pools are checked.
2877
2877
  */
2878
2878
  poolSelector?: PoolSelector;
2879
2879
  }
@@ -1915,14 +1915,14 @@ interface CheckBenefitEligibilityByFilterRequest {
1915
1915
  * This parameter should be used to manage the potential logistics of providing the item.
1916
1916
  */
1917
1917
  targetDate?: Date | null;
1918
- /** Pool beneficiary. When provided, only the beneficiary's pools that also match `pool_selector` are checked. */
1918
+ /** Pool beneficiary. Defaults to the calling identity. Only the beneficiary's pools that also match `pool_selector` are checked. */
1919
1919
  beneficiary?: CommonIdentificationData;
1920
1920
  /** Additional information. */
1921
1921
  additionalData?: Record<string, any> | null;
1922
1922
  /**
1923
1923
  * Predefined attributes used to select the pools to check eligibility in.
1924
1924
  *
1925
- * 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.
1925
+ * When omitted, pools in all statuses are checked. Combined with `beneficiary`, `namespace`, and `item_reference`, the selector further narrows which pools are checked.
1926
1926
  */
1927
1927
  poolSelector?: PoolSelector;
1928
1928
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/auto_sdk_benefit-programs_pools",
3
- "version": "1.0.82",
3
+ "version": "1.0.83",
4
4
  "license": "MIT",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/",
@@ -50,5 +50,5 @@
50
50
  "fqdn": "wix.benefit_programs.v1.pool"
51
51
  }
52
52
  },
53
- "falconPackageHash": "89affadf6bf438ed243614d143dcdaa8cbd7fc2c4d64221dc28c6fcf"
53
+ "falconPackageHash": "badab367211e03fa6cc18234b25b86e7607a46604e5b145161d63658"
54
54
  }