@wix/auto_sdk_benefit-programs_pools 1.0.87 → 1.0.88

package/build/es/index.typings.d.mts

@@ -957,6 +957,14 @@ interface NotEnoughBalance {
      * @decimalValue options { maxScale:4 }
      */
     requestedBalance?: string;
+    /** Pool information. */
+    poolInfo?: PoolInfo;
+    /** Program definition information. */
+    programDefinitionInfo?: ProgramDefinitionInfo;
+    /** Program information. */
+    programInfo?: PoolProgramInfo;
+    /** Benefit information. */
+    benefitInfo?: BenefitInfo;
 }
 interface PoolInfo {
     /** Current pool balance */
@@ -981,6 +989,11 @@ interface PoolInfo {
      * @format GUID
      */
     poolDefinitionId?: string;
+    /**
+     * Credit unit type.
+     * @maxLength 16
+     */
+    creditUnitType?: string | null;
 }
 interface BalanceAmount {
     /**
@@ -1012,6 +1025,11 @@ interface BenefitInfo {
      * @maxLength 64
      */
     benefitKey?: string;
+    /**
+     * Price of the benefit in credits.
+     * @decimalValue options { gte:0, maxScale:4 }
+     */
+    price?: string | null;
 }
 interface PolicyExpressionEvaluatedToFalse {
     /**
@@ -1026,6 +1044,14 @@ interface PolicyExpressionEvaluatedToFalse {
      * @maxSize 10
      */
     failureDetails?: FailureDetails[];
+    /** Pool information. */
+    poolInfo?: PoolInfo;
+    /** Program definition information. */
+    programDefinitionInfo?: ProgramDefinitionInfo;
+    /** Program information. */
+    programInfo?: PoolProgramInfo;
+    /** Benefit information. */
+    benefitInfo?: BenefitInfo;
 }
 interface FailureDetails {
     /**
@@ -1060,6 +1086,14 @@ interface PoolNotActive {
     poolId?: string;
     /** Pool status. */
     poolStatus?: PoolStatusWithLiterals;
+    /** Pool information. */
+    poolInfo?: PoolInfo;
+    /** Program definition information. */
+    programDefinitionInfo?: ProgramDefinitionInfo;
+    /** Program information. */
+    programInfo?: PoolProgramInfo;
+    /** Benefit information. */
+    benefitInfo?: BenefitInfo;
 }
 interface PoolNotFound {
     /**
@@ -1091,6 +1125,12 @@ interface BenefitNotFound {
      * @maxLength 64
      */
     benefitKey?: string | null;
+    /** Pool information. */
+    poolInfo?: PoolInfo;
+    /** Program definition information. */
+    programDefinitionInfo?: ProgramDefinitionInfo;
+    /** Program information. */
+    programInfo?: PoolProgramInfo;
 }
 interface ReallocateBenefitRequest {
     /**
@@ -1356,6 +1396,14 @@ interface EligibleBenefit {
      * @decimalValue options { gte:0, maxScale:4 }
      */
     price?: string | null;
+    /** Pool information. */
+    poolInfo?: PoolInfo;
+    /** Benefit information. */
+    benefitInfo?: BenefitInfo;
+    /** Program definition information. */
+    programDefinitionInfo?: ProgramDefinitionInfo;
+    /** Program information. */
+    programInfo?: PoolProgramInfo;
 }
 interface BenefitResult extends BenefitResultResultOneOf {
     /** Returned when item is eligible to be redeemed. */
@@ -2398,7 +2446,7 @@ interface CancelRedemptionOptions {
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool.PoolService.CheckBenefitEligibility
  */
-declare function checkBenefitEligibility(poolId: string, options?: NonNullablePaths<CheckBenefitEligibilityOptions, `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 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>>;
+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>>;
 interface CheckBenefitEligibilityOptions {
     /**
      * Key of the benefit to check.
@@ -2479,7 +2527,7 @@ interface BulkCheckBenefitEligibilityOptions {
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool.PoolService.GetEligibleBenefits
  */
-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> & {
+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> & {
     __applicationErrorsType?: GetEligibleBenefitsApplicationErrors;
 }>;
 interface GetEligibleBenefitsOptions {