@wix/auto_sdk_benefit-programs_pools 1.0.87 → 1.0.89

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.
Files changed (19) hide show
  1. package/build/cjs/index.d.ts +2 -2
  2. package/build/cjs/index.js.map +1 -1
  3. package/build/cjs/index.typings.d.ts +50 -2
  4. package/build/cjs/index.typings.js.map +1 -1
  5. package/build/cjs/meta.d.ts +48 -0
  6. package/build/cjs/meta.js.map +1 -1
  7. package/build/es/index.d.mts +2 -2
  8. package/build/es/index.mjs.map +1 -1
  9. package/build/es/index.typings.d.mts +50 -2
  10. package/build/es/index.typings.mjs.map +1 -1
  11. package/build/es/meta.d.mts +48 -0
  12. package/build/es/meta.mjs.map +1 -1
  13. package/build/internal/cjs/index.d.ts +2 -2
  14. package/build/internal/cjs/index.typings.d.ts +21 -80
  15. package/build/internal/cjs/meta.d.ts +19 -78
  16. package/build/internal/es/index.d.mts +2 -2
  17. package/build/internal/es/index.typings.d.mts +21 -80
  18. package/build/internal/es/meta.d.mts +19 -78
  19. package/package.json +4 -4
package/build/internal/cjs/index.d.ts CHANGED
@@ -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`, 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>>;
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}.eligibleBenefitOptions.poolInfo.displayName` | `result.benefitResults.${number}.eligibleBenefitOptions.poolInfo.poolDefinitionId` | `result.benefitResults.${number}.eligibleBenefitOptions.benefitInfo.benefitKey` | `result.benefitResults.${number}.eligibleBenefitOptions.programDefinitionInfo._id` | `result.benefitResults.${number}.eligibleBenefitOptions.programInfo._id` | `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 {
@@ -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`, 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> & {
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` | `eligibleBenefits.${number}.poolInfo.balance.available` | `eligibleBenefits.${number}.poolInfo.balance.reserved` | `eligibleBenefits.${number}.poolInfo.displayName` | `eligibleBenefits.${number}.poolInfo.poolDefinitionId` | `eligibleBenefits.${number}.benefitInfo.benefitKey` | `eligibleBenefits.${number}.programDefinitionInfo._id` | `eligibleBenefits.${number}.programInfo._id`, 4> & {
102
102
  __applicationErrorsType?: GetEligibleBenefitsApplicationErrors;
103
103
  }>;
104
104
  }
package/build/internal/cjs/index.typings.d.ts CHANGED
@@ -1036,25 +1036,13 @@ interface NotEnoughBalance {
1036
1036
  * @decimalValue options { maxScale:4 }
1037
1037
  */
1038
1038
  requestedBalance?: string;
1039
- /**
1040
- * Pool information.
1041
- * @internal
1042
- */
1039
+ /** Pool information. */
1043
1040
  poolInfo?: PoolInfo;
1044
- /**
1045
- * Program definition information.
1046
- * @internal
1047
- */
1041
+ /** Program definition information. */
1048
1042
  programDefinitionInfo?: ProgramDefinitionInfo;
1049
- /**
1050
- * Program information.
1051
- * @internal
1052
- */
1043
+ /** Program information. */
1053
1044
  programInfo?: PoolProgramInfo;
1054
- /**
1055
- * Benefit information.
1056
- * @internal
1057
- */
1045
+ /** Benefit information. */
1058
1046
  benefitInfo?: BenefitInfo;
1059
1047
  }
1060
1048
  interface PoolInfo {
@@ -1082,7 +1070,6 @@ interface PoolInfo {
1082
1070
  poolDefinitionId?: string;
1083
1071
  /**
1084
1072
  * Credit unit type.
1085
- * @internal
1086
1073
  * @maxLength 16
1087
1074
  */
1088
1075
  creditUnitType?: string | null;
@@ -1119,7 +1106,6 @@ interface BenefitInfo {
1119
1106
  benefitKey?: string;
1120
1107
  /**
1121
1108
  * Price of the benefit in credits.
1122
- * @internal
1123
1109
  * @decimalValue options { gte:0, maxScale:4 }
1124
1110
  */
1125
1111
  price?: string | null;
@@ -1137,25 +1123,13 @@ interface PolicyExpressionEvaluatedToFalse {
1137
1123
  * @maxSize 10
1138
1124
  */
1139
1125
  failureDetails?: FailureDetails[];
1140
- /**
1141
- * Pool information.
1142
- * @internal
1143
- */
1126
+ /** Pool information. */
1144
1127
  poolInfo?: PoolInfo;
1145
- /**
1146
- * Program definition information.
1147
- * @internal
1148
- */
1128
+ /** Program definition information. */
1149
1129
  programDefinitionInfo?: ProgramDefinitionInfo;
1150
- /**
1151
- * Program information.
1152
- * @internal
1153
- */
1130
+ /** Program information. */
1154
1131
  programInfo?: PoolProgramInfo;
1155
- /**
1156
- * Benefit information.
1157
- * @internal
1158
- */
1132
+ /** Benefit information. */
1159
1133
  benefitInfo?: BenefitInfo;
1160
1134
  }
1161
1135
  interface FailureDetails {
@@ -1191,25 +1165,13 @@ interface PoolNotActive {
1191
1165
  poolId?: string;
1192
1166
  /** Pool status. */
1193
1167
  poolStatus?: PoolStatusWithLiterals;
1194
- /**
1195
- * Pool information.
1196
- * @internal
1197
- */
1168
+ /** Pool information. */
1198
1169
  poolInfo?: PoolInfo;
1199
- /**
1200
- * Program definition information.
1201
- * @internal
1202
- */
1170
+ /** Program definition information. */
1203
1171
  programDefinitionInfo?: ProgramDefinitionInfo;
1204
- /**
1205
- * Program information.
1206
- * @internal
1207
- */
1172
+ /** Program information. */
1208
1173
  programInfo?: PoolProgramInfo;
1209
- /**
1210
- * Benefit information.
1211
- * @internal
1212
- */
1174
+ /** Benefit information. */
1213
1175
  benefitInfo?: BenefitInfo;
1214
1176
  }
1215
1177
  interface PoolNotFound {
@@ -1242,20 +1204,11 @@ interface BenefitNotFound {
1242
1204
  * @maxLength 64
1243
1205
  */
1244
1206
  benefitKey?: string | null;
1245
- /**
1246
- * Pool information.
1247
- * @internal
1248
- */
1207
+ /** Pool information. */
1249
1208
  poolInfo?: PoolInfo;
1250
- /**
1251
- * Program definition information.
1252
- * @internal
1253
- */
1209
+ /** Program definition information. */
1254
1210
  programDefinitionInfo?: ProgramDefinitionInfo;
1255
- /**
1256
- * Program information.
1257
- * @internal
1258
- */
1211
+ /** Program information. */
1259
1212
  programInfo?: PoolProgramInfo;
1260
1213
  }
1261
1214
  interface ReallocateBenefitRequest {
@@ -1534,25 +1487,13 @@ interface EligibleBenefit {
1534
1487
  * @decimalValue options { gte:0, maxScale:4 }
1535
1488
  */
1536
1489
  price?: string | null;
1537
- /**
1538
- * Pool information.
1539
- * @internal
1540
- */
1490
+ /** Pool information. */
1541
1491
  poolInfo?: PoolInfo;
1542
- /**
1543
- * Benefit information.
1544
- * @internal
1545
- */
1492
+ /** Benefit information. */
1546
1493
  benefitInfo?: BenefitInfo;
1547
- /**
1548
- * Program definition information.
1549
- * @internal
1550
- */
1494
+ /** Program definition information. */
1551
1495
  programDefinitionInfo?: ProgramDefinitionInfo;
1552
- /**
1553
- * Program information.
1554
- * @internal
1555
- */
1496
+ /** Program information. */
1556
1497
  programInfo?: PoolProgramInfo;
1557
1498
  }
1558
1499
  interface BenefitResult extends BenefitResultResultOneOf {
@@ -2687,7 +2628,7 @@ interface CancelRedemptionOptions {
2687
2628
  * @applicableIdentity APP
2688
2629
  * @fqn wix.benefit_programs.v1.pool.PoolService.CheckBenefitEligibility
2689
2630
  */
2690
- 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>>;
2631
+ 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}.eligibleBenefitOptions.poolInfo.displayName` | `result.benefitResults.${number}.eligibleBenefitOptions.poolInfo.poolDefinitionId` | `result.benefitResults.${number}.eligibleBenefitOptions.benefitInfo.benefitKey` | `result.benefitResults.${number}.eligibleBenefitOptions.programDefinitionInfo._id` | `result.benefitResults.${number}.eligibleBenefitOptions.programInfo._id` | `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>>;
2691
2632
  interface CheckBenefitEligibilityOptions {
2692
2633
  /**
2693
2634
  * Key of the benefit to check.
@@ -2775,7 +2716,7 @@ interface BulkCheckBenefitEligibilityOptions {
2775
2716
  * @applicableIdentity APP
2776
2717
  * @fqn wix.benefit_programs.v1.pool.PoolService.GetEligibleBenefits
2777
2718
  */
2778
- 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> & {
2719
+ 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` | `eligibleBenefits.${number}.poolInfo.balance.available` | `eligibleBenefits.${number}.poolInfo.balance.reserved` | `eligibleBenefits.${number}.poolInfo.displayName` | `eligibleBenefits.${number}.poolInfo.poolDefinitionId` | `eligibleBenefits.${number}.benefitInfo.benefitKey` | `eligibleBenefits.${number}.programDefinitionInfo._id` | `eligibleBenefits.${number}.programInfo._id`, 4> & {
2779
2720
  __applicationErrorsType?: GetEligibleBenefitsApplicationErrors;
2780
2721
  }>;
2781
2722
  interface GetEligibleBenefitsOptions {
package/build/internal/cjs/meta.d.ts CHANGED
@@ -1036,25 +1036,13 @@ interface NotEnoughBalance {
1036
1036
  * @decimalValue options { maxScale:4 }
1037
1037
  */
1038
1038
  requestedBalance?: string;
1039
- /**
1040
- * Pool information.
1041
- * @internal
1042
- */
1039
+ /** Pool information. */
1043
1040
  poolInfo?: PoolInfo;
1044
- /**
1045
- * Program definition information.
1046
- * @internal
1047
- */
1041
+ /** Program definition information. */
1048
1042
  programDefinitionInfo?: ProgramDefinitionInfo;
1049
- /**
1050
- * Program information.
1051
- * @internal
1052
- */
1043
+ /** Program information. */
1053
1044
  programInfo?: PoolProgramInfo;
1054
- /**
1055
- * Benefit information.
1056
- * @internal
1057
- */
1045
+ /** Benefit information. */
1058
1046
  benefitInfo?: BenefitInfo;
1059
1047
  }
1060
1048
  interface PoolInfo {
@@ -1082,7 +1070,6 @@ interface PoolInfo {
1082
1070
  poolDefinitionId?: string;
1083
1071
  /**
1084
1072
  * Credit unit type.
1085
- * @internal
1086
1073
  * @maxLength 16
1087
1074
  */
1088
1075
  creditUnitType?: string | null;
@@ -1119,7 +1106,6 @@ interface BenefitInfo {
1119
1106
  benefitKey?: string;
1120
1107
  /**
1121
1108
  * Price of the benefit in credits.
1122
- * @internal
1123
1109
  * @decimalValue options { gte:0, maxScale:4 }
1124
1110
  */
1125
1111
  price?: string | null;
@@ -1137,25 +1123,13 @@ interface PolicyExpressionEvaluatedToFalse {
1137
1123
  * @maxSize 10
1138
1124
  */
1139
1125
  failureDetails?: FailureDetails[];
1140
- /**
1141
- * Pool information.
1142
- * @internal
1143
- */
1126
+ /** Pool information. */
1144
1127
  poolInfo?: PoolInfo;
1145
- /**
1146
- * Program definition information.
1147
- * @internal
1148
- */
1128
+ /** Program definition information. */
1149
1129
  programDefinitionInfo?: ProgramDefinitionInfo;
1150
- /**
1151
- * Program information.
1152
- * @internal
1153
- */
1130
+ /** Program information. */
1154
1131
  programInfo?: PoolProgramInfo;
1155
- /**
1156
- * Benefit information.
1157
- * @internal
1158
- */
1132
+ /** Benefit information. */
1159
1133
  benefitInfo?: BenefitInfo;
1160
1134
  }
1161
1135
  interface FailureDetails {
@@ -1191,25 +1165,13 @@ interface PoolNotActive {
1191
1165
  poolId?: string;
1192
1166
  /** Pool status. */
1193
1167
  poolStatus?: PoolStatusWithLiterals;
1194
- /**
1195
- * Pool information.
1196
- * @internal
1197
- */
1168
+ /** Pool information. */
1198
1169
  poolInfo?: PoolInfo;
1199
- /**
1200
- * Program definition information.
1201
- * @internal
1202
- */
1170
+ /** Program definition information. */
1203
1171
  programDefinitionInfo?: ProgramDefinitionInfo;
1204
- /**
1205
- * Program information.
1206
- * @internal
1207
- */
1172
+ /** Program information. */
1208
1173
  programInfo?: PoolProgramInfo;
1209
- /**
1210
- * Benefit information.
1211
- * @internal
1212
- */
1174
+ /** Benefit information. */
1213
1175
  benefitInfo?: BenefitInfo;
1214
1176
  }
1215
1177
  interface PoolNotFound {
@@ -1242,20 +1204,11 @@ interface BenefitNotFound {
1242
1204
  * @maxLength 64
1243
1205
  */
1244
1206
  benefitKey?: string | null;
1245
- /**
1246
- * Pool information.
1247
- * @internal
1248
- */
1207
+ /** Pool information. */
1249
1208
  poolInfo?: PoolInfo;
1250
- /**
1251
- * Program definition information.
1252
- * @internal
1253
- */
1209
+ /** Program definition information. */
1254
1210
  programDefinitionInfo?: ProgramDefinitionInfo;
1255
- /**
1256
- * Program information.
1257
- * @internal
1258
- */
1211
+ /** Program information. */
1259
1212
  programInfo?: PoolProgramInfo;
1260
1213
  }
1261
1214
  interface ReallocateBenefitRequest {
@@ -1534,25 +1487,13 @@ interface EligibleBenefit {
1534
1487
  * @decimalValue options { gte:0, maxScale:4 }
1535
1488
  */
1536
1489
  price?: string | null;
1537
- /**
1538
- * Pool information.
1539
- * @internal
1540
- */
1490
+ /** Pool information. */
1541
1491
  poolInfo?: PoolInfo;
1542
- /**
1543
- * Benefit information.
1544
- * @internal
1545
- */
1492
+ /** Benefit information. */
1546
1493
  benefitInfo?: BenefitInfo;
1547
- /**
1548
- * Program definition information.
1549
- * @internal
1550
- */
1494
+ /** Program definition information. */
1551
1495
  programDefinitionInfo?: ProgramDefinitionInfo;
1552
- /**
1553
- * Program information.
1554
- * @internal
1555
- */
1496
+ /** Program information. */
1556
1497
  programInfo?: PoolProgramInfo;
1557
1498
  }
1558
1499
  interface BenefitResult extends BenefitResultResultOneOf {
package/build/internal/es/index.d.mts CHANGED
@@ -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`, 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>>;
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}.eligibleBenefitOptions.poolInfo.displayName` | `result.benefitResults.${number}.eligibleBenefitOptions.poolInfo.poolDefinitionId` | `result.benefitResults.${number}.eligibleBenefitOptions.benefitInfo.benefitKey` | `result.benefitResults.${number}.eligibleBenefitOptions.programDefinitionInfo._id` | `result.benefitResults.${number}.eligibleBenefitOptions.programInfo._id` | `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 {
@@ -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`, 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> & {
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` | `eligibleBenefits.${number}.poolInfo.balance.available` | `eligibleBenefits.${number}.poolInfo.balance.reserved` | `eligibleBenefits.${number}.poolInfo.displayName` | `eligibleBenefits.${number}.poolInfo.poolDefinitionId` | `eligibleBenefits.${number}.benefitInfo.benefitKey` | `eligibleBenefits.${number}.programDefinitionInfo._id` | `eligibleBenefits.${number}.programInfo._id`, 4> & {
102
102
  __applicationErrorsType?: GetEligibleBenefitsApplicationErrors;
103
103
  }>;
104
104
  }
package/build/internal/es/index.typings.d.mts CHANGED
@@ -1036,25 +1036,13 @@ interface NotEnoughBalance {
1036
1036
  * @decimalValue options { maxScale:4 }
1037
1037
  */
1038
1038
  requestedBalance?: string;
1039
- /**
1040
- * Pool information.
1041
- * @internal
1042
- */
1039
+ /** Pool information. */
1043
1040
  poolInfo?: PoolInfo;
1044
- /**
1045
- * Program definition information.
1046
- * @internal
1047
- */
1041
+ /** Program definition information. */
1048
1042
  programDefinitionInfo?: ProgramDefinitionInfo;
1049
- /**
1050
- * Program information.
1051
- * @internal
1052
- */
1043
+ /** Program information. */
1053
1044
  programInfo?: PoolProgramInfo;
1054
- /**
1055
- * Benefit information.
1056
- * @internal
1057
- */
1045
+ /** Benefit information. */
1058
1046
  benefitInfo?: BenefitInfo;
1059
1047
  }
1060
1048
  interface PoolInfo {
@@ -1082,7 +1070,6 @@ interface PoolInfo {
1082
1070
  poolDefinitionId?: string;
1083
1071
  /**
1084
1072
  * Credit unit type.
1085
- * @internal
1086
1073
  * @maxLength 16
1087
1074
  */
1088
1075
  creditUnitType?: string | null;
@@ -1119,7 +1106,6 @@ interface BenefitInfo {
1119
1106
  benefitKey?: string;
1120
1107
  /**
1121
1108
  * Price of the benefit in credits.
1122
- * @internal
1123
1109
  * @decimalValue options { gte:0, maxScale:4 }
1124
1110
  */
1125
1111
  price?: string | null;
@@ -1137,25 +1123,13 @@ interface PolicyExpressionEvaluatedToFalse {
1137
1123
  * @maxSize 10
1138
1124
  */
1139
1125
  failureDetails?: FailureDetails[];
1140
- /**
1141
- * Pool information.
1142
- * @internal
1143
- */
1126
+ /** Pool information. */
1144
1127
  poolInfo?: PoolInfo;
1145
- /**
1146
- * Program definition information.
1147
- * @internal
1148
- */
1128
+ /** Program definition information. */
1149
1129
  programDefinitionInfo?: ProgramDefinitionInfo;
1150
- /**
1151
- * Program information.
1152
- * @internal
1153
- */
1130
+ /** Program information. */
1154
1131
  programInfo?: PoolProgramInfo;
1155
- /**
1156
- * Benefit information.
1157
- * @internal
1158
- */
1132
+ /** Benefit information. */
1159
1133
  benefitInfo?: BenefitInfo;
1160
1134
  }
1161
1135
  interface FailureDetails {
@@ -1191,25 +1165,13 @@ interface PoolNotActive {
1191
1165
  poolId?: string;
1192
1166
  /** Pool status. */
1193
1167
  poolStatus?: PoolStatusWithLiterals;
1194
- /**
1195
- * Pool information.
1196
- * @internal
1197
- */
1168
+ /** Pool information. */
1198
1169
  poolInfo?: PoolInfo;
1199
- /**
1200
- * Program definition information.
1201
- * @internal
1202
- */
1170
+ /** Program definition information. */
1203
1171
  programDefinitionInfo?: ProgramDefinitionInfo;
1204
- /**
1205
- * Program information.
1206
- * @internal
1207
- */
1172
+ /** Program information. */
1208
1173
  programInfo?: PoolProgramInfo;
1209
- /**
1210
- * Benefit information.
1211
- * @internal
1212
- */
1174
+ /** Benefit information. */
1213
1175
  benefitInfo?: BenefitInfo;
1214
1176
  }
1215
1177
  interface PoolNotFound {
@@ -1242,20 +1204,11 @@ interface BenefitNotFound {
1242
1204
  * @maxLength 64
1243
1205
  */
1244
1206
  benefitKey?: string | null;
1245
- /**
1246
- * Pool information.
1247
- * @internal
1248
- */
1207
+ /** Pool information. */
1249
1208
  poolInfo?: PoolInfo;
1250
- /**
1251
- * Program definition information.
1252
- * @internal
1253
- */
1209
+ /** Program definition information. */
1254
1210
  programDefinitionInfo?: ProgramDefinitionInfo;
1255
- /**
1256
- * Program information.
1257
- * @internal
1258
- */
1211
+ /** Program information. */
1259
1212
  programInfo?: PoolProgramInfo;
1260
1213
  }
1261
1214
  interface ReallocateBenefitRequest {
@@ -1534,25 +1487,13 @@ interface EligibleBenefit {
1534
1487
  * @decimalValue options { gte:0, maxScale:4 }
1535
1488
  */
1536
1489
  price?: string | null;
1537
- /**
1538
- * Pool information.
1539
- * @internal
1540
- */
1490
+ /** Pool information. */
1541
1491
  poolInfo?: PoolInfo;
1542
- /**
1543
- * Benefit information.
1544
- * @internal
1545
- */
1492
+ /** Benefit information. */
1546
1493
  benefitInfo?: BenefitInfo;
1547
- /**
1548
- * Program definition information.
1549
- * @internal
1550
- */
1494
+ /** Program definition information. */
1551
1495
  programDefinitionInfo?: ProgramDefinitionInfo;
1552
- /**
1553
- * Program information.
1554
- * @internal
1555
- */
1496
+ /** Program information. */
1556
1497
  programInfo?: PoolProgramInfo;
1557
1498
  }
1558
1499
  interface BenefitResult extends BenefitResultResultOneOf {
@@ -2687,7 +2628,7 @@ interface CancelRedemptionOptions {
2687
2628
  * @applicableIdentity APP
2688
2629
  * @fqn wix.benefit_programs.v1.pool.PoolService.CheckBenefitEligibility
2689
2630
  */
2690
- 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>>;
2631
+ 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}.eligibleBenefitOptions.poolInfo.displayName` | `result.benefitResults.${number}.eligibleBenefitOptions.poolInfo.poolDefinitionId` | `result.benefitResults.${number}.eligibleBenefitOptions.benefitInfo.benefitKey` | `result.benefitResults.${number}.eligibleBenefitOptions.programDefinitionInfo._id` | `result.benefitResults.${number}.eligibleBenefitOptions.programInfo._id` | `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>>;
2691
2632
  interface CheckBenefitEligibilityOptions {
2692
2633
  /**
2693
2634
  * Key of the benefit to check.
@@ -2775,7 +2716,7 @@ interface BulkCheckBenefitEligibilityOptions {
2775
2716
  * @applicableIdentity APP
2776
2717
  * @fqn wix.benefit_programs.v1.pool.PoolService.GetEligibleBenefits
2777
2718
  */
2778
- 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> & {
2719
+ 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` | `eligibleBenefits.${number}.poolInfo.balance.available` | `eligibleBenefits.${number}.poolInfo.balance.reserved` | `eligibleBenefits.${number}.poolInfo.displayName` | `eligibleBenefits.${number}.poolInfo.poolDefinitionId` | `eligibleBenefits.${number}.benefitInfo.benefitKey` | `eligibleBenefits.${number}.programDefinitionInfo._id` | `eligibleBenefits.${number}.programInfo._id`, 4> & {
2779
2720
  __applicationErrorsType?: GetEligibleBenefitsApplicationErrors;
2780
2721
  }>;
2781
2722
  interface GetEligibleBenefitsOptions {