@wix/auto_sdk_benefit-programs_pools 1.0.3 → 1.0.4

package/build/internal/cjs/src/benefit-programs-v1-pool-pools.universal.d.ts

@@ -24,45 +24,41 @@ export interface Pool {
      */
     _updatedDate?: Date | null;
     /**
-     * Pool definition from which this benefit pool was created.
+     * ID of the associated pool definition.
      * @format GUID
      * @readonly
      */
     poolDefinitionId?: string | null;
     /**
-     * Program definition from which this benefit pool was provisioned.
+     * ID of the associated program definition.
      * @format GUID
      * @readonly
      */
     programDefinitionId?: string | null;
     /**
-     * ID of the program to which this benefit pool is associated.
+     * ID of the program that contains this pool.
      * @format GUID
      * @readonly
      */
     programId?: string | null;
     /**
-     * Benefit pool status.
+     * Pool status.
      * @readonly
      */
     status?: PoolStatus;
-    /** Benefit pool owner. */
+    /** Pool beneficiary. */
     beneficiary?: CommonIdentificationData;
-    /**
-     * Benefit pool information.
-     *
-     * Includes the item, policy, and credit configurations.
-     */
+    /** Pool benefits and settings. */
     details?: Details;
     /**
      * Pool name.
      *
-     * It's recommended to keep the same as the associated pool definition's `displayName`.
+     * You may want to use the same name that's used in the associated pool definition.
      * @maxLength 64
      */
     displayName?: string;
     /**
-     * External system that is the source of the program creation. For example, `wix-pricing-plans`, `wix-loyalty`.
+     * Namespace for your app or site's benefit programs.
      * @immutable
      * @minLength 1
      * @maxLength 50
@@ -70,66 +66,58 @@ export interface Pool {
     namespace?: string | null;
     /**
      * Custom field data for the pool object.
+     *
      * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
      */
     extendedFields?: ExtendedFields;
     /**
-     * Program definition information.
+     * Associated program definition information.
      * @readonly
      */
     programDefinition?: ProgramDefinitionInfo;
     /**
-     * Program information.
+     * Information about the program containing the pool.
      * @readonly
      */
     program?: PoolProgramInfo;
     /**
-     * Version of the associated pool definition at the this benefit pool was created.
-     *
-     * `poolDefinition.revision`.
+     * Version of the associated pool definition from which this pool was created.
      * @readonly
      */
     poolDefinitionRevision?: string | null;
     /**
-     * Number of times this benefit pool has been renewed.
+     * Number of times this pool has been renewed.
      * @readonly
      */
     renewalCount?: number | null;
 }
 export declare enum PoolStatus {
+    /** Undefined pool status. */
     UNDEFINED = "UNDEFINED",
-    /** Active benefit pool. */
+    /** Pool is active. */
     ACTIVE = "ACTIVE",
-    /** Paused benefit pool. */
+    /** Pool is paused. It can be resumed. */
     PAUSED = "PAUSED",
-    /**
-     * Inactive benefit pool.
-     *
-     * Benefits can't be redeemed or reserved.
-     */
+    /** Pool is ended. It can't be resumed. */
     ENDED = "ENDED",
-    /** Process state of activating the benefit pool's program. */
+    /** Pool is provisioning. This status will be true for a negligible amount of time. */
     PROVISIONING = "PROVISIONING",
-    /**
-     * Process state of renewing the benefits.
-     * Typically at the start of a new benefit renewal cycle.
-     * Result of calling Renew Program API.
-     */
+    /** Pool is renewing. This status will be true for a negligible amount of time. */
     RENEWING = "RENEWING"
 }
 export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
     /**
-     * ID of a site visitor that has not logged in to the site.
+     * ID of a site visitor that hasn't logged in to the site.
      * @format GUID
      */
     anonymousVisitorId?: string;
     /**
-     * ID of a site visitor that has logged in to the site.
+     * ID of a site member.
      * @format GUID
      */
     memberId?: string;
     /**
-     * ID of a Wix user (site owner, contributor, etc.).
+     * ID of a Wix user.
      * @format GUID
      */
     wixUserId?: string;
@@ -137,17 +125,17 @@ export interface CommonIdentificationData extends CommonIdentificationDataIdOneO
 /** @oneof */
 export interface CommonIdentificationDataIdOneOf {
     /**
-     * ID of a site visitor that has not logged in to the site.
+     * ID of a site visitor that hasn't logged in to the site.
      * @format GUID
      */
     anonymousVisitorId?: string;
     /**
-     * ID of a site visitor that has logged in to the site.
+     * ID of a site member.
      * @format GUID
      */
     memberId?: string;
     /**
-     * ID of a Wix user (site owner, contributor, etc.).
+     * ID of a Wix user.
      * @format GUID
      */
     wixUserId?: string;
@@ -164,76 +152,49 @@ export declare enum IdentityType {
 }
 export interface Details {
     /**
-     * Array of benefits, each containing price and policy settings specific to that benefit within the pool.
+     * Array of benefits.
      * @maxSize 10
      */
     benefits?: Benefit[];
     /**
-     * Settings that control the initial credits and renewal cycle configurations of the benefit pool.
+     * Credit settings.
      *
-     * Default: Benefits may be redeemed without limit.
+     * If this object is empty, you can't set a price for the benefit.
      */
     creditConfiguration?: CreditConfiguration;
-    /**
-     * Defines the redemption policy for a benefit pool. This includes specifying the days of the week and the hours during which the benefits can be redeemed.
-     *
-     * Policy types may be either:
-     *
-     * + FIXED INTERVALS: Specifies the timing during the day.
-     *
-     * + RATE LIMITED: Specifies how many times the benefit can be redeemed within a given renewal cycle.
-     *
-     * Each selected policy type must have its corresponding policy options. For example, the `fixedInterval` type requires `fixedIntervalOptions` to be included in the parameters.
-     *
-     * This parameter is the default policy for all the benefits in the benefit pool. It may be overridden for specific benefits in the `details.benefits.policyExpression` parameter.
-     */
-    policyExpression?: PolicyExpression;
-    /** Additional info set by the benefit provider. */
+    /** Additional information relating to this object. */
     additionalData?: Record<string, any> | null;
 }
 export interface Benefit {
     /**
-     * An unique identifier for a pool benefit.
+     * Unique identifier for this benefit.
      *
-     * This key is consistent across the pool definition and all its associated benefit pools.
+     * This key is consistent across the pool definition and all associated pools that contain this benefit.
      * @maxLength 64
      */
     benefitKey?: string;
     /**
-     * Represents the associated benefit item that belongs to a benefit pool.
-     *
-     * This ID is returned when calling Create Item.
-     *
-     * It is used to link the specific benefit item to its corresponding location within the benefit pool, ensuring proper association between the item and the pool definition.
+     * ID that is used to associated items with this benefit.
      * @format GUID
      * @immutable
      * @readonly
      */
     itemSetId?: string | null;
     /**
-     * Price of the benefit item as expressed in credits.
-     * Represents the cost to redeem the benefit.
-     *
-     * Don't set a price if the `details.creditConfiguration` is empty. Since the benefits have an unlimited redemption limit, they can't have an associated price.
+     * Price of the benefit in credits. The price is the same for all of this benefit's items.
      * @decimalValue options { gte:0, maxScale:4 }
      */
     price?: string | null;
-    /**
-     * Defines the redemption policy for a specific benefit. This includes specifying the days of the week and the hours during which the benefits can be redeemed.
-     *
-     * Overrides the default policies in `benefit.details`.
-     */
-    policyExpression?: PolicyExpression;
-    /** Additional info that was set by the benefit provider. */
+    /** Additional information for this benefit. */
     additionalData?: Record<string, any> | null;
     /**
-     * ID of the app providing the benefit.
+     * ID of the app providing the benefit items.
      * @format GUID
      * @immutable
      */
     providerAppId?: string | null;
     /**
-     * Benefit display name.
+     * Benefit name.
      * @maxLength 40
      */
     displayName?: string | null;
@@ -244,50 +205,46 @@ export interface Benefit {
     description?: string | null;
 }
 export interface PolicyExpression extends PolicyExpressionExpressionOneOf {
-    /** Negates the expression. */
+    /** Benefits can be redeemed if the expression in this object is not fulfilled. */
     operatorNotOptions?: PolicyExpressionNot;
-    /** Combines the expressions with an `AND` operator. */
+    /** Benefits can be redeemed if all the expression in this object's array are fulfilled. */
     operatorAndOptions?: PolicyExpressionAnd;
-    /** Combines the expressions with an `OR` operator. */
+    /** Benefits can be redeemed if at least one of the expressions in this object's array is fulfilled. */
     operatorOrOptions?: PolicyExpressionOr;
-    /** Defines policy terms for benefit redemption. */
+    /** Defines when benefits can be redeemed or how many benefits can be redeemed in a specific time period. */
     policyOptions?: Policy;
-    /**
-     * Declare type of policy conditions or settings to use. Use together with the associated policy options to construct policy terms.
-     *
-     * Different operators can be used to combine multiple policy terms.
-     */
+    /** Policy expression type. */
     type?: PolicyExpressionType;
 }
 /** @oneof */
 export interface PolicyExpressionExpressionOneOf {
-    /** Negates the expression. */
+    /** Benefits can be redeemed if the expression in this object is not fulfilled. */
     operatorNotOptions?: PolicyExpressionNot;
-    /** Combines the expressions with an `AND` operator. */
+    /** Benefits can be redeemed if all the expression in this object's array are fulfilled. */
     operatorAndOptions?: PolicyExpressionAnd;
-    /** Combines the expressions with an `OR` operator. */
+    /** Benefits can be redeemed if at least one of the expressions in this object's array is fulfilled. */
     operatorOrOptions?: PolicyExpressionOr;
-    /** Defines policy terms for benefit redemption. */
+    /** Defines when benefits can be redeemed or how many benefits can be redeemed in a specific time period. */
     policyOptions?: Policy;
 }
 export declare enum PolicyExpressionType {
     UNKNOWN = "UNKNOWN",
-    /** Use with associated `operatorNotOptions`. */
+    /** Use with `operatorNotOptions`. */
     OPERATOR_NOT = "OPERATOR_NOT",
-    /** Use with associated `operatorAndOptions`. */
+    /** Use with `operatorAndOptions`. */
     OPERATOR_AND = "OPERATOR_AND",
-    /** Use with associated `operatorOrOptions`. */
+    /** Use with `operatorOrOptions`. */
     OPERATOR_OR = "OPERATOR_OR",
-    /** Use with associated `policyOptions` to define a policy. */
+    /** Use with `policyOptions`. */
     POLICY = "POLICY"
 }
 export interface PolicyExpressionNot {
-    /** Specify policy terms where none of specified policy conditions should be met. Must specify an object with an `expressions` property. */
+    /** Policy expression. If this expression is not fulfilled, benefits can be redeemed. */
     expression?: PolicyExpression;
 }
 export interface PolicyExpressionAnd {
     /**
-     * Specify policy terms where all policy conditions must be met. Must specify an object with an `expressions` property.
+     * Array of policy expressions. If all expressions are fulfilled, benefits can be redeemed.
      * @minSize 2
      * @maxSize 10
      */
@@ -295,62 +252,71 @@ export interface PolicyExpressionAnd {
 }
 export interface PolicyExpressionOr {
     /**
-     * Specify policy terms where at least one of the possible specified policy conditions is met. Must specify an object with an `expressions` property.
+     * Array of policy expressions. If at least one expression is fulfilled, benefits can be redeemed.
      * @minSize 2
      * @maxSize 10
      */
     expressions?: PolicyExpression[];
 }
 export interface Policy extends PolicyPolicyOneOf {
-    /** Defines the timing of benefit policy redemption for specific days or hours. */
+    /**
+     * Defines an interval during which the policy expression is fulfilled.
+     *
+     * If `fromWeekDay` and `toWeekDay` are defined, this interval applies weekly. Otherwise, it applies daily.
+     */
     fixedIntervalOptions?: FixedIntervalPolicy;
-    /** Sets a limit on the number of times a benefit can be redeemed within a given renewal cycle. */
+    /** Maximum amount of times a benefit can be redeemed during a specified time period. */
     rateLimitedOptions?: RateLimitedPolicy;
-    /** Custom policy definition that is controlled by the CustomPolicyProvider. */
+    /** Custom policy defined by a different app. */
     customOptions?: CustomPolicy;
-    /** Specific policy setting. Use together with its associated policy type options. For example, a fixed interval policy type should include a `fixedIntervalOptions` parameter. */
+    /** Policy type. */
     type?: Type;
 }
 /** @oneof */
 export interface PolicyPolicyOneOf {
-    /** Defines the timing of benefit policy redemption for specific days or hours. */
+    /**
+     * Defines an interval during which the policy expression is fulfilled.
+     *
+     * If `fromWeekDay` and `toWeekDay` are defined, this interval applies weekly. Otherwise, it applies daily.
+     */
     fixedIntervalOptions?: FixedIntervalPolicy;
-    /** Sets a limit on the number of times a benefit can be redeemed within a given renewal cycle. */
+    /** Maximum amount of times a benefit can be redeemed during a specified time period. */
     rateLimitedOptions?: RateLimitedPolicy;
-    /** Custom policy definition that is controlled by the CustomPolicyProvider. */
+    /** Custom policy defined by a different app. */
     customOptions?: CustomPolicy;
 }
 export declare enum Type {
     /** Unknown policy type. */
     UNKNOWN = "UNKNOWN",
-    /** Fixed interval policy type. */
+    /** Use with `fixedIntervalOptions`. */
     FIXED_INTERVAL = "FIXED_INTERVAL",
-    /** Rate limited policy type. */
+    /** Use with `rateLimitedOptions`. */
     RATE_LIMITED = "RATE_LIMITED",
+    /** Use with `customOptions`. */
     CUSTOM = "CUSTOM"
 }
 export interface FixedIntervalPolicy {
-    /** Weekday that this interval starts from. If this field is set, then `toWeekDay` must also be set. */
+    /** Weekday that this interval starts from. If this field is defined, then `toWeekDay` is required. */
     fromWeekDay?: WeekDay;
-    /** Weekday that this interval ends at. If this field is set, then `fromWeekDay` must also be set. */
+    /** Weekday that this interval ends at. If this field is defined, then `fromWeekDay` is required. */
     toWeekDay?: WeekDay;
     /**
-     * Hour that this interval starts from. If this field is set, then `toHour` must also be set.
+     * Hour that this interval starts from. If this field is defined, then `toHour` is required.
      * @max 23
      */
     fromHour?: number | null;
     /**
-     * Hour that this interval ends at. If this field is set, then `fromHour` must also be set.
+     * Hour that this interval ends at. If this field is defined, then `fromHour` is required.
      * @max 23
      */
     toHour?: number | null;
     /**
-     * Minute that this interval starts from. If this field is set, then `toMinute` must also be set.
+     * Minute that this interval starts from. If this field is defined, then `toMinute` is required.
      * @max 59
      */
     fromMinute?: number | null;
     /**
-     * Minute that this interval ends at. If this field is set, then `fromMinute` must also be set.
+     * Minute that this interval ends at. If this field is defined, then `fromMinute` is required.
      * @max 59
      */
     toMinute?: number | null;
@@ -374,70 +340,60 @@ export declare enum WeekDay {
     SUNDAY = "SUNDAY"
 }
 export interface RateLimitedPolicy extends RateLimitedPolicyPeriodOneOf {
-    /**
-     * Defines the timing of benefit policy redemption for specific days or hours.
-     *
-     * Used to set the timing policy for a maximum limit of redemptions.
-     */
+    /** Fixed interval used to limit benefit redemption. */
     fixedIntervalOptions?: FixedIntervalPolicy;
-    /** Maximum number of times benefit can be redeemed per renewal cycle. */
+    /** Maximum number of times a benefit can be redeemed per specified time period. */
     times?: number;
-    /** Specific method of setting the benefit limit. `FIXED_INTERVAL` type must be used with its corresponding `fixIntervalPolicyOptions` parameter. */
+    /** Time period type. */
     type?: RateLimitedPolicyType;
 }
 /** @oneof */
 export interface RateLimitedPolicyPeriodOneOf {
-    /**
-     * Defines the timing of benefit policy redemption for specific days or hours.
-     *
-     * Used to set the timing policy for a maximum limit of redemptions.
-     */
+    /** Fixed interval used to limit benefit redemption. */
     fixedIntervalOptions?: FixedIntervalPolicy;
 }
 export declare enum RateLimitedPolicyType {
     /** Unknown rate limit method. */
     UNKNOWN = "UNKNOWN",
-    /** Fixed interval rate limit. The intervals are set using `fixIntervalPolicyOptions`. */
+    /** Time period is defined using `fixedIntervalOptions`. */
     FIXED_INTERVAL = "FIXED_INTERVAL",
-    /** Rate limit is set with `times` field above. */
+    /** Time period is from one program renewal to the next. */
     PER_CYCLE = "PER_CYCLE"
 }
 /** Custom policy as implemented by the Entitlement Policy Provider */
 export interface CustomPolicy {
     /**
-     * References a specific custom policy on the provider's system
+     * Policy ID.
      * @format GUID
      */
     _id?: string;
     /**
-     * Custom policy provider id
+     * ID of the app providing the policy.
      * @format GUID
      */
     appId?: string | null;
-    /** Additional info for this custom policy. It's going to be passed to the policy provider during eligibility checks */
+    /** Additional information for this custom policy. */
     additionalData?: Record<string, any> | null;
 }
 export interface CreditConfiguration {
     /**
-     * The initial total amount of credits available in this benefit pool.
+     * Initial available amount for associated balances.
      * @decimalValue options { gte:0, maxScale:4 }
      */
     amount?: string;
-    /** Rollover configuration. */
+    /** Rollover settings. */
     rolloverConfiguration?: RolloverConfiguration;
     /**
-     * Display name of the unit.
+     * Credit unit display name.
      * @maxLength 32
      */
     unitDisplayName?: string | null;
 }
 export interface RolloverConfiguration {
-    /** Determine whether unused credits are rolled over to the new cycle. */
+    /** Whether any amount of unused credits are rolled over to a new cycle when a program renews. */
     enabled?: boolean | null;
     /**
-     * The maximum amount of credits that can be transferred to the next benefit renewal cycle.
-     *
-     * If current balance exceeds this cap, no credits will transfer into the next renewal cycle until the balance is within the allowable limit.
+     * The maximum amount of credits that can rollover to the next cycle when a program renews.
      * @decimalValue options { gte:0, maxScale:4 }
      */
     balanceCap?: string | null;
@@ -455,15 +411,13 @@ export interface ExtendedFields {
 }
 export interface ProgramDefinitionInfo {
     /**
-     * ID of the program definition that provisioned the program associated with this benefit pool.
+     * Program definition ID.
      * @format GUID
      * @readonly
      */
     _id?: string;
     /**
-     * External ID of the program definition that provisioned this program.
-     *
-     * This identifies the source program definition in the external system.
+     * Program definition external ID.
      * @format GUID
      * @readonly
      */
@@ -471,15 +425,13 @@ export interface ProgramDefinitionInfo {
 }
 export interface PoolProgramInfo {
     /**
-     * ID of the program associated with this benefit pool.
+     * Program ID.
      * @format GUID
      * @readonly
      */
     _id?: string;
     /**
-     * External ID of the program associated with this benefit pool.
-     *
-     * This identifies the source program in the external system.
+     * Program external ID.
      * @format GUID
      * @readonly
      */
@@ -658,7 +610,7 @@ export interface GetPoolResponse {
     pool?: Pool;
 }
 export interface UpdatePoolRequest {
-    /** Pool to be updated. */
+    /** Pool to update. */
     pool: Pool;
 }
 export interface UpdatePoolResponse {
@@ -675,7 +627,7 @@ export interface DeletePoolRequest {
 export interface DeletePoolResponse {
 }
 export interface QueryPoolsRequest {
-    /** Query to select pools. */
+    /** Filter, sort, and paging to apply to the query. */
     query: CursorQuery;
 }
 export interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -733,7 +685,7 @@ export interface CursorPaging {
     cursor?: string | null;
 }
 export interface QueryPoolsResponse {
-    /** List of pools. */
+    /** List of retrieved pools. */
     pools?: Pool[];
     /** Metadata for the paginated results. */
     metadata?: CursorPagingMetadata;
@@ -765,30 +717,26 @@ export interface Cursors {
 }
 export interface RedeemBenefitRequest {
     /**
-     * ID of the benefit pool being redeemed.
+     * ID of the pool that benefit to redeem belongs to.
      * @format GUID
      */
     poolId: string;
-    /** Reference of the benefit item that is being redeemed. */
+    /** Information about the item being to redeem. */
     itemReference: ItemReference;
     /**
-     * Key of the specific benefit to be redeemed.
-     *
-     * This needs to be specified to ensure the correct benefit is redeemed.
+     * Key of the benefit to redeem.
      * @maxLength 64
      */
     benefitKey: string;
     /**
-     * Number of of items to redeem.
+     * Amount of items to redeem.
      * @min 1
      */
     count?: number;
     /**
-     * Date when the benefit item will be used.
-     *
-     * While credit balance is adjusted immediately upon the redemption request, the target date may be set for a later time than the date of the request.
+     * Date that the item will be provided to the beneficiary.
      *
-     * Used for the app providing the benefit items to manage the logistics associated with the item.
+     * The pool's associated balance will update immediately. This parameter should be used to manage the logistics of providing the item.
      */
     targetDate?: Date | null;
     /**
@@ -799,12 +747,10 @@ export interface RedeemBenefitRequest {
     idempotencyKey: string;
     /** Additional information. */
     additionalData?: Record<string, any> | null;
-    /** Benefit pool owner. */
+    /** Beneficiary of the pool containing the benefit to redeem. */
     beneficiary?: CommonIdentificationData;
     /**
-     * Module that is the source of the benefit pool creation.
-     *
-     * Must match the previously defined namespace in the associated pool definition.
+     * Namespace for your app or site's benefit programs.
      * @minLength 1
      * @maxLength 50
      */
@@ -812,40 +758,40 @@ export interface RedeemBenefitRequest {
 }
 export interface RedeemBenefitResponse {
     /**
-     * Id of the resulting transaction.
+     * ID of the transaction recording the associated change in balance.
      * @format GUID
      */
     transactionId?: string;
 }
 export interface NotEnoughBalance {
     /**
-     * Pool ID
+     * Pool ID.
      * @format GUID
      */
     poolId?: string;
-    /** Item reference */
+    /** Item reference. */
     itemReference?: ItemReference;
     /**
-     * Price of the item expressed in credits
+     * Pool's associated balance amount in credits.
      * @decimalValue options { maxScale:4 }
      */
     availableBalance?: string;
     /**
-     * Price of the item expressed in credits
+     * Price of the item in credits.
      * @decimalValue options { maxScale:4 }
      */
     requestedBalance?: string;
 }
 export interface PolicyExpressionEvaluatedToFalse {
     /**
-     * Pool ID
+     * Pool ID.
      * @format GUID
      */
     poolId?: string;
-    /** Item reference */
+    /** Item reference. */
     itemReference?: ItemReference;
     /**
-     * Failure details
+     * Failure details.
      * @maxSize 10
      */
     failureDetails?: FailureDetails[];
@@ -877,16 +823,16 @@ export interface FailureDetails {
 }
 export interface PoolNotActive {
     /**
-     * Pool ID
+     * Pool ID.
      * @format GUID
      */
     poolId?: string;
-    /** Pool status */
+    /** Pool status. */
     poolStatus?: PoolStatus;
 }
 export interface PoolNotFound {
     /**
-     * Pool ID
+     * Pool ID.
      * @format GUID
      */
     poolId?: string;
@@ -905,12 +851,12 @@ export interface BenefitAlreadyRedeemed {
 }
 export interface BenefitNotFound {
     /**
-     * Pool ID
+     * Pool ID.
      * @format GUID
      */
     poolId?: string;
     /**
-     * Key of the referenced benefit, if provided
+     * Provided benefit key.
      * @format GUID
      */
     benefitKey?: string | null;
@@ -1002,106 +948,86 @@ export interface ReleaseBenefitReservationResponse {
 }
 export interface CheckBenefitEligibilityRequest {
     /**
-     * ID of the benefit pool to check eligibility against.
+     * ID of the pool that benefit to check belongs to.
      * @format GUID
      */
     poolId: string;
     /**
-     * Key of the benefit to be redeemed, associated with a particular benefit.
-     *
-     * This key must be specified to ensure the correct benefit is redeemed.
-     *
-     * Default: The first eligible benefit in the benefit pool will be redeemed.
+     * Key of the benefit to check.
      * @maxLength 64
      */
     benefitKey?: string | null;
-    /** Reference of the item for which to check benefit's eligibility. */
+    /** Information about the item being to check. */
     itemReference: ItemReference;
     /**
-     * Number of items for which to check eligibility.
-     *
-     * This number will be evaluated against the policies and credit balance of the benefit pool to determine if sufficient funds are met for the specified number of items.
+     * Amount of items to check. This ensures the balance is high enough to redeem this many items.
      * @min 1
      */
     count?: number;
     /**
-     * Date when the benefit item will be used.
+     * Date that the item will be provided to the beneficiary.
      *
-     * While credit balance is adjusted immediately upon the redemption request, the target date may be set for a later time than the date of the request.
-     *
-     * Used for the app providing the benefit items to manage the logistics associated with the item.
+     * This parameter should be used to manage the potential logistics of providing the item.
      */
     targetDate?: Date | null;
-    /** Additional info */
+    /** Additional information. */
     additionalData?: Record<string, any> | null;
-    /** Benefit pool owner. */
+    /** Beneficiary of the pool containing the benefit to check. */
     beneficiary?: CommonIdentificationData;
     /**
-     * Module that is the source of the benefit pool creation.
-     *
-     * This value must correspond with the previously defined namespace established when creating the associated pool definition.
-     *
-     * It ensures efficient processing and management of pools and benefits.
+     * Namespace for your app or site's benefit programs.
      * @minLength 1
      * @maxLength 50
      */
     namespace: string;
 }
 export interface CheckBenefitEligibilityResponse {
-    /**
-     * Result of the eligibility check. Includes the benefit's eligibility.
-     *
-     * If the benefit is not eligible for redemption, provides a reason for ineligiblity.
-     */
+    /** Result of the eligibility check. */
     result?: EligibilityCheckResult;
 }
 export interface EligibilityCheckResult extends EligibilityCheckResultResultOneOf {
-    /** Set when eligibility check passed. */
+    /** Returned when item is eligible to be redeemed. */
     eligibleOptions?: Eligible;
-    /** Set when balance is insufficient. */
+    /** Returned when balance is lower than the cost of redeeming the items. */
     notEnoughBalanceOptions?: NotEnoughBalance;
-    /** Set when policy expression evaluates to false. */
-    policyExpressionEvaluatedToFalseOptions?: PolicyExpressionEvaluatedToFalse;
-    /** Set when pool is inactive. */
+    /** Returned when the pool isn't active. */
     poolNotActiveOptions?: PoolNotActive;
-    /** Set when benefit can't be found. */
+    /** Returned when invalid benefit details are provided. */
     benefitNotFoundOptions?: BenefitNotFound;
-    /** Set when pool can't be found. */
+    /** Returned when invalid pool details are provided. */
     poolNotFoundOptions?: PoolNotFound;
     /** Eligibility status. */
     type?: EligibilityCheckResultType;
 }
 /** @oneof */
 export interface EligibilityCheckResultResultOneOf {
-    /** Set when eligibility check passed. */
+    /** Returned when item is eligible to be redeemed. */
     eligibleOptions?: Eligible;
-    /** Set when balance is insufficient. */
+    /** Returned when balance is lower than the cost of redeeming the items. */
     notEnoughBalanceOptions?: NotEnoughBalance;
-    /** Set when policy expression evaluates to false. */
-    policyExpressionEvaluatedToFalseOptions?: PolicyExpressionEvaluatedToFalse;
-    /** Set when pool is inactive. */
+    /** Returned when the pool isn't active. */
     poolNotActiveOptions?: PoolNotActive;
-    /** Set when benefit can't be found. */
+    /** Returned when invalid benefit details are provided. */
     benefitNotFoundOptions?: BenefitNotFound;
-    /** Set when pool can't be found. */
+    /** Returned when invalid pool details are provided. */
     poolNotFoundOptions?: PoolNotFound;
 }
 export interface EligibleBenefit {
     /**
-     * Pool ID
+     * Pool ID.
      * @format GUID
      * @readonly
      */
     poolId?: string;
     /**
-     * Key of the specific benefit.
+     * Benefit key.
      * @maxLength 64
      */
     benefitKey?: string;
-    /** Item reference */
+    /** Item reference. */
     itemReference?: ItemReference;
     /**
-     * Price of the item expressed in credits
+     * Price of the benefit in credits.
      * @decimalValue options { gte:0, maxScale:4 }
      */
     price?: string | null;
@@ -1109,126 +1035,108 @@ export interface EligibleBenefit {
 export declare enum EligibilityCheckResultType {
     /** Unknown pool eligibility. */
     UNKNOWN = "UNKNOWN",
-    /** Eligible pool. */
+    /** Item is eligible to be redeemed. */
     ELIGIBLE = "ELIGIBLE",
-    /** Insufficient pool balance. */
+    /** Balance is lower than the cost of redeeming the items. */
     NOT_ENOUGH_BALANCE = "NOT_ENOUGH_BALANCE",
-    /** Policy is false. */
-    POLICY_EXPRESSION_EVALUATED_TO_FALSE = "POLICY_EXPRESSION_EVALUATED_TO_FALSE",
-    /** Inactive pool. */
+    /** Pool isn't active. */
     POOL_NOT_ACTIVE = "POOL_NOT_ACTIVE",
-    /** Invalid benefit. */
+    /** Invalid benefit details provided. */
     BENEFIT_NOT_FOUND = "BENEFIT_NOT_FOUND",
-    /** Invalid pool. */
+    /** Invalid pool details provided. */
     POOL_NOT_FOUND = "POOL_NOT_FOUND"
 }
 export interface Eligible {
     /**
-     * Eligible benefits.
+     * Benefits that are eligible to be redeemed.
      * @maxSize 100
      */
     eligibleBenefits?: EligibleBenefit[];
 }
 export interface BulkCheckBenefitEligibilityRequest {
     /**
-     * Benefits to check eligibility.
+     * List of benefits to check.
      * @minSize 1
      * @maxSize 100
      */
     benefitSelectors?: BenefitSelector[];
     /**
-     * Module that is the source of the benefit pool creation.
-     *
-     * This value must correspond with the previously defined namespace established when creating the associated pool definition.
-     *
-     * It ensures efficient processing and management of pools and benefits.
+     * Namespace for your app or site's benefit programs.
      * @minLength 1
      * @maxLength 50
      */
     namespace: string;
-    /** Benefit pool owner. */
+    /** Pool beneficiary. */
     beneficiary?: CommonIdentificationData;
 }
 export interface BenefitSelector {
     /**
-     * ID of the pool to check for eligibility.
+     * ID of the pool that benefit to check belongs to.
      * @format GUID
      */
     poolId?: string;
     /**
-     * ID of the benefit to check for eligibility.
+     * Key of the benefit to check.
      * @maxLength 64
      */
     benefitKey?: string | null;
-    /** Reference of the item for which to check benefit's eligibility. */
+    /** Information about the item being to check. */
     itemReference?: ItemReference;
     /**
-     * Number of items for which to check eligibility.
-     *
-     * This number will be evaluated against the policies and credit balance of the benefit pool to determine if sufficient funds are met for the specified number of items.
+     * Amount of items to check. This ensures the balance is high enough to redeem this many items.
      * @min 1
      */
     count?: number;
     /**
-     * Date when the benefit item will be used.
+     * Date that the item will be provided to the beneficiary.
      *
-     * While credit balance is adjusted immediately upon the redemption request, the target date may be set for a later time than the date of the request.
-     *
-     * Used for the app providing the benefit items to manage the logistics associated with the item.
+     * This parameter should be used to manage the potential logistics of providing the item.
      */
     targetDate?: Date | null;
-    /** Additional info */
+    /** Additional information. */
     additionalData?: Record<string, any> | null;
 }
 export interface BulkCheckBenefitEligibilityResponse {
     /**
-     * List of results for pool benefit eligibility.
+     * List of results checking each benefit.
      * @minSize 1
      * @maxSize 100
      */
     results?: BulkEligibilityCheckResult[];
 }
 export interface BulkEligibilityCheckResult {
-    /** Retrieved information for each benefit pool. */
+    /** Benefit information specified in API call. */
     benefitSelector?: BenefitSelector;
-    /** Outcome of the eligibility check. */
+    /** Result of the eligibility check. */
     result?: EligibilityCheckResult;
 }
 export interface GetEligibleBenefitsRequest {
-    /** Reference of the item for which all eligible pools will be returned. */
+    /** Item reference. */
     itemReference: ItemReference;
     /**
-     * Number of items for which to check eligibility.
-     *
-     * This number will be evaluated against the policies and credit balance of the benefit pool to determine if sufficient funds are met for the specified number of items.
+     * Amount of items to check. This ensures the balance is high enough to redeem this many items.
      * @min 1
      */
     count?: number;
     /**
-     * Date when the benefit item will be used.
-     *
-     * While credit balance is adjusted immediately upon the redemption request, the target date may be set for a later time than the date of the request.
+     * Date that the item will be provided to the beneficiary.
      *
-     * Used for the app providing the benefit items to manage the logistics associated with the item.
+     * This parameter should be used to manage the potential logistics of providing the item.
      */
     targetDate?: Date | null;
     /** Additional information. */
     additionalData?: Record<string, any> | null;
-    /** Benefit pool owner. */
+    /** Filter request by beneficiary. */
     beneficiary?: CommonIdentificationData;
     /**
-     * Module that is the source of the benefit pool creation.
-     *
-     * This value must correspond with the previously defined namespace established when creating the associated pool definition.
-     *
-     * It ensures efficient processing and management of pools and benefits.
+     * Namespace for your app or site's benefit programs.
      * @minLength 1
      * @maxLength 50
      */
     namespace: string;
 }
 export interface GetEligibleBenefitsResponse {
-    /** Retrieved eligible benefits. */
+    /** Retrieved benefits that can be redeemed. */
     eligibleBenefits?: EligibleBenefit[];
 }
 export interface ListPoolsRequest {
@@ -1319,9 +1227,7 @@ export interface MaskedPool {
 }
 export interface BulkUpdatePoolsResponse {
     /**
-     * List of results for each pool.
-     *
-     * Includes the pool, pool metadata, and whether the update was successful.
+     * List of updated pools and associated metadata.
      * @minSize 1
      * @maxSize 100
      */
@@ -1332,7 +1238,7 @@ export interface BulkUpdatePoolsResponse {
 export interface BulkPoolResult {
     /** Pool metadata. */
     poolMetadata?: ItemMetadata;
-    /** Only exists if `returnEntity` was set to true in the request */
+    /** Pool data. */
     pool?: Pool;
 }
 export interface ItemMetadata {
@@ -1823,7 +1729,7 @@ export interface BulkUpdatePoolsResponseNonNullableFields {
     bulkActionMetadata?: BulkActionMetadataNonNullableFields;
 }
 /**
- * Retrieves a benefit pool.
+ * Retrieves a pool.
  * @param poolId - ID of the pool to retrieve.
  * @public
  * @documentationMaturity preview
@@ -1841,7 +1747,7 @@ export interface BulkUpdatePoolsResponseNonNullableFields {
  */
 export declare function getPool(poolId: string): Promise<Pool & PoolNonNullableFields>;
 /**
- * Updates a benefit pool.
+ * Updates a pool.
  *
  * Each time the pool is updated,
  * `revision` increments by 1.
@@ -1888,45 +1794,41 @@ export interface UpdatePool {
      */
     _updatedDate?: Date | null;
     /**
-     * Pool definition from which this benefit pool was created.
+     * ID of the associated pool definition.
      * @format GUID
      * @readonly
      */
     poolDefinitionId?: string | null;
     /**
-     * Program definition from which this benefit pool was provisioned.
+     * ID of the associated program definition.
      * @format GUID
      * @readonly
      */
     programDefinitionId?: string | null;
     /**
-     * ID of the program to which this benefit pool is associated.
+     * ID of the program that contains this pool.
      * @format GUID
      * @readonly
      */
     programId?: string | null;
     /**
-     * Benefit pool status.
+     * Pool status.
      * @readonly
      */
     status?: PoolStatus;
-    /** Benefit pool owner. */
+    /** Pool beneficiary. */
     beneficiary?: CommonIdentificationData;
-    /**
-     * Benefit pool information.
-     *
-     * Includes the item, policy, and credit configurations.
-     */
+    /** Pool benefits and settings. */
     details?: Details;
     /**
      * Pool name.
      *
-     * It's recommended to keep the same as the associated pool definition's `displayName`.
+     * You may want to use the same name that's used in the associated pool definition.
      * @maxLength 64
      */
     displayName?: string;
     /**
-     * External system that is the source of the program creation. For example, `wix-pricing-plans`, `wix-loyalty`.
+     * Namespace for your app or site's benefit programs.
      * @immutable
      * @minLength 1
      * @maxLength 50
@@ -1934,28 +1836,27 @@ export interface UpdatePool {
     namespace?: string | null;
     /**
      * Custom field data for the pool object.
+     *
      * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
      */
     extendedFields?: ExtendedFields;
     /**
-     * Program definition information.
+     * Associated program definition information.
      * @readonly
      */
     programDefinition?: ProgramDefinitionInfo;
     /**
-     * Program information.
+     * Information about the program containing the pool.
      * @readonly
      */
     program?: PoolProgramInfo;
     /**
-     * Version of the associated pool definition at the this benefit pool was created.
-     *
-     * `poolDefinition.revision`.
+     * Version of the associated pool definition from which this pool was created.
      * @readonly
      */
     poolDefinitionRevision?: string | null;
     /**
-     * Number of times this benefit pool has been renewed.
+     * Number of times this pool has been renewed.
      * @readonly
      */
     renewalCount?: number | null;
@@ -1963,13 +1864,15 @@ export interface UpdatePool {
 /**
  * Creates a query to retrieve a list of pools.
  *
- * The `queryPools()` method builds a query to retrieve a list of pools and returns a `PoolsQueryBuilder` object.
+ * The Query Pools method builds a query to retrieve a list of pools and returns a `PoolsQueryBuilder` object.
+ *
+ * The returned object contains the query definition, which is used to run the query using the `find()` method.
  *
- * The returned object contains the query definition, which is used to run the query using the [`find()`](/pools/pools-query-builder/find) function.
+ * You can refine the query by chaining `PoolsQueryBuilder` methods onto the query. `PoolsQueryBuilder` methods enable you to filter, sort, and control the results that Query Pools returns.
  *
- * You can refine the query by chaining `PoolsQueryBuilder` methods onto the query. `PoolsQueryBuilder` methods enable you to filter, sort, and control the results that `queryPools()` returns.
+ * Query Pools has a default paging limit of 50, which you can override.
  *
- * The following `PoolsQueryBuilder` functions are supported for `queryPools()`. For a full description of the pool object, see the object returned for the [`items`](/pools/pools-query-result/items) property in `PoolsQueryResult`.
+ *  For a full description of the item object, see the object returned for the `items` property in `PoolsQueryResult`.
  * @public
  * @documentationMaturity preview
  * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
@@ -2061,14 +1964,10 @@ export interface PoolsQueryBuilder {
     find: () => Promise<PoolsQueryResult>;
 }
 /**
- * Redeems a benefit by the pool owner in exchange for available credits from the benefit pool.
- *
- * The mechanism of purchasing specified benefit items.
+ * Redeems a specified benefit.
  *
- * Benefit redemption adjusts the available credits in the pool's balance to reflect the new balance after the transaction.
- *
- * Upon redemption, a new transaction is created, maintaining balance history for the benefit pool.
- * @param poolId - ID of the benefit pool being redeemed.
+ * 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.
+ * @param poolId - ID of the pool that benefit to redeem belongs to.
  * @public
  * @documentationMaturity preview
  * @requiredField options.benefitKey
@@ -2086,26 +1985,22 @@ export interface PoolsQueryBuilder {
  */
 export declare function redeemBenefit(poolId: string, options?: RedeemBenefitOptions): Promise<RedeemBenefitResponse & RedeemBenefitResponseNonNullableFields>;
 export interface RedeemBenefitOptions {
-    /** Reference of the benefit item that is being redeemed. */
+    /** Information about the item being to redeem. */
     itemReference: ItemReference;
     /**
-     * Key of the specific benefit to be redeemed.
-     *
-     * This needs to be specified to ensure the correct benefit is redeemed.
+     * Key of the benefit to redeem.
      * @maxLength 64
      */
     benefitKey: string;
     /**
-     * Number of of items to redeem.
+     * Amount of items to redeem.
      * @min 1
      */
     count?: number;
     /**
-     * Date when the benefit item will be used.
-     *
-     * While credit balance is adjusted immediately upon the redemption request, the target date may be set for a later time than the date of the request.
+     * Date that the item will be provided to the beneficiary.
      *
-     * Used for the app providing the benefit items to manage the logistics associated with the item.
+     * The pool's associated balance will update immediately. This parameter should be used to manage the logistics of providing the item.
      */
     targetDate?: Date | null;
     /**
@@ -2116,22 +2011,20 @@ export interface RedeemBenefitOptions {
     idempotencyKey: string;
     /** Additional information. */
     additionalData?: Record<string, any> | null;
-    /** Benefit pool owner. */
+    /** Beneficiary of the pool containing the benefit to redeem. */
     beneficiary?: CommonIdentificationData;
     /**
-     * Module that is the source of the benefit pool creation.
-     *
-     * Must match the previously defined namespace in the associated pool definition.
+     * Namespace for your app or site's benefit programs.
      * @minLength 1
      * @maxLength 50
      */
     namespace: string;
 }
 /**
- * Checks if a benefit can be redeemed based on the current credit status of the benefit pool.
+ * Checks if a benefit can currently be redeemed.
  *
- * Manually verify if their is a sufficient credit balance, and that all policy requirements are met prior to redeeming the benefit.
- * @param poolId - ID of the benefit pool to check eligibility against.
+ * In order to be a redeemed, a benefit's pool must be active and the associated balance must greater than the cost of the benefit.
+ * @param poolId - ID of the pool that benefit to check belongs to.
  * @public
  * @documentationMaturity preview
  * @requiredField options.itemReference
@@ -2148,50 +2041,38 @@ export interface RedeemBenefitOptions {
 export declare function checkBenefitEligibility(poolId: string, options?: CheckBenefitEligibilityOptions): Promise<CheckBenefitEligibilityResponse & CheckBenefitEligibilityResponseNonNullableFields>;
 export interface CheckBenefitEligibilityOptions {
     /**
-     * Key of the benefit to be redeemed, associated with a particular benefit.
-     *
-     * This key must be specified to ensure the correct benefit is redeemed.
-     *
-     * Default: The first eligible benefit in the benefit pool will be redeemed.
+     * Key of the benefit to check.
      * @maxLength 64
      */
     benefitKey?: string | null;
-    /** Reference of the item for which to check benefit's eligibility. */
+    /** Information about the item being to check. */
     itemReference: ItemReference;
     /**
-     * Number of items for which to check eligibility.
-     *
-     * This number will be evaluated against the policies and credit balance of the benefit pool to determine if sufficient funds are met for the specified number of items.
+     * Amount of items to check. This ensures the balance is high enough to redeem this many items.
      * @min 1
      */
     count?: number;
     /**
-     * Date when the benefit item will be used.
+     * Date that the item will be provided to the beneficiary.
      *
-     * While credit balance is adjusted immediately upon the redemption request, the target date may be set for a later time than the date of the request.
-     *
-     * Used for the app providing the benefit items to manage the logistics associated with the item.
+     * This parameter should be used to manage the potential logistics of providing the item.
      */
     targetDate?: Date | null;
-    /** Additional info */
+    /** Additional information. */
     additionalData?: Record<string, any> | null;
-    /** Benefit pool owner. */
+    /** Beneficiary of the pool containing the benefit to check. */
     beneficiary?: CommonIdentificationData;
     /**
-     * Module that is the source of the benefit pool creation.
-     *
-     * This value must correspond with the previously defined namespace established when creating the associated pool definition.
-     *
-     * It ensures efficient processing and management of pools and benefits.
+     * Namespace for your app or site's benefit programs.
      * @minLength 1
      * @maxLength 50
      */
     namespace: string;
 }
 /**
- * Checks if multiple benefits can be redeemed based on the current credit balance of the benefit pool.
+ * Checks if benefits can currently be redeemed.
  *
- * Used to manually check if their is a sufficient credit balance, and that all policy requirements are met prior to redeeming the benefits.
+ * In order to be a redeemed, a benefit's pool must be active and the associated balance must greater than the cost of the benefit. Each benefit is checked independently.
  * @public
  * @documentationMaturity preview
  * @requiredField options.benefitSelectors.itemReference
@@ -2208,27 +2089,26 @@ export interface CheckBenefitEligibilityOptions {
 export declare function bulkCheckBenefitEligibility(options?: BulkCheckBenefitEligibilityOptions): Promise<BulkCheckBenefitEligibilityResponse & BulkCheckBenefitEligibilityResponseNonNullableFields>;
 export interface BulkCheckBenefitEligibilityOptions {
     /**
-     * Benefits to check eligibility.
+     * List of benefits to check.
      * @minSize 1
      * @maxSize 100
      */
     benefitSelectors?: BenefitSelector[];
     /**
-     * Module that is the source of the benefit pool creation.
-     *
-     * This value must correspond with the previously defined namespace established when creating the associated pool definition.
-     *
-     * It ensures efficient processing and management of pools and benefits.
+     * Namespace for your app or site's benefit programs.
      * @minLength 1
      * @maxLength 50
      */
     namespace: string;
-    /** Benefit pool owner. */
+    /** Pool beneficiary. */
     beneficiary?: CommonIdentificationData;
 }
 /**
- * Retrieve available benefits that can be redeemed based on the current credit balance of the benefit pool.
- * @param itemReference - Reference of the item for which all eligible pools will be returned.
+ * Retrieve benefits that can be redeemed for a specific item.
+ *
+ * Each item can only be linked to 1 benefit in 1 pool definition. However, each pool created from that pool definition contains a benefit with this item.
+ * This method checks each benefits with this item, and returns the benefits that can be redeemed.
+ * @param itemReference - Item reference.
  * @public
  * @documentationMaturity preview
  * @requiredField itemReference
@@ -2248,37 +2128,29 @@ export interface BulkCheckBenefitEligibilityOptions {
 export declare function getEligibleBenefits(itemReference: ItemReference, options?: GetEligibleBenefitsOptions): Promise<GetEligibleBenefitsResponse & GetEligibleBenefitsResponseNonNullableFields>;
 export interface GetEligibleBenefitsOptions {
     /**
-     * Number of items for which to check eligibility.
-     *
-     * This number will be evaluated against the policies and credit balance of the benefit pool to determine if sufficient funds are met for the specified number of items.
+     * Amount of items to check. This ensures the balance is high enough to redeem this many items.
      * @min 1
      */
     count?: number;
     /**
-     * Date when the benefit item will be used.
-     *
-     * While credit balance is adjusted immediately upon the redemption request, the target date may be set for a later time than the date of the request.
+     * Date that the item will be provided to the beneficiary.
      *
-     * Used for the app providing the benefit items to manage the logistics associated with the item.
+     * This parameter should be used to manage the potential logistics of providing the item.
      */
     targetDate?: Date | null;
     /** Additional information. */
     additionalData?: Record<string, any> | null;
-    /** Benefit pool owner. */
+    /** Filter request by beneficiary. */
     beneficiary?: CommonIdentificationData;
     /**
-     * Module that is the source of the benefit pool creation.
-     *
-     * This value must correspond with the previously defined namespace established when creating the associated pool definition.
-     *
-     * It ensures efficient processing and management of pools and benefits.
+     * Namespace for your app or site's benefit programs.
      * @minLength 1
      * @maxLength 50
      */
     namespace: string;
 }
 /**
- * Updates multiple benefit pools.
+ * Updates pools.
  * @public
  * @documentationMaturity preview
  * @requiredField options.pools.pool