@wix/auto_sdk_benefit-programs_pools 1.0.83 → 1.0.85

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.
@@ -9,7 +9,7 @@ interface GetPoolSignature {
9
9
  * @param - ID of the pool to retrieve.
10
10
  * @returns Retrieved pool.
11
11
  */
12
- (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>>;
12
+ (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>>;
13
13
  }
14
14
  declare function updatePool$1(httpClient: HttpClient): UpdatePoolSignature;
15
15
  interface UpdatePoolSignature {
@@ -24,7 +24,7 @@ interface UpdatePoolSignature {
24
24
  * @param - Pool ID.
25
25
  * @returns Updated pool.
26
26
  */
27
- (_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>>;
27
+ (_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>>;
28
28
  }
29
29
  declare function redeemBenefit$1(httpClient: HttpClient): RedeemBenefitSignature;
30
30
  interface RedeemBenefitSignature {
@@ -34,7 +34,7 @@ interface RedeemBenefitSignature {
34
34
  * Calling this method records redemption of the benefit and adjusts the pool's associated balance. You still need to handle providing the beneficiary with the item.
35
35
  * @param - ID of the pool that contains the benefit to redeem.
36
36
  */
37
- (poolId: string, options?: NonNullablePaths<RedeemBenefitOptions, `benefitKey` | `idempotencyKey` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 3>): Promise<NonNullablePaths<RedeemBenefitResponse, `transactionId`, 2> & {
37
+ (poolId: string, options?: NonNullablePaths<RedeemBenefitOptions, `benefitKey` | `idempotencyKey` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 1>): Promise<NonNullablePaths<RedeemBenefitResponse, `transactionId`, 0> & {
38
38
  __applicationErrorsType?: RedeemBenefitApplicationErrors;
39
39
  }>;
40
40
  }
@@ -49,7 +49,7 @@ interface ReallocateBenefitSignature {
49
49
  * @param - ID of the latest transaction in the redemption's transaction chain.
50
50
  * For a redemption that has never been reallocated, this is the redemption transaction ID.
51
51
  */
52
- (transactionId: string, options: NonNullablePaths<ReallocateBenefitOptions, `beneficiary` | `idempotencyKey` | `namespace` | `targetDate`, 2>): Promise<NonNullablePaths<ReallocateBenefitResponse, `transactionId`, 2> & {
52
+ (transactionId: string, options: NonNullablePaths<ReallocateBenefitOptions, `beneficiary` | `idempotencyKey` | `namespace` | `targetDate`, 0>): Promise<NonNullablePaths<ReallocateBenefitResponse, `transactionId`, 0> & {
53
53
  __applicationErrorsType?: ReallocateBenefitApplicationErrors;
54
54
  }>;
55
55
  }
@@ -64,7 +64,7 @@ interface CancelRedemptionSignature {
64
64
  * @param - ID of the latest transaction in the redemption's transaction chain.
65
65
  * For a redemption that has never been reallocated, this is the redemption transaction ID.
66
66
  */
67
- (transactionId: string, options: NonNullablePaths<CancelRedemptionOptions, `idempotencyKey`, 2>): Promise<NonNullablePaths<CancelRedemptionResponse, `transactionId`, 2> & {
67
+ (transactionId: string, options: NonNullablePaths<CancelRedemptionOptions, `idempotencyKey`, 0>): Promise<NonNullablePaths<CancelRedemptionResponse, `transactionId`, 0> & {
68
68
  __applicationErrorsType?: CancelRedemptionApplicationErrors;
69
69
  }>;
70
70
  }
@@ -76,7 +76,7 @@ interface CheckBenefitEligibilitySignature {
76
76
  * To be redeemed, a benefit's pool must be active and the associated balance must be greater than the cost of the benefit.
77
77
  * @param - ID of the pool that the benefit to check belongs to.
78
78
  */
79
- (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>>;
79
+ (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>>;
80
80
  }
81
81
  declare function bulkCheckBenefitEligibility$1(httpClient: HttpClient): BulkCheckBenefitEligibilitySignature;
82
82
  interface BulkCheckBenefitEligibilitySignature {
@@ -87,7 +87,7 @@ interface BulkCheckBenefitEligibilitySignature {
87
87
  *
88
88
  * 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.
89
89
  */
90
- (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>>;
90
+ (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>>;
91
91
  }
92
92
  declare function getEligibleBenefits$1(httpClient: HttpClient): GetEligibleBenefitsSignature;
93
93
  interface GetEligibleBenefitsSignature {
@@ -98,7 +98,7 @@ interface GetEligibleBenefitsSignature {
98
98
  * This method checks each pool containing a benefit with this benefit item, and returns the benefits that can be redeemed.
99
99
  * @param - Item reference.
100
100
  */
101
- (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> & {
101
+ (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> & {
102
102
  __applicationErrorsType?: GetEligibleBenefitsApplicationErrors;
103
103
  }>;
104
104
  }
@@ -107,7 +107,7 @@ interface BulkUpdatePoolsSignature {
107
107
  /**
108
108
  * Updates pools.
109
109
  */
110
- (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>>;
110
+ (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>>;
111
111
  }
112
112
  declare function checkBenefitEligibilityByFilter$1(httpClient: HttpClient): CheckBenefitEligibilityByFilterSignature;
113
113
  interface CheckBenefitEligibilityByFilterSignature {
@@ -121,7 +121,7 @@ interface CheckBenefitEligibilityByFilterSignature {
121
121
  * 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.
122
122
  * @param - 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.
123
123
  */
124
- (namespace: string, options?: NonNullablePaths<CheckBenefitEligibilityByFilterOptions, `count` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId`, 3>): Promise<NonNullablePaths<CheckBenefitEligibilityByFilterResponse, `results`, 2> & {
124
+ (namespace: string, options?: NonNullablePaths<CheckBenefitEligibilityByFilterOptions, `count` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId`, 1>): Promise<NonNullablePaths<CheckBenefitEligibilityByFilterResponse, `results`, 0> & {
125
125
  __applicationErrorsType?: CheckBenefitEligibilityByFilterApplicationErrors;
126
126
  }>;
127
127
  }
@@ -465,7 +465,6 @@ interface CreditConfiguration {
465
465
  unitDisplayName?: string | null;
466
466
  /**
467
467
  * Credit unit type.
468
- * @internal
469
468
  * @maxLength 16
470
469
  */
471
470
  unitType?: string | null;
@@ -2226,7 +2225,7 @@ type CheckBenefitEligibilityByFilterApplicationErrors = {
2226
2225
  * @returns Retrieved pool.
2227
2226
  * @fqn wix.benefit_programs.v1.pool.PoolService.GetPool
2228
2227
  */
2229
- 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>>;
2228
+ 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>>;
2230
2229
  /**
2231
2230
  * Updates a pool.
2232
2231
  *
@@ -2245,7 +2244,7 @@ declare function getPool(poolId: string): Promise<NonNullablePaths<Pool, `status
2245
2244
  * @returns Updated pool.
2246
2245
  * @fqn wix.benefit_programs.v1.pool.PoolService.UpdatePool
2247
2246
  */
2248
- 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>>;
2247
+ 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>>;
2249
2248
  interface UpdatePool {
2250
2249
  /**
2251
2250
  * Pool ID.
@@ -2463,7 +2462,7 @@ interface PoolsQueryBuilder {
2463
2462
  * @fqn wix.benefit_programs.v1.pool.PoolService.QueryPools
2464
2463
  * @requiredField query
2465
2464
  */
2466
- 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>>;
2465
+ 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>>;
2467
2466
  interface PoolQuerySpec extends QuerySpec {
2468
2467
  paging: 'cursor';
2469
2468
  wql: [
@@ -2568,7 +2567,7 @@ declare const utils: {
2568
2567
  * @applicableIdentity APP
2569
2568
  * @fqn wix.benefit_programs.v1.pool.PoolService.RedeemBenefit
2570
2569
  */
2571
- declare function redeemBenefit(poolId: string, options?: NonNullablePaths<RedeemBenefitOptions, `benefitKey` | `idempotencyKey` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 3>): Promise<NonNullablePaths<RedeemBenefitResponse, `transactionId`, 2> & {
2570
+ declare function redeemBenefit(poolId: string, options?: NonNullablePaths<RedeemBenefitOptions, `benefitKey` | `idempotencyKey` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 1>): Promise<NonNullablePaths<RedeemBenefitResponse, `transactionId`, 0> & {
2572
2571
  __applicationErrorsType?: RedeemBenefitApplicationErrors;
2573
2572
  }>;
2574
2573
  interface RedeemBenefitOptions {
@@ -2626,7 +2625,7 @@ interface RedeemBenefitOptions {
2626
2625
  * @applicableIdentity APP
2627
2626
  * @fqn wix.benefit_programs.v1.pool.PoolService.ReallocateBenefit
2628
2627
  */
2629
- declare function reallocateBenefit(transactionId: string, options: NonNullablePaths<ReallocateBenefitOptions, `beneficiary` | `idempotencyKey` | `namespace` | `targetDate`, 2>): Promise<NonNullablePaths<ReallocateBenefitResponse, `transactionId`, 2> & {
2628
+ declare function reallocateBenefit(transactionId: string, options: NonNullablePaths<ReallocateBenefitOptions, `beneficiary` | `idempotencyKey` | `namespace` | `targetDate`, 0>): Promise<NonNullablePaths<ReallocateBenefitResponse, `transactionId`, 0> & {
2630
2629
  __applicationErrorsType?: ReallocateBenefitApplicationErrors;
2631
2630
  }>;
2632
2631
  interface ReallocateBenefitOptions {
@@ -2663,7 +2662,7 @@ interface ReallocateBenefitOptions {
2663
2662
  * @applicableIdentity APP
2664
2663
  * @fqn wix.benefit_programs.v1.pool.PoolService.CancelRedemption
2665
2664
  */
2666
- declare function cancelRedemption(transactionId: string, options: NonNullablePaths<CancelRedemptionOptions, `idempotencyKey`, 2>): Promise<NonNullablePaths<CancelRedemptionResponse, `transactionId`, 2> & {
2665
+ declare function cancelRedemption(transactionId: string, options: NonNullablePaths<CancelRedemptionOptions, `idempotencyKey`, 0>): Promise<NonNullablePaths<CancelRedemptionResponse, `transactionId`, 0> & {
2667
2666
  __applicationErrorsType?: CancelRedemptionApplicationErrors;
2668
2667
  }>;
2669
2668
  interface CancelRedemptionOptions {
@@ -2689,7 +2688,7 @@ interface CancelRedemptionOptions {
2689
2688
  * @applicableIdentity APP
2690
2689
  * @fqn wix.benefit_programs.v1.pool.PoolService.CheckBenefitEligibility
2691
2690
  */
2692
- 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>>;
2691
+ 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>>;
2693
2692
  interface CheckBenefitEligibilityOptions {
2694
2693
  /**
2695
2694
  * Key of the benefit to check.
@@ -2745,7 +2744,7 @@ interface CheckBenefitEligibilityOptions {
2745
2744
  * @applicableIdentity APP
2746
2745
  * @fqn wix.benefit_programs.v1.pool.PoolService.BulkCheckBenefitEligibility
2747
2746
  */
2748
- 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>>;
2747
+ 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>>;
2749
2748
  interface BulkCheckBenefitEligibilityOptions {
2750
2749
  /**
2751
2750
  * List of benefits to check.
@@ -2777,7 +2776,7 @@ interface BulkCheckBenefitEligibilityOptions {
2777
2776
  * @applicableIdentity APP
2778
2777
  * @fqn wix.benefit_programs.v1.pool.PoolService.GetEligibleBenefits
2779
2778
  */
2780
- 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> & {
2779
+ 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> & {
2781
2780
  __applicationErrorsType?: GetEligibleBenefitsApplicationErrors;
2782
2781
  }>;
2783
2782
  interface GetEligibleBenefitsOptions {
@@ -2813,7 +2812,7 @@ interface GetEligibleBenefitsOptions {
2813
2812
  * @applicableIdentity APP
2814
2813
  * @fqn wix.benefit_programs.v1.pool.PoolService.BulkUpdatePools
2815
2814
  */
2816
- 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>>;
2815
+ 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>>;
2817
2816
  interface BulkUpdatePoolsOptions {
2818
2817
  /**
2819
2818
  * Pools to update.
@@ -2847,7 +2846,7 @@ interface BulkUpdatePoolsOptions {
2847
2846
  * @applicableIdentity APP
2848
2847
  * @fqn wix.benefit_programs.v1.pool.PoolService.CheckBenefitEligibilityByFilter
2849
2848
  */
2850
- declare function checkBenefitEligibilityByFilter(namespace: string, options?: NonNullablePaths<CheckBenefitEligibilityByFilterOptions, `count` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId`, 3>): Promise<NonNullablePaths<CheckBenefitEligibilityByFilterResponse, `results`, 2> & {
2849
+ declare function checkBenefitEligibilityByFilter(namespace: string, options?: NonNullablePaths<CheckBenefitEligibilityByFilterOptions, `count` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId`, 1>): Promise<NonNullablePaths<CheckBenefitEligibilityByFilterResponse, `results`, 0> & {
2851
2850
  __applicationErrorsType?: CheckBenefitEligibilityByFilterApplicationErrors;
2852
2851
  }>;
2853
2852
  interface CheckBenefitEligibilityByFilterOptions {
@@ -465,7 +465,6 @@ interface CreditConfiguration {
465
465
  unitDisplayName?: string | null;
466
466
  /**
467
467
  * Credit unit type.
468
- * @internal
469
468
  * @maxLength 16
470
469
  */
471
470
  unitType?: string | null;
@@ -9,7 +9,7 @@ interface GetPoolSignature {
9
9
  * @param - ID of the pool to retrieve.
10
10
  * @returns Retrieved pool.
11
11
  */
12
- (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>>;
12
+ (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>>;
13
13
  }
14
14
  declare function updatePool$1(httpClient: HttpClient): UpdatePoolSignature;
15
15
  interface UpdatePoolSignature {
@@ -24,7 +24,7 @@ interface UpdatePoolSignature {
24
24
  * @param - Pool ID.
25
25
  * @returns Updated pool.
26
26
  */
27
- (_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>>;
27
+ (_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>>;
28
28
  }
29
29
  declare function redeemBenefit$1(httpClient: HttpClient): RedeemBenefitSignature;
30
30
  interface RedeemBenefitSignature {
@@ -34,7 +34,7 @@ interface RedeemBenefitSignature {
34
34
  * Calling this method records redemption of the benefit and adjusts the pool's associated balance. You still need to handle providing the beneficiary with the item.
35
35
  * @param - ID of the pool that contains the benefit to redeem.
36
36
  */
37
- (poolId: string, options?: NonNullablePaths<RedeemBenefitOptions, `benefitKey` | `idempotencyKey` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 3>): Promise<NonNullablePaths<RedeemBenefitResponse, `transactionId`, 2> & {
37
+ (poolId: string, options?: NonNullablePaths<RedeemBenefitOptions, `benefitKey` | `idempotencyKey` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 1>): Promise<NonNullablePaths<RedeemBenefitResponse, `transactionId`, 0> & {
38
38
  __applicationErrorsType?: RedeemBenefitApplicationErrors;
39
39
  }>;
40
40
  }
@@ -49,7 +49,7 @@ interface ReallocateBenefitSignature {
49
49
  * @param - ID of the latest transaction in the redemption's transaction chain.
50
50
  * For a redemption that has never been reallocated, this is the redemption transaction ID.
51
51
  */
52
- (transactionId: string, options: NonNullablePaths<ReallocateBenefitOptions, `beneficiary` | `idempotencyKey` | `namespace` | `targetDate`, 2>): Promise<NonNullablePaths<ReallocateBenefitResponse, `transactionId`, 2> & {
52
+ (transactionId: string, options: NonNullablePaths<ReallocateBenefitOptions, `beneficiary` | `idempotencyKey` | `namespace` | `targetDate`, 0>): Promise<NonNullablePaths<ReallocateBenefitResponse, `transactionId`, 0> & {
53
53
  __applicationErrorsType?: ReallocateBenefitApplicationErrors;
54
54
  }>;
55
55
  }
@@ -64,7 +64,7 @@ interface CancelRedemptionSignature {
64
64
  * @param - ID of the latest transaction in the redemption's transaction chain.
65
65
  * For a redemption that has never been reallocated, this is the redemption transaction ID.
66
66
  */
67
- (transactionId: string, options: NonNullablePaths<CancelRedemptionOptions, `idempotencyKey`, 2>): Promise<NonNullablePaths<CancelRedemptionResponse, `transactionId`, 2> & {
67
+ (transactionId: string, options: NonNullablePaths<CancelRedemptionOptions, `idempotencyKey`, 0>): Promise<NonNullablePaths<CancelRedemptionResponse, `transactionId`, 0> & {
68
68
  __applicationErrorsType?: CancelRedemptionApplicationErrors;
69
69
  }>;
70
70
  }
@@ -76,7 +76,7 @@ interface CheckBenefitEligibilitySignature {
76
76
  * To be redeemed, a benefit's pool must be active and the associated balance must be greater than the cost of the benefit.
77
77
  * @param - ID of the pool that the benefit to check belongs to.
78
78
  */
79
- (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>>;
79
+ (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>>;
80
80
  }
81
81
  declare function bulkCheckBenefitEligibility$1(httpClient: HttpClient): BulkCheckBenefitEligibilitySignature;
82
82
  interface BulkCheckBenefitEligibilitySignature {
@@ -87,7 +87,7 @@ interface BulkCheckBenefitEligibilitySignature {
87
87
  *
88
88
  * 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.
89
89
  */
90
- (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>>;
90
+ (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>>;
91
91
  }
92
92
  declare function getEligibleBenefits$1(httpClient: HttpClient): GetEligibleBenefitsSignature;
93
93
  interface GetEligibleBenefitsSignature {
@@ -98,7 +98,7 @@ interface GetEligibleBenefitsSignature {
98
98
  * This method checks each pool containing a benefit with this benefit item, and returns the benefits that can be redeemed.
99
99
  * @param - Item reference.
100
100
  */
101
- (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> & {
101
+ (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> & {
102
102
  __applicationErrorsType?: GetEligibleBenefitsApplicationErrors;
103
103
  }>;
104
104
  }
@@ -107,7 +107,7 @@ interface BulkUpdatePoolsSignature {
107
107
  /**
108
108
  * Updates pools.
109
109
  */
110
- (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>>;
110
+ (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>>;
111
111
  }
112
112
  declare function checkBenefitEligibilityByFilter$1(httpClient: HttpClient): CheckBenefitEligibilityByFilterSignature;
113
113
  interface CheckBenefitEligibilityByFilterSignature {
@@ -121,7 +121,7 @@ interface CheckBenefitEligibilityByFilterSignature {
121
121
  * 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.
122
122
  * @param - 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.
123
123
  */
124
- (namespace: string, options?: NonNullablePaths<CheckBenefitEligibilityByFilterOptions, `count` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId`, 3>): Promise<NonNullablePaths<CheckBenefitEligibilityByFilterResponse, `results`, 2> & {
124
+ (namespace: string, options?: NonNullablePaths<CheckBenefitEligibilityByFilterOptions, `count` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId`, 1>): Promise<NonNullablePaths<CheckBenefitEligibilityByFilterResponse, `results`, 0> & {
125
125
  __applicationErrorsType?: CheckBenefitEligibilityByFilterApplicationErrors;
126
126
  }>;
127
127
  }
@@ -465,7 +465,6 @@ interface CreditConfiguration {
465
465
  unitDisplayName?: string | null;
466
466
  /**
467
467
  * Credit unit type.
468
- * @internal
469
468
  * @maxLength 16
470
469
  */
471
470
  unitType?: string | null;
@@ -2226,7 +2225,7 @@ type CheckBenefitEligibilityByFilterApplicationErrors = {
2226
2225
  * @returns Retrieved pool.
2227
2226
  * @fqn wix.benefit_programs.v1.pool.PoolService.GetPool
2228
2227
  */
2229
- 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>>;
2228
+ 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>>;
2230
2229
  /**
2231
2230
  * Updates a pool.
2232
2231
  *
@@ -2245,7 +2244,7 @@ declare function getPool(poolId: string): Promise<NonNullablePaths<Pool, `status
2245
2244
  * @returns Updated pool.
2246
2245
  * @fqn wix.benefit_programs.v1.pool.PoolService.UpdatePool
2247
2246
  */
2248
- 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>>;
2247
+ 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>>;
2249
2248
  interface UpdatePool {
2250
2249
  /**
2251
2250
  * Pool ID.
@@ -2463,7 +2462,7 @@ interface PoolsQueryBuilder {
2463
2462
  * @fqn wix.benefit_programs.v1.pool.PoolService.QueryPools
2464
2463
  * @requiredField query
2465
2464
  */
2466
- 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>>;
2465
+ 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>>;
2467
2466
  interface PoolQuerySpec extends QuerySpec {
2468
2467
  paging: 'cursor';
2469
2468
  wql: [
@@ -2568,7 +2567,7 @@ declare const utils: {
2568
2567
  * @applicableIdentity APP
2569
2568
  * @fqn wix.benefit_programs.v1.pool.PoolService.RedeemBenefit
2570
2569
  */
2571
- declare function redeemBenefit(poolId: string, options?: NonNullablePaths<RedeemBenefitOptions, `benefitKey` | `idempotencyKey` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 3>): Promise<NonNullablePaths<RedeemBenefitResponse, `transactionId`, 2> & {
2570
+ declare function redeemBenefit(poolId: string, options?: NonNullablePaths<RedeemBenefitOptions, `benefitKey` | `idempotencyKey` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 1>): Promise<NonNullablePaths<RedeemBenefitResponse, `transactionId`, 0> & {
2572
2571
  __applicationErrorsType?: RedeemBenefitApplicationErrors;
2573
2572
  }>;
2574
2573
  interface RedeemBenefitOptions {
@@ -2626,7 +2625,7 @@ interface RedeemBenefitOptions {
2626
2625
  * @applicableIdentity APP
2627
2626
  * @fqn wix.benefit_programs.v1.pool.PoolService.ReallocateBenefit
2628
2627
  */
2629
- declare function reallocateBenefit(transactionId: string, options: NonNullablePaths<ReallocateBenefitOptions, `beneficiary` | `idempotencyKey` | `namespace` | `targetDate`, 2>): Promise<NonNullablePaths<ReallocateBenefitResponse, `transactionId`, 2> & {
2628
+ declare function reallocateBenefit(transactionId: string, options: NonNullablePaths<ReallocateBenefitOptions, `beneficiary` | `idempotencyKey` | `namespace` | `targetDate`, 0>): Promise<NonNullablePaths<ReallocateBenefitResponse, `transactionId`, 0> & {
2630
2629
  __applicationErrorsType?: ReallocateBenefitApplicationErrors;
2631
2630
  }>;
2632
2631
  interface ReallocateBenefitOptions {
@@ -2663,7 +2662,7 @@ interface ReallocateBenefitOptions {
2663
2662
  * @applicableIdentity APP
2664
2663
  * @fqn wix.benefit_programs.v1.pool.PoolService.CancelRedemption
2665
2664
  */
2666
- declare function cancelRedemption(transactionId: string, options: NonNullablePaths<CancelRedemptionOptions, `idempotencyKey`, 2>): Promise<NonNullablePaths<CancelRedemptionResponse, `transactionId`, 2> & {
2665
+ declare function cancelRedemption(transactionId: string, options: NonNullablePaths<CancelRedemptionOptions, `idempotencyKey`, 0>): Promise<NonNullablePaths<CancelRedemptionResponse, `transactionId`, 0> & {
2667
2666
  __applicationErrorsType?: CancelRedemptionApplicationErrors;
2668
2667
  }>;
2669
2668
  interface CancelRedemptionOptions {
@@ -2689,7 +2688,7 @@ interface CancelRedemptionOptions {
2689
2688
  * @applicableIdentity APP
2690
2689
  * @fqn wix.benefit_programs.v1.pool.PoolService.CheckBenefitEligibility
2691
2690
  */
2692
- 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>>;
2691
+ 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>>;
2693
2692
  interface CheckBenefitEligibilityOptions {
2694
2693
  /**
2695
2694
  * Key of the benefit to check.
@@ -2745,7 +2744,7 @@ interface CheckBenefitEligibilityOptions {
2745
2744
  * @applicableIdentity APP
2746
2745
  * @fqn wix.benefit_programs.v1.pool.PoolService.BulkCheckBenefitEligibility
2747
2746
  */
2748
- 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>>;
2747
+ 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>>;
2749
2748
  interface BulkCheckBenefitEligibilityOptions {
2750
2749
  /**
2751
2750
  * List of benefits to check.
@@ -2777,7 +2776,7 @@ interface BulkCheckBenefitEligibilityOptions {
2777
2776
  * @applicableIdentity APP
2778
2777
  * @fqn wix.benefit_programs.v1.pool.PoolService.GetEligibleBenefits
2779
2778
  */
2780
- 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> & {
2779
+ 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> & {
2781
2780
  __applicationErrorsType?: GetEligibleBenefitsApplicationErrors;
2782
2781
  }>;
2783
2782
  interface GetEligibleBenefitsOptions {
@@ -2813,7 +2812,7 @@ interface GetEligibleBenefitsOptions {
2813
2812
  * @applicableIdentity APP
2814
2813
  * @fqn wix.benefit_programs.v1.pool.PoolService.BulkUpdatePools
2815
2814
  */
2816
- 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>>;
2815
+ 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>>;
2817
2816
  interface BulkUpdatePoolsOptions {
2818
2817
  /**
2819
2818
  * Pools to update.
@@ -2847,7 +2846,7 @@ interface BulkUpdatePoolsOptions {
2847
2846
  * @applicableIdentity APP
2848
2847
  * @fqn wix.benefit_programs.v1.pool.PoolService.CheckBenefitEligibilityByFilter
2849
2848
  */
2850
- declare function checkBenefitEligibilityByFilter(namespace: string, options?: NonNullablePaths<CheckBenefitEligibilityByFilterOptions, `count` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId`, 3>): Promise<NonNullablePaths<CheckBenefitEligibilityByFilterResponse, `results`, 2> & {
2849
+ declare function checkBenefitEligibilityByFilter(namespace: string, options?: NonNullablePaths<CheckBenefitEligibilityByFilterOptions, `count` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId`, 1>): Promise<NonNullablePaths<CheckBenefitEligibilityByFilterResponse, `results`, 0> & {
2851
2850
  __applicationErrorsType?: CheckBenefitEligibilityByFilterApplicationErrors;
2852
2851
  }>;
2853
2852
  interface CheckBenefitEligibilityByFilterOptions {
@@ -465,7 +465,6 @@ interface CreditConfiguration {
465
465
  unitDisplayName?: string | null;
466
466
  /**
467
467
  * Credit unit type.
468
- * @internal
469
468
  * @maxLength 16
470
469
  */
471
470
  unitType?: string | null;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/auto_sdk_benefit-programs_pools",
3
- "version": "1.0.83",
3
+ "version": "1.0.85",
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": "badab367211e03fa6cc18234b25b86e7607a46604e5b145161d63658"
53
+ "falconPackageHash": "46a1c9985211c954c82a55d93934c68305aec361102cc4200dc87955"
54
54
  }