@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.
- package/build/cjs/index.d.ts +8 -8
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +14 -9
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +5 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +8 -8
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +14 -9
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +5 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +10 -10
- package/build/internal/cjs/index.typings.d.ts +11 -12
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/es/index.d.mts +10 -10
- package/build/internal/es/index.typings.d.mts +11 -12
- package/build/internal/es/meta.d.mts +0 -1
- package/package.json +2 -2
|
@@ -408,6 +408,11 @@ interface CreditConfiguration {
|
|
|
408
408
|
* @maxLength 32
|
|
409
409
|
*/
|
|
410
410
|
unitDisplayName?: string | null;
|
|
411
|
+
/**
|
|
412
|
+
* Credit unit type.
|
|
413
|
+
* @maxLength 16
|
|
414
|
+
*/
|
|
415
|
+
unitType?: string | null;
|
|
411
416
|
}
|
|
412
417
|
interface RolloverConfiguration {
|
|
413
418
|
/** Whether unused credits roll over to a new cycle when a program renews. */
|
|
@@ -2022,7 +2027,7 @@ type CheckBenefitEligibilityByFilterApplicationErrors = {
|
|
|
2022
2027
|
* @returns Retrieved pool.
|
|
2023
2028
|
* @fqn wix.benefit_programs.v1.pool.PoolService.GetPool
|
|
2024
2029
|
*/
|
|
2025
|
-
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`,
|
|
2030
|
+
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>>;
|
|
2026
2031
|
/**
|
|
2027
2032
|
* Updates a pool.
|
|
2028
2033
|
*
|
|
@@ -2041,7 +2046,7 @@ declare function getPool(poolId: string): Promise<NonNullablePaths<Pool, `status
|
|
|
2041
2046
|
* @returns Updated pool.
|
|
2042
2047
|
* @fqn wix.benefit_programs.v1.pool.PoolService.UpdatePool
|
|
2043
2048
|
*/
|
|
2044
|
-
declare function updatePool(_id: string, pool: NonNullablePaths<UpdatePool, `revision`,
|
|
2049
|
+
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>>;
|
|
2045
2050
|
interface UpdatePool {
|
|
2046
2051
|
/**
|
|
2047
2052
|
* Pool ID.
|
|
@@ -2223,7 +2228,7 @@ interface PoolsQueryBuilder {
|
|
|
2223
2228
|
* @fqn wix.benefit_programs.v1.pool.PoolService.QueryPools
|
|
2224
2229
|
* @requiredField query
|
|
2225
2230
|
*/
|
|
2226
|
-
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`,
|
|
2231
|
+
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>>;
|
|
2227
2232
|
interface PoolQuerySpec extends QuerySpec {
|
|
2228
2233
|
paging: 'cursor';
|
|
2229
2234
|
wql: [
|
|
@@ -2314,7 +2319,7 @@ declare const utils: {
|
|
|
2314
2319
|
* @applicableIdentity APP
|
|
2315
2320
|
* @fqn wix.benefit_programs.v1.pool.PoolService.RedeemBenefit
|
|
2316
2321
|
*/
|
|
2317
|
-
declare function redeemBenefit(poolId: string, options?: NonNullablePaths<RedeemBenefitOptions, `benefitKey` | `idempotencyKey` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`,
|
|
2322
|
+
declare function redeemBenefit(poolId: string, options?: NonNullablePaths<RedeemBenefitOptions, `benefitKey` | `idempotencyKey` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 1>): Promise<NonNullablePaths<RedeemBenefitResponse, `transactionId`, 0> & {
|
|
2318
2323
|
__applicationErrorsType?: RedeemBenefitApplicationErrors;
|
|
2319
2324
|
}>;
|
|
2320
2325
|
interface RedeemBenefitOptions {
|
|
@@ -2394,7 +2399,7 @@ interface CancelRedemptionOptions {
|
|
|
2394
2399
|
* @applicableIdentity APP
|
|
2395
2400
|
* @fqn wix.benefit_programs.v1.pool.PoolService.CheckBenefitEligibility
|
|
2396
2401
|
*/
|
|
2397
|
-
declare function checkBenefitEligibility(poolId: string, options?: NonNullablePaths<CheckBenefitEligibilityOptions, `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`,
|
|
2402
|
+
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>>;
|
|
2398
2403
|
interface CheckBenefitEligibilityOptions {
|
|
2399
2404
|
/**
|
|
2400
2405
|
* Key of the benefit to check.
|
|
@@ -2443,7 +2448,7 @@ interface CheckBenefitEligibilityOptions {
|
|
|
2443
2448
|
* @applicableIdentity APP
|
|
2444
2449
|
* @fqn wix.benefit_programs.v1.pool.PoolService.BulkCheckBenefitEligibility
|
|
2445
2450
|
*/
|
|
2446
|
-
declare function bulkCheckBenefitEligibility(options?: NonNullablePaths<BulkCheckBenefitEligibilityOptions, `benefitSelectors.${number}.itemReference` | `benefitSelectors.${number}.itemReference.externalId` | `benefitSelectors.${number}.itemReference.providerAppId` | `benefitSelectors.${number}.poolId` | `namespace`,
|
|
2451
|
+
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>>;
|
|
2447
2452
|
interface BulkCheckBenefitEligibilityOptions {
|
|
2448
2453
|
/**
|
|
2449
2454
|
* List of benefits to check.
|
|
@@ -2475,7 +2480,7 @@ interface BulkCheckBenefitEligibilityOptions {
|
|
|
2475
2480
|
* @applicableIdentity APP
|
|
2476
2481
|
* @fqn wix.benefit_programs.v1.pool.PoolService.GetEligibleBenefits
|
|
2477
2482
|
*/
|
|
2478
|
-
declare function getEligibleBenefits(itemReference: NonNullablePaths<ItemReference, `externalId` | `providerAppId`,
|
|
2483
|
+
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> & {
|
|
2479
2484
|
__applicationErrorsType?: GetEligibleBenefitsApplicationErrors;
|
|
2480
2485
|
}>;
|
|
2481
2486
|
interface GetEligibleBenefitsOptions {
|
|
@@ -2511,7 +2516,7 @@ interface GetEligibleBenefitsOptions {
|
|
|
2511
2516
|
* @applicableIdentity APP
|
|
2512
2517
|
* @fqn wix.benefit_programs.v1.pool.PoolService.BulkUpdatePools
|
|
2513
2518
|
*/
|
|
2514
|
-
declare function bulkUpdatePools(options?: NonNullablePaths<BulkUpdatePoolsOptions, `pools.${number}.pool` | `pools.${number}.pool._id` | `pools.${number}.pool.revision`,
|
|
2519
|
+
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>>;
|
|
2515
2520
|
interface BulkUpdatePoolsOptions {
|
|
2516
2521
|
/**
|
|
2517
2522
|
* Pools to update.
|
|
@@ -2545,7 +2550,7 @@ interface BulkUpdatePoolsOptions {
|
|
|
2545
2550
|
* @applicableIdentity APP
|
|
2546
2551
|
* @fqn wix.benefit_programs.v1.pool.PoolService.CheckBenefitEligibilityByFilter
|
|
2547
2552
|
*/
|
|
2548
|
-
declare function checkBenefitEligibilityByFilter(namespace: string, options?: NonNullablePaths<CheckBenefitEligibilityByFilterOptions, `count` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId`,
|
|
2553
|
+
declare function checkBenefitEligibilityByFilter(namespace: string, options?: NonNullablePaths<CheckBenefitEligibilityByFilterOptions, `count` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId`, 1>): Promise<NonNullablePaths<CheckBenefitEligibilityByFilterResponse, `results`, 0> & {
|
|
2549
2554
|
__applicationErrorsType?: CheckBenefitEligibilityByFilterApplicationErrors;
|
|
2550
2555
|
}>;
|
|
2551
2556
|
interface CheckBenefitEligibilityByFilterOptions {
|