@wix/auto_sdk_benefit-programs_pools 1.0.51 → 1.0.53

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

@@ -1224,30 +1224,76 @@ interface CheckBenefitEligibilityResponse {
     result?: EligibilityCheckResult;
 }
 interface EligibilityCheckResult extends EligibilityCheckResultResultOneOf {
-    /** Returned when item is eligible to be redeemed. */
+    /**
+     * Returned when item is eligible to be redeemed.
+     * @deprecated Returned when item is eligible to be redeemed.
+     * @targetRemovalDate 2026-05-31
+     */
     eligibleOptions?: Eligible;
-    /** Returned when the pool's associated balance is lower than the cost of redeeming the items. */
+    /**
+     * Returned when the pool's associated balance is lower than the cost of redeeming the items.
+     * @deprecated Returned when the pool's associated balance is lower than the cost of redeeming the items.
+     * @targetRemovalDate 2026-05-31
+     */
     notEnoughBalanceOptions?: NotEnoughBalance;
-    /** Returned when the pool isn't active. */
+    /**
+     * Returned when the pool isn't active.
+     * @deprecated Returned when the pool isn't active.
+     * @targetRemovalDate 2026-05-31
+     */
     poolNotActiveOptions?: PoolNotActive;
-    /** Returned when invalid benefit details are provided. */
+    /**
+     * Returned when invalid benefit details are provided.
+     * @deprecated Returned when invalid benefit details are provided.
+     * @targetRemovalDate 2026-05-31
+     */
     benefitNotFoundOptions?: BenefitNotFound;
-    /** Returned when invalid pool details are provided. */
+    /**
+     * Returned when invalid pool details are provided.
+     * @deprecated Returned when invalid pool details are provided.
+     * @targetRemovalDate 2026-05-31
+     */
     poolNotFoundOptions?: PoolNotFound;
-    /** Eligibility status. */
+    /**
+     * Eligibility status.
+     * @deprecated Eligibility status.
+     * @targetRemovalDate 2026-05-31
+     */
     type?: EligibilityCheckResultTypeWithLiterals;
+    /** @maxSize 10 */
+    benefitResults?: BenefitResult[];
 }
 /** @oneof */
 interface EligibilityCheckResultResultOneOf {
-    /** Returned when item is eligible to be redeemed. */
+    /**
+     * Returned when item is eligible to be redeemed.
+     * @deprecated Returned when item is eligible to be redeemed.
+     * @targetRemovalDate 2026-05-31
+     */
     eligibleOptions?: Eligible;
-    /** Returned when the pool's associated balance is lower than the cost of redeeming the items. */
+    /**
+     * Returned when the pool's associated balance is lower than the cost of redeeming the items.
+     * @deprecated Returned when the pool's associated balance is lower than the cost of redeeming the items.
+     * @targetRemovalDate 2026-05-31
+     */
     notEnoughBalanceOptions?: NotEnoughBalance;
-    /** Returned when the pool isn't active. */
+    /**
+     * Returned when the pool isn't active.
+     * @deprecated Returned when the pool isn't active.
+     * @targetRemovalDate 2026-05-31
+     */
     poolNotActiveOptions?: PoolNotActive;
-    /** Returned when invalid benefit details are provided. */
+    /**
+     * Returned when invalid benefit details are provided.
+     * @deprecated Returned when invalid benefit details are provided.
+     * @targetRemovalDate 2026-05-31
+     */
     benefitNotFoundOptions?: BenefitNotFound;
-    /** Returned when invalid pool details are provided. */
+    /**
+     * Returned when invalid pool details are provided.
+     * @deprecated Returned when invalid pool details are provided.
+     * @targetRemovalDate 2026-05-31
+     */
     poolNotFoundOptions?: PoolNotFound;
 }
 interface EligibleBenefit {
@@ -1290,6 +1336,22 @@ interface EligibleBenefit {
      */
     programInfo?: PoolProgramInfo;
 }
+declare enum BenefitResultType {
+    /** Unknown eligibility. */
+    UNKNOWN = "UNKNOWN",
+    /** Item is eligible to be redeemed. */
+    ELIGIBLE_BENEFIT = "ELIGIBLE_BENEFIT",
+    /** Balance is lower than the cost of redeeming the items. */
+    NOT_ENOUGH_BALANCE = "NOT_ENOUGH_BALANCE",
+    /** Pool isn't active. */
+    POOL_NOT_ACTIVE = "POOL_NOT_ACTIVE",
+    /** Invalid benefit details provided. */
+    BENEFIT_NOT_FOUND = "BENEFIT_NOT_FOUND",
+    /** Invalid pool details provided. */
+    POOL_NOT_FOUND = "POOL_NOT_FOUND"
+}
+/** @enumType */
+type BenefitResultTypeWithLiterals = BenefitResultType | 'UNKNOWN' | 'ELIGIBLE_BENEFIT' | 'NOT_ENOUGH_BALANCE' | 'POOL_NOT_ACTIVE' | 'BENEFIT_NOT_FOUND' | 'POOL_NOT_FOUND';
 declare enum EligibilityCheckResultType {
     /** Unknown eligibility. */
     UNKNOWN = "UNKNOWN",
@@ -1313,6 +1375,37 @@ interface Eligible {
      */
     eligibleBenefits?: EligibleBenefit[];
 }
+interface BenefitResult extends BenefitResultResultOneOf {
+    /** Returned when item is eligible to be redeemed. */
+    eligibleBenefitOptions?: EligibleBenefit;
+    /** Returned when the pool's associated balance is lower than the cost of redeeming the items. */
+    notEnoughBalanceOptions?: NotEnoughBalance;
+    /** Returned when the policy is false. */
+    policyExpressionEvaluatedToFalseOptions?: PolicyExpressionEvaluatedToFalse;
+    /** Returned when the pool isn't active. */
+    poolNotActiveOptions?: PoolNotActive;
+    /** Returned when invalid benefit details are provided. */
+    benefitNotFoundOptions?: BenefitNotFound;
+    /** Returned when invalid pool details are provided. */
+    poolNotFoundOptions?: PoolNotFound;
+    /** Eligibility status. */
+    type?: BenefitResultTypeWithLiterals;
+}
+/** @oneof */
+interface BenefitResultResultOneOf {
+    /** Returned when item is eligible to be redeemed. */
+    eligibleBenefitOptions?: EligibleBenefit;
+    /** Returned when the pool's associated balance is lower than the cost of redeeming the items. */
+    notEnoughBalanceOptions?: NotEnoughBalance;
+    /** Returned when the policy is false. */
+    policyExpressionEvaluatedToFalseOptions?: PolicyExpressionEvaluatedToFalse;
+    /** Returned when the pool isn't active. */
+    poolNotActiveOptions?: PoolNotActive;
+    /** Returned when invalid benefit details are provided. */
+    benefitNotFoundOptions?: BenefitNotFound;
+    /** Returned when invalid pool details are provided. */
+    poolNotFoundOptions?: PoolNotFound;
+}
 interface BulkCheckBenefitEligibilityRequest {
     /**
      * List of benefits to check.
@@ -1818,6 +1911,8 @@ interface MessageEnvelope {
     identity?: IdentificationData;
     /** Stringify payload. */
     data?: string;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
 }
 interface IdentificationData extends IdentificationDataIdOneOf {
     /**
@@ -2281,7 +2376,7 @@ interface RedeemBenefitOptions {
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool.PoolService.CheckBenefitEligibility
  */
-declare function checkBenefitEligibility(poolId: string, options?: NonNullablePaths<CheckBenefitEligibilityOptions, `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 3>): Promise<NonNullablePaths<CheckBenefitEligibilityResponse, `result.eligibleOptions.eligibleBenefits` | `result.eligibleOptions.eligibleBenefits.${number}.poolId` | `result.eligibleOptions.eligibleBenefits.${number}.benefitKey` | `result.eligibleOptions.eligibleBenefits.${number}.itemReference.externalId` | `result.eligibleOptions.eligibleBenefits.${number}.itemReference.category` | `result.eligibleOptions.eligibleBenefits.${number}.itemReference.providerAppId` | `result.notEnoughBalanceOptions.poolId` | `result.notEnoughBalanceOptions.availableBalance` | `result.notEnoughBalanceOptions.requestedBalance` | `result.poolNotActiveOptions.poolId` | `result.poolNotActiveOptions.poolStatus` | `result.benefitNotFoundOptions.poolId` | `result.poolNotFoundOptions.poolId` | `result.type`, 7>>;
+declare function checkBenefitEligibility(poolId: string, options?: NonNullablePaths<CheckBenefitEligibilityOptions, `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 3>): Promise<NonNullablePaths<CheckBenefitEligibilityResponse, `result.eligibleOptions.eligibleBenefits` | `result.eligibleOptions.eligibleBenefits.${number}.poolId` | `result.eligibleOptions.eligibleBenefits.${number}.benefitKey` | `result.eligibleOptions.eligibleBenefits.${number}.itemReference.externalId` | `result.eligibleOptions.eligibleBenefits.${number}.itemReference.category` | `result.eligibleOptions.eligibleBenefits.${number}.itemReference.providerAppId` | `result.notEnoughBalanceOptions.poolId` | `result.notEnoughBalanceOptions.availableBalance` | `result.notEnoughBalanceOptions.requestedBalance` | `result.poolNotActiveOptions.poolId` | `result.poolNotActiveOptions.poolStatus` | `result.benefitNotFoundOptions.poolId` | `result.poolNotFoundOptions.poolId` | `result.type` | `result.benefitResults` | `result.benefitResults.${number}.policyExpressionEvaluatedToFalseOptions.poolId` | `result.benefitResults.${number}.type`, 7>>;
 interface CheckBenefitEligibilityOptions {
     /**
      * Key of the benefit to check.
@@ -2461,4 +2556,4 @@ interface CheckEligibilityByFilterOptions {
     additionalData?: Record<string, any> | null;
 }
 
-export { type AccountInfo, type ActionEvent, type ApplicationError, type AsyncResult, type BalanceAmount, type Benefit, type BenefitAlreadyRedeemed, type BenefitInfo, type BenefitNotFound, type BenefitRedeemed, type BenefitReservationCanceled, type BenefitReservationReleased, type BenefitReserved, type BenefitSelector, type BulkActionMetadata, type BulkCheckBenefitEligibilityOptions, type BulkCheckBenefitEligibilityRequest, type BulkCheckBenefitEligibilityResponse, type BulkEligibilityCheckResult, type BulkPoolResult, type BulkUpdatePoolsOptions, type BulkUpdatePoolsRequest, type BulkUpdatePoolsResponse, type ByItemReference, type ByItemReferenceFilter, type ByPoolDefinitionIdAndProgramDefinitionIdOptions, type ByProgramIdOptions, type CancelBenefitReservationRequest, type CancelBenefitReservationResponse, type CheckBenefitEligibilityOptions, type CheckBenefitEligibilityRequest, type CheckBenefitEligibilityResponse, type CheckEligibilityByFilterOptions, type CheckEligibilityByFilterRequest, type CheckEligibilityByFilterResponse, type CommonIdentificationData, type CommonIdentificationDataIdOneOf, type CommonQueryWithEntityContext, type CountNumberOfPoolsInProvisioningStatusRequest, type CountNumberOfPoolsInProvisioningStatusResponse, type CreatePoolRequest, type CreatePoolResponse, type CreditConfiguration, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomPolicy, type DeletePoolRequest, type DeletePoolResponse, type Details, type DomainEvent, type DomainEventBodyOneOf, type EligibilityCheckResult, type EligibilityCheckResultResultOneOf, EligibilityCheckResultType, type EligibilityCheckResultTypeWithLiterals, type Eligible, type EligibleBenefit, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type FailureDetails, type Filter, type FilterFilterOneOf, type FixedIntervalPolicy, type GetEligibleBenefitsApplicationErrors, type GetEligibleBenefitsOptions, type GetEligibleBenefitsRequest, type GetEligibleBenefitsResponse, type GetPoolRequest, type GetPoolResponse, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type IdentityTypeWithLiterals, type InvalidPoolDefinitionReference, type ItemMetadata, type ItemReference, type ListPoolsRequest, ListPoolsRequestType, type ListPoolsRequestTypeWithLiterals, type ListPoolsResponse, type MaskedPool, type MessageEnvelope, type NotEnoughBalance, type Policy, type PolicyExpression, type PolicyExpressionAnd, type PolicyExpressionEvaluatedToFalse, type PolicyExpressionExpressionOneOf, type PolicyExpressionNot, type PolicyExpressionOr, PolicyExpressionType, type PolicyExpressionTypeWithLiterals, type PolicyPolicyOneOf, type Pool, type PoolDefinitionAndProgramDefinition, type PoolDefinitionLookupId, type PoolDefinitionLookupIdIdOneOf, type PoolEnded, type PoolFilter, type PoolInfo, type PoolNotActive, type PoolNotFound, PoolOrigin, type PoolOriginWithLiterals, type PoolPaused, type PoolProgramInfo, type PoolProvisionJobFinished, type PoolProvisioned, type PoolQuery, type PoolQuerySpec, type PoolRenewalAction, type PoolRenewalActionActionOneOf, PoolRenewalActionType, type PoolRenewalActionTypeWithLiterals, type PoolRenewed, type PoolResumed, PoolSelectorType, type PoolSelectorTypeWithLiterals, PoolStatus, type PoolStatusUpdateJobFinished, type PoolStatusUpdateJobFinishedContextOneOf, type PoolStatusUpdateParamsPoolInfo, type PoolStatusWithLiterals, type PoolWithItems, type PoolsQueryBuilder, type PoolsQueryResult, type ProgramDefinitionInfo, type ProgramInfo, type ProvisionPoolsForProgramRequest, type ProvisionPoolsForProgramResponse, type ProvisionPoolsForProgramResponseResultOneOf, ProvisionPoolsForProgramResponseType, type ProvisionPoolsForProgramResponseTypeWithLiterals, type QueryPoolsOptions, type QueryPoolsRequest, type QueryPoolsResponse, type RateLimitedPolicy, type RedeemBenefitApplicationErrors, type RedeemBenefitOptions, type RedeemBenefitRequest, type RedeemBenefitResponse, type RedemptionDetails, type ReleaseBenefitReservationRequest, type ReleaseBenefitReservationResponse, type RenewPoolsForProgramRequest, type RenewPoolsForProgramResponse, type ReserveBenefitRequest, type ReserveBenefitResponse, type RestoreInfo, type RolloverConfiguration, SortOrder, type SortOrderWithLiterals, type Sorting, type SyncResult, TimePeriod, type TimePeriodWithLiterals, Type, type TypeWithLiterals, type Update, type UpdatePool, type UpdatePoolRequest, type UpdatePoolResponse, type UpdatePoolStatusRequest, type UpdatePoolStatusRequestPoolSelectorOneOf, type UpdatePoolStatusResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeekDay, type WeekDayWithLiterals, bulkCheckBenefitEligibility, bulkUpdatePools, checkBenefitEligibility, checkEligibilityByFilter, getEligibleBenefits, getPool, queryPools, redeemBenefit, typedQueryPools, updatePool };
+export { type AccountInfo, type ActionEvent, type ApplicationError, type AsyncResult, type BalanceAmount, type Benefit, type BenefitAlreadyRedeemed, type BenefitInfo, type BenefitNotFound, type BenefitRedeemed, type BenefitReservationCanceled, type BenefitReservationReleased, type BenefitReserved, type BenefitResult, type BenefitResultResultOneOf, BenefitResultType, type BenefitResultTypeWithLiterals, type BenefitSelector, type BulkActionMetadata, type BulkCheckBenefitEligibilityOptions, type BulkCheckBenefitEligibilityRequest, type BulkCheckBenefitEligibilityResponse, type BulkEligibilityCheckResult, type BulkPoolResult, type BulkUpdatePoolsOptions, type BulkUpdatePoolsRequest, type BulkUpdatePoolsResponse, type ByItemReference, type ByItemReferenceFilter, type ByPoolDefinitionIdAndProgramDefinitionIdOptions, type ByProgramIdOptions, type CancelBenefitReservationRequest, type CancelBenefitReservationResponse, type CheckBenefitEligibilityOptions, type CheckBenefitEligibilityRequest, type CheckBenefitEligibilityResponse, type CheckEligibilityByFilterOptions, type CheckEligibilityByFilterRequest, type CheckEligibilityByFilterResponse, type CommonIdentificationData, type CommonIdentificationDataIdOneOf, type CommonQueryWithEntityContext, type CountNumberOfPoolsInProvisioningStatusRequest, type CountNumberOfPoolsInProvisioningStatusResponse, type CreatePoolRequest, type CreatePoolResponse, type CreditConfiguration, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomPolicy, type DeletePoolRequest, type DeletePoolResponse, type Details, type DomainEvent, type DomainEventBodyOneOf, type EligibilityCheckResult, type EligibilityCheckResultResultOneOf, EligibilityCheckResultType, type EligibilityCheckResultTypeWithLiterals, type Eligible, type EligibleBenefit, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type FailureDetails, type Filter, type FilterFilterOneOf, type FixedIntervalPolicy, type GetEligibleBenefitsApplicationErrors, type GetEligibleBenefitsOptions, type GetEligibleBenefitsRequest, type GetEligibleBenefitsResponse, type GetPoolRequest, type GetPoolResponse, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type IdentityTypeWithLiterals, type InvalidPoolDefinitionReference, type ItemMetadata, type ItemReference, type ListPoolsRequest, ListPoolsRequestType, type ListPoolsRequestTypeWithLiterals, type ListPoolsResponse, type MaskedPool, type MessageEnvelope, type NotEnoughBalance, type Policy, type PolicyExpression, type PolicyExpressionAnd, type PolicyExpressionEvaluatedToFalse, type PolicyExpressionExpressionOneOf, type PolicyExpressionNot, type PolicyExpressionOr, PolicyExpressionType, type PolicyExpressionTypeWithLiterals, type PolicyPolicyOneOf, type Pool, type PoolDefinitionAndProgramDefinition, type PoolDefinitionLookupId, type PoolDefinitionLookupIdIdOneOf, type PoolEnded, type PoolFilter, type PoolInfo, type PoolNotActive, type PoolNotFound, PoolOrigin, type PoolOriginWithLiterals, type PoolPaused, type PoolProgramInfo, type PoolProvisionJobFinished, type PoolProvisioned, type PoolQuery, type PoolQuerySpec, type PoolRenewalAction, type PoolRenewalActionActionOneOf, PoolRenewalActionType, type PoolRenewalActionTypeWithLiterals, type PoolRenewed, type PoolResumed, PoolSelectorType, type PoolSelectorTypeWithLiterals, PoolStatus, type PoolStatusUpdateJobFinished, type PoolStatusUpdateJobFinishedContextOneOf, type PoolStatusUpdateParamsPoolInfo, type PoolStatusWithLiterals, type PoolWithItems, type PoolsQueryBuilder, type PoolsQueryResult, type ProgramDefinitionInfo, type ProgramInfo, type ProvisionPoolsForProgramRequest, type ProvisionPoolsForProgramResponse, type ProvisionPoolsForProgramResponseResultOneOf, ProvisionPoolsForProgramResponseType, type ProvisionPoolsForProgramResponseTypeWithLiterals, type QueryPoolsOptions, type QueryPoolsRequest, type QueryPoolsResponse, type RateLimitedPolicy, type RedeemBenefitApplicationErrors, type RedeemBenefitOptions, type RedeemBenefitRequest, type RedeemBenefitResponse, type RedemptionDetails, type ReleaseBenefitReservationRequest, type ReleaseBenefitReservationResponse, type RenewPoolsForProgramRequest, type RenewPoolsForProgramResponse, type ReserveBenefitRequest, type ReserveBenefitResponse, type RestoreInfo, type RolloverConfiguration, SortOrder, type SortOrderWithLiterals, type Sorting, type SyncResult, TimePeriod, type TimePeriodWithLiterals, Type, type TypeWithLiterals, type Update, type UpdatePool, type UpdatePoolRequest, type UpdatePoolResponse, type UpdatePoolStatusRequest, type UpdatePoolStatusRequestPoolSelectorOneOf, type UpdatePoolStatusResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeekDay, type WeekDayWithLiterals, bulkCheckBenefitEligibility, bulkUpdatePools, checkBenefitEligibility, checkEligibilityByFilter, getEligibleBenefits, getPool, queryPools, redeemBenefit, typedQueryPools, updatePool };

package/build/internal/es/index.typings.mjs

@@ -565,6 +565,15 @@ var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
   SortOrder2["DESC"] = "DESC";
   return SortOrder2;
 })(SortOrder || {});
+var BenefitResultType = /* @__PURE__ */ ((BenefitResultType2) => {
+  BenefitResultType2["UNKNOWN"] = "UNKNOWN";
+  BenefitResultType2["ELIGIBLE_BENEFIT"] = "ELIGIBLE_BENEFIT";
+  BenefitResultType2["NOT_ENOUGH_BALANCE"] = "NOT_ENOUGH_BALANCE";
+  BenefitResultType2["POOL_NOT_ACTIVE"] = "POOL_NOT_ACTIVE";
+  BenefitResultType2["BENEFIT_NOT_FOUND"] = "BENEFIT_NOT_FOUND";
+  BenefitResultType2["POOL_NOT_FOUND"] = "POOL_NOT_FOUND";
+  return BenefitResultType2;
+})(BenefitResultType || {});
 var EligibilityCheckResultType = /* @__PURE__ */ ((EligibilityCheckResultType2) => {
   EligibilityCheckResultType2["UNKNOWN"] = "UNKNOWN";
   EligibilityCheckResultType2["ELIGIBLE"] = "ELIGIBLE";
@@ -940,6 +949,7 @@ async function checkEligibilityByFilter2(options) {
   }
 }
 export {
+  BenefitResultType,
   EligibilityCheckResultType,
   IdentityType,
   ListPoolsRequestType,