@wix/auto_sdk_benefit-programs_pools 1.0.82 → 1.0.84

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;
 }
@@ -2022,7 +2022,7 @@ type CheckBenefitEligibilityByFilterApplicationErrors = {
  * @returns Retrieved pool.
  * @fqn wix.benefit_programs.v1.pool.PoolService.GetPool
  */
-declare function getPool(poolId: string): Promise<NonNullablePaths<Pool, `status` | `beneficiary.anonymousVisitorId` | `beneficiary.memberId` | `beneficiary.wixUserId` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.creditConfiguration.amount` | `displayName` | `programDefinition._id` | `program._id`, 5>>;
+declare function getPool(poolId: string): Promise<NonNullablePaths<Pool, `status` | `beneficiary.anonymousVisitorId` | `beneficiary.memberId` | `beneficiary.wixUserId` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.creditConfiguration.amount` | `displayName` | `programDefinition._id` | `program._id`, 3>>;
 /**
  * Updates a pool.
  *
@@ -2041,7 +2041,7 @@ declare function getPool(poolId: string): Promise<NonNullablePaths<Pool, `status
  * @returns Updated pool.
  * @fqn wix.benefit_programs.v1.pool.PoolService.UpdatePool
  */
-declare function updatePool(_id: string, pool: NonNullablePaths<UpdatePool, `revision`, 2>): Promise<NonNullablePaths<Pool, `status` | `beneficiary.anonymousVisitorId` | `beneficiary.memberId` | `beneficiary.wixUserId` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.creditConfiguration.amount` | `displayName` | `programDefinition._id` | `program._id`, 5>>;
+declare function updatePool(_id: string, pool: NonNullablePaths<UpdatePool, `revision`, 0>): Promise<NonNullablePaths<Pool, `status` | `beneficiary.anonymousVisitorId` | `beneficiary.memberId` | `beneficiary.wixUserId` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.creditConfiguration.amount` | `displayName` | `programDefinition._id` | `program._id`, 3>>;
 interface UpdatePool {
     /**
      * Pool ID.
@@ -2223,7 +2223,7 @@ interface PoolsQueryBuilder {
  * @fqn wix.benefit_programs.v1.pool.PoolService.QueryPools
  * @requiredField query
  */
-declare function typedQueryPools(query: PoolQuery, options?: QueryPoolsOptions): Promise<NonNullablePaths<QueryPoolsResponse, `pools` | `pools.${number}.status` | `pools.${number}.beneficiary.anonymousVisitorId` | `pools.${number}.beneficiary.memberId` | `pools.${number}.beneficiary.wixUserId` | `pools.${number}.details.creditConfiguration.amount` | `pools.${number}.displayName` | `pools.${number}.programDefinition._id` | `pools.${number}.program._id`, 6>>;
+declare function typedQueryPools(query: PoolQuery, options?: QueryPoolsOptions): Promise<NonNullablePaths<QueryPoolsResponse, `pools` | `pools.${number}.status` | `pools.${number}.beneficiary.anonymousVisitorId` | `pools.${number}.beneficiary.memberId` | `pools.${number}.beneficiary.wixUserId` | `pools.${number}.details.creditConfiguration.amount` | `pools.${number}.displayName` | `pools.${number}.programDefinition._id` | `pools.${number}.program._id`, 4>>;
 interface PoolQuerySpec extends QuerySpec {
     paging: 'cursor';
     wql: [
@@ -2314,7 +2314,7 @@ declare const utils: {
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool.PoolService.RedeemBenefit
  */
-declare function redeemBenefit(poolId: string, options?: NonNullablePaths<RedeemBenefitOptions, `benefitKey` | `idempotencyKey` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 3>): Promise<NonNullablePaths<RedeemBenefitResponse, `transactionId`, 2> & {
+declare function redeemBenefit(poolId: string, options?: NonNullablePaths<RedeemBenefitOptions, `benefitKey` | `idempotencyKey` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 1>): Promise<NonNullablePaths<RedeemBenefitResponse, `transactionId`, 0> & {
     __applicationErrorsType?: RedeemBenefitApplicationErrors;
 }>;
 interface RedeemBenefitOptions {
@@ -2394,7 +2394,7 @@ interface CancelRedemptionOptions {
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool.PoolService.CheckBenefitEligibility
  */
-declare function checkBenefitEligibility(poolId: string, options?: NonNullablePaths<CheckBenefitEligibilityOptions, `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 3>): Promise<NonNullablePaths<CheckBenefitEligibilityResponse, `result.benefitResults` | `result.benefitResults.${number}.eligibleBenefitOptions.poolId` | `result.benefitResults.${number}.eligibleBenefitOptions.benefitKey` | `result.benefitResults.${number}.eligibleBenefitOptions.itemReference.externalId` | `result.benefitResults.${number}.eligibleBenefitOptions.itemReference.category` | `result.benefitResults.${number}.eligibleBenefitOptions.itemReference.providerAppId` | `result.benefitResults.${number}.notEnoughBalanceOptions.poolId` | `result.benefitResults.${number}.notEnoughBalanceOptions.availableBalance` | `result.benefitResults.${number}.notEnoughBalanceOptions.requestedBalance` | `result.benefitResults.${number}.policyExpressionEvaluatedToFalseOptions.poolId` | `result.benefitResults.${number}.poolNotActiveOptions.poolId` | `result.benefitResults.${number}.poolNotActiveOptions.poolStatus` | `result.benefitResults.${number}.benefitNotFoundOptions.poolId` | `result.benefitResults.${number}.poolNotFoundOptions.poolId` | `result.benefitResults.${number}.type`, 7>>;
+declare function checkBenefitEligibility(poolId: string, options?: NonNullablePaths<CheckBenefitEligibilityOptions, `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 1>): Promise<NonNullablePaths<CheckBenefitEligibilityResponse, `result.benefitResults` | `result.benefitResults.${number}.eligibleBenefitOptions.poolId` | `result.benefitResults.${number}.eligibleBenefitOptions.benefitKey` | `result.benefitResults.${number}.eligibleBenefitOptions.itemReference.externalId` | `result.benefitResults.${number}.eligibleBenefitOptions.itemReference.category` | `result.benefitResults.${number}.eligibleBenefitOptions.itemReference.providerAppId` | `result.benefitResults.${number}.notEnoughBalanceOptions.poolId` | `result.benefitResults.${number}.notEnoughBalanceOptions.availableBalance` | `result.benefitResults.${number}.notEnoughBalanceOptions.requestedBalance` | `result.benefitResults.${number}.policyExpressionEvaluatedToFalseOptions.poolId` | `result.benefitResults.${number}.poolNotActiveOptions.poolId` | `result.benefitResults.${number}.poolNotActiveOptions.poolStatus` | `result.benefitResults.${number}.benefitNotFoundOptions.poolId` | `result.benefitResults.${number}.poolNotFoundOptions.poolId` | `result.benefitResults.${number}.type`, 5>>;
 interface CheckBenefitEligibilityOptions {
     /**
      * Key of the benefit to check.
@@ -2443,7 +2443,7 @@ interface CheckBenefitEligibilityOptions {
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool.PoolService.BulkCheckBenefitEligibility
  */
-declare function bulkCheckBenefitEligibility(options?: NonNullablePaths<BulkCheckBenefitEligibilityOptions, `benefitSelectors.${number}.itemReference` | `benefitSelectors.${number}.itemReference.externalId` | `benefitSelectors.${number}.itemReference.providerAppId` | `benefitSelectors.${number}.poolId` | `namespace`, 5>): Promise<NonNullablePaths<BulkCheckBenefitEligibilityResponse, `results` | `results.${number}.benefitSelector.poolId` | `results.${number}.benefitSelector.itemReference.externalId` | `results.${number}.benefitSelector.itemReference.category` | `results.${number}.benefitSelector.itemReference.providerAppId` | `results.${number}.benefitSelector.count`, 6>>;
+declare function bulkCheckBenefitEligibility(options?: NonNullablePaths<BulkCheckBenefitEligibilityOptions, `benefitSelectors.${number}.itemReference` | `benefitSelectors.${number}.itemReference.externalId` | `benefitSelectors.${number}.itemReference.providerAppId` | `benefitSelectors.${number}.poolId` | `namespace`, 3>): Promise<NonNullablePaths<BulkCheckBenefitEligibilityResponse, `results` | `results.${number}.benefitSelector.poolId` | `results.${number}.benefitSelector.itemReference.externalId` | `results.${number}.benefitSelector.itemReference.category` | `results.${number}.benefitSelector.itemReference.providerAppId` | `results.${number}.benefitSelector.count`, 4>>;
 interface BulkCheckBenefitEligibilityOptions {
     /**
      * List of benefits to check.
@@ -2475,7 +2475,7 @@ interface BulkCheckBenefitEligibilityOptions {
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool.PoolService.GetEligibleBenefits
  */
-declare function getEligibleBenefits(itemReference: NonNullablePaths<ItemReference, `externalId` | `providerAppId`, 2>, options?: NonNullablePaths<GetEligibleBenefitsOptions, `namespace`, 2>): Promise<NonNullablePaths<GetEligibleBenefitsResponse, `eligibleBenefits` | `eligibleBenefits.${number}.poolId` | `eligibleBenefits.${number}.benefitKey` | `eligibleBenefits.${number}.itemReference.externalId` | `eligibleBenefits.${number}.itemReference.category` | `eligibleBenefits.${number}.itemReference.providerAppId`, 5> & {
+declare function getEligibleBenefits(itemReference: NonNullablePaths<ItemReference, `externalId` | `providerAppId`, 0>, options?: NonNullablePaths<GetEligibleBenefitsOptions, `namespace`, 0>): Promise<NonNullablePaths<GetEligibleBenefitsResponse, `eligibleBenefits` | `eligibleBenefits.${number}.poolId` | `eligibleBenefits.${number}.benefitKey` | `eligibleBenefits.${number}.itemReference.externalId` | `eligibleBenefits.${number}.itemReference.category` | `eligibleBenefits.${number}.itemReference.providerAppId`, 3> & {
     __applicationErrorsType?: GetEligibleBenefitsApplicationErrors;
 }>;
 interface GetEligibleBenefitsOptions {
@@ -2511,7 +2511,7 @@ interface GetEligibleBenefitsOptions {
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool.PoolService.BulkUpdatePools
  */
-declare function bulkUpdatePools(options?: NonNullablePaths<BulkUpdatePoolsOptions, `pools.${number}.pool` | `pools.${number}.pool._id` | `pools.${number}.pool.revision`, 5>): Promise<NonNullablePaths<BulkUpdatePoolsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.status` | `results.${number}.item.beneficiary.anonymousVisitorId` | `results.${number}.item.beneficiary.memberId` | `results.${number}.item.beneficiary.wixUserId` | `results.${number}.item.displayName` | `results.${number}.item.programDefinition._id` | `results.${number}.item.program._id` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
+declare function bulkUpdatePools(options?: NonNullablePaths<BulkUpdatePoolsOptions, `pools.${number}.pool` | `pools.${number}.pool._id` | `pools.${number}.pool.revision`, 3>): Promise<NonNullablePaths<BulkUpdatePoolsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.status` | `results.${number}.item.beneficiary.anonymousVisitorId` | `results.${number}.item.beneficiary.memberId` | `results.${number}.item.beneficiary.wixUserId` | `results.${number}.item.displayName` | `results.${number}.item.programDefinition._id` | `results.${number}.item.program._id` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4>>;
 interface BulkUpdatePoolsOptions {
     /**
      * Pools to update.
@@ -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.
  *
@@ -2545,7 +2545,7 @@ interface BulkUpdatePoolsOptions {
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool.PoolService.CheckBenefitEligibilityByFilter
  */
-declare function checkBenefitEligibilityByFilter(namespace: string, options?: NonNullablePaths<CheckBenefitEligibilityByFilterOptions, `count` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId`, 3>): Promise<NonNullablePaths<CheckBenefitEligibilityByFilterResponse, `results`, 2> & {
+declare function checkBenefitEligibilityByFilter(namespace: string, options?: NonNullablePaths<CheckBenefitEligibilityByFilterOptions, `count` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId`, 1>): Promise<NonNullablePaths<CheckBenefitEligibilityByFilterResponse, `results`, 0> & {
     __applicationErrorsType?: CheckBenefitEligibilityByFilterApplicationErrors;
 }>;
 interface CheckBenefitEligibilityByFilterOptions {
@@ -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;
 }