@wix/auto_sdk_benefit-programs_pools 1.0.43 → 1.0.45

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

@@ -368,10 +368,11 @@ interface RateLimitedPolicy {
     /** Time period for the rate limit, resets at the start of each period. */
     timePeriod?: TimePeriodWithLiterals;
     /**
-     * Unique identifier for the quota resource. Set during creation and immutable afterwards.
-     * @format GUID
+     * Unique identifier for the quota resource. Set automatically when creating a policy.
+     * Updating RateLimitedPolicy `time period` or `times` will result in a quota reset.
      * @immutable
      * @readonly
+     * @format GUID
      */
     quotaId?: string | null;
 }
@@ -1243,7 +1244,7 @@ interface BenefitSelector {
     /**
      * Amount of items to check.
      *
-     * Ensures the balance is high enough to redeem this many it
+     * Ensures the balance is high enough to redeem this many items.
      * @min 1
      */
     count?: number;
@@ -1603,7 +1604,7 @@ interface CheckEligibilityByFilterRequest {
     /**
      * Amount of items to check.
      *
-     * Ensures the balance is high enough to redeem this many it
+     * Ensures the balance is high enough to redeem this many items.
      * @min 1
      */
     count: number;
@@ -1614,7 +1615,7 @@ interface CheckEligibilityByFilterRequest {
      */
     targetDate?: Date | null;
     /** Pool beneficiary. */
-    beneficiary: CommonIdentificationData;
+    beneficiary?: CommonIdentificationData;
     /** Additional information. */
     additionalData?: Record<string, any> | null;
 }
@@ -2226,7 +2227,6 @@ interface BulkUpdatePoolsOptions {
  * 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.
  * @internal
  * @documentationMaturity preview
- * @requiredField options.beneficiary
  * @requiredField options.count
  * @requiredField options.itemReference
  * @requiredField options.itemReference.externalId
@@ -2236,7 +2236,7 @@ interface BulkUpdatePoolsOptions {
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool.PoolService.CheckEligibilityByFilter
  */
-declare function checkEligibilityByFilter(options?: NonNullablePaths<CheckEligibilityByFilterOptions, `beneficiary` | `count` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 3>): Promise<NonNullablePaths<CheckEligibilityByFilterResponse, `result` | `result.${number}.notEnoughBalanceOptions.poolId` | `result.${number}.notEnoughBalanceOptions.itemReference.externalId` | `result.${number}.notEnoughBalanceOptions.itemReference.category` | `result.${number}.notEnoughBalanceOptions.itemReference.providerAppId` | `result.${number}.notEnoughBalanceOptions.availableBalance` | `result.${number}.notEnoughBalanceOptions.requestedBalance` | `result.${number}.poolNotActiveOptions.poolId` | `result.${number}.poolNotActiveOptions.poolStatus` | `result.${number}.benefitNotFoundOptions.poolId` | `result.${number}.poolNotFoundOptions.poolId` | `result.${number}.type`, 6>>;
+declare function checkEligibilityByFilter(options?: NonNullablePaths<CheckEligibilityByFilterOptions, `count` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 3>): Promise<NonNullablePaths<CheckEligibilityByFilterResponse, `result` | `result.${number}.notEnoughBalanceOptions.poolId` | `result.${number}.notEnoughBalanceOptions.itemReference.externalId` | `result.${number}.notEnoughBalanceOptions.itemReference.category` | `result.${number}.notEnoughBalanceOptions.itemReference.providerAppId` | `result.${number}.notEnoughBalanceOptions.availableBalance` | `result.${number}.notEnoughBalanceOptions.requestedBalance` | `result.${number}.poolNotActiveOptions.poolId` | `result.${number}.poolNotActiveOptions.poolStatus` | `result.${number}.benefitNotFoundOptions.poolId` | `result.${number}.poolNotFoundOptions.poolId` | `result.${number}.type`, 6>>;
 interface CheckEligibilityByFilterOptions {
     /** Defines filtering and sorting criteria used to select pools when checking eligibility. */
     poolFilter?: PoolFilter;
@@ -2251,7 +2251,7 @@ interface CheckEligibilityByFilterOptions {
     /**
      * Amount of items to check.
      *
-     * Ensures the balance is high enough to redeem this many it
+     * Ensures the balance is high enough to redeem this many items.
      * @min 1
      */
     count: number;
@@ -2262,7 +2262,7 @@ interface CheckEligibilityByFilterOptions {
      */
     targetDate?: Date | null;
     /** Pool beneficiary. */
-    beneficiary: CommonIdentificationData;
+    beneficiary?: CommonIdentificationData;
     /** Additional information. */
     additionalData?: Record<string, any> | null;
 }