@wix/auto_sdk_benefit-programs_pools 1.0.0 → 1.0.2

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

@@ -1,6 +1,7 @@
 export interface Pool {
     /**
      * Pool ID.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
@@ -24,16 +25,19 @@ export interface Pool {
     _updatedDate?: Date | null;
     /**
      * Pool definition from which this benefit pool was created.
+     * @format GUID
      * @readonly
      */
     poolDefinitionId?: string | null;
     /**
      * Program definition from which this benefit pool was provisioned.
+     * @format GUID
      * @readonly
      */
     programDefinitionId?: string | null;
     /**
      * ID of the program to which this benefit pool is associated.
+     * @format GUID
      * @readonly
      */
     programId?: string | null;
@@ -54,9 +58,15 @@ export interface Pool {
      * Pool name.
      *
      * It's recommended to keep the same as the associated pool definition's `displayName`.
+     * @maxLength 64
      */
     displayName?: string;
-    /** External system that is the source of the program creation. For example, `wix-pricing-plans`, `wix-loyalty`. */
+    /**
+     * External system that is the source of the program creation. For example, `wix-pricing-plans`, `wix-loyalty`.
+     * @immutable
+     * @minLength 1
+     * @maxLength 50
+     */
     namespace?: string | null;
     /**
      * Custom field data for the pool object.
@@ -108,20 +118,38 @@ export declare enum PoolStatus {
     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 has not 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 visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
 }
 /** @oneof */
 export interface CommonIdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not 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 visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
 }
 export declare enum IdentityType {
@@ -135,7 +163,10 @@ export declare enum IdentityType {
     WIX_USER = "WIX_USER"
 }
 export interface Details {
-    /** Array of benefits, each containing price and policy settings specific to that benefit within the pool. */
+    /**
+     * Array of benefits, each containing price and policy settings specific to that benefit within the pool.
+     * @maxSize 10
+     */
     benefits?: Benefit[];
     /**
      * Settings that control the initial credits and renewal cycle configurations of the benefit pool.
@@ -165,6 +196,7 @@ export interface Benefit {
      * An unique identifier for a pool benefit.
      *
      * This key is consistent across the pool definition and all its associated benefit pools.
+     * @maxLength 64
      */
     benefitKey?: string;
     /**
@@ -173,6 +205,8 @@ export interface Benefit {
      * 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.
+     * @format GUID
+     * @immutable
      * @readonly
      */
     itemSetId?: string | null;
@@ -181,6 +215,7 @@ export interface Benefit {
      * 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.
+     * @decimalValue options { gte:0, maxScale:4 }
      */
     price?: string | null;
     /**
@@ -191,11 +226,21 @@ export interface Benefit {
     policyExpression?: PolicyExpression;
     /** Additional info that was set by the benefit provider. */
     additionalData?: Record<string, any> | null;
-    /** ID of the app providing the benefit. */
+    /**
+     * ID of the app providing the benefit.
+     * @format GUID
+     * @immutable
+     */
     providerAppId?: string | null;
-    /** Benefit display name. */
+    /**
+     * Benefit display name.
+     * @maxLength 40
+     */
     displayName?: string | null;
-    /** Benefit description. */
+    /**
+     * Benefit description.
+     * @maxLength 255
+     */
     description?: string | null;
 }
 export interface PolicyExpression extends PolicyExpressionExpressionOneOf {
@@ -241,11 +286,19 @@ export interface PolicyExpressionNot {
     expression?: PolicyExpression;
 }
 export interface PolicyExpressionAnd {
-    /** Specify policy terms where all policy conditions must be met. Must specify an object with an `expressions` property. */
+    /**
+     * Specify policy terms where all policy conditions must be met. Must specify an object with an `expressions` property.
+     * @minSize 2
+     * @maxSize 10
+     */
     expressions?: PolicyExpression[];
 }
 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. */
+    /**
+     * Specify policy terms where at least one of the possible specified policy conditions is met. Must specify an object with an `expressions` property.
+     * @minSize 2
+     * @maxSize 10
+     */
     expressions?: PolicyExpression[];
 }
 export interface Policy extends PolicyPolicyOneOf {
@@ -281,13 +334,25 @@ export interface FixedIntervalPolicy {
     fromWeekDay?: WeekDay;
     /** Weekday that this interval ends at. If this field is set, then `fromWeekDay` must also be set. */
     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 set, then `toHour` must also be set.
+     * @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 set, then `fromHour` must also be set.
+     * @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 set, then `toMinute` must also be set.
+     * @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 set, then `fromMinute` must also be set.
+     * @max 59
+     */
     toMinute?: number | null;
 }
 export declare enum WeekDay {
@@ -339,19 +404,31 @@ export declare enum RateLimitedPolicyType {
 }
 /** Custom policy as implemented by the Entitlement Policy Provider */
 export interface CustomPolicy {
-    /** References a specific custom policy on the provider's system */
+    /**
+     * References a specific custom policy on the provider's system
+     * @format GUID
+     */
     _id?: string;
-    /** Custom policy provider id */
+    /**
+     * Custom policy provider id
+     * @format GUID
+     */
     appId?: string | null;
     /** Additional info for this custom policy. It's going to be passed to the policy provider during eligibility checks */
     additionalData?: Record<string, any> | null;
 }
 export interface CreditConfiguration {
-    /** The initial total amount of credits available in this benefit pool. */
+    /**
+     * The initial total amount of credits available in this benefit pool.
+     * @decimalValue options { gte:0, maxScale:4 }
+     */
     amount?: string;
     /** Rollover configuration. */
     rolloverConfiguration?: RolloverConfiguration;
-    /** Display name of the unit. */
+    /**
+     * Display name of the unit.
+     * @maxLength 32
+     */
     unitDisplayName?: string | null;
 }
 export interface RolloverConfiguration {
@@ -361,6 +438,7 @@ export interface RolloverConfiguration {
      * 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.
+     * @decimalValue options { gte:0, maxScale:4 }
      */
     balanceCap?: string | null;
 }
@@ -378,6 +456,7 @@ export interface ExtendedFields {
 export interface ProgramDefinitionInfo {
     /**
      * ID of the program definition that provisioned the program associated with this benefit pool.
+     * @format GUID
      * @readonly
      */
     _id?: string;
@@ -385,6 +464,7 @@ export interface ProgramDefinitionInfo {
      * External ID of the program definition that provisioned this program.
      *
      * This identifies the source program definition in the external system.
+     * @format GUID
      * @readonly
      */
     externalId?: string | null;
@@ -392,6 +472,7 @@ export interface ProgramDefinitionInfo {
 export interface ProgramInfo {
     /**
      * ID of the program associated with this benefit pool.
+     * @format GUID
      * @readonly
      */
     _id?: string;
@@ -399,6 +480,7 @@ export interface ProgramInfo {
      * External ID of the program associated with this benefit pool.
      *
      * This identifies the source program in the external system.
+     * @format GUID
      * @readonly
      */
     externalId?: string | null;
@@ -426,18 +508,27 @@ export interface BenefitRedeemed {
     redemptionDetails?: RedemptionDetails;
 }
 export interface RedemptionDetails {
-    /** Id of the redemption transaction */
+    /**
+     * Id of the redemption transaction
+     * @format GUID
+     */
     transactionId?: string;
     /** Reference of the item that is being redeemed */
     itemReference?: ItemReference;
-    /** Number of of items to redeem */
+    /**
+     * Number of of items to redeem
+     * @min 1
+     */
     itemCount?: number;
     /**
      * Date at which the item will be used. Target date does not necessarily equal the redemption date. Credits are redeemed immediately.
      * This date is only used for validations that may be performed by entitlement providers
      */
     targetDate?: Date | null;
-    /** Idempotency key */
+    /**
+     * Idempotency key
+     * @maxLength 200
+     */
     idempotencyKey?: string;
     /** Additional info provided during redemption */
     additionalData?: Record<string, any> | null;
@@ -445,11 +536,20 @@ export interface RedemptionDetails {
     beneficiary?: CommonIdentificationData;
 }
 export interface ItemReference {
-    /** External ID of the item. */
+    /**
+     * External ID of the item.
+     * @format GUID
+     */
     externalId?: string;
-    /** Item category. */
+    /**
+     * Item category.
+     * @maxLength 20
+     */
     category?: string;
-    /** ID of the application providing the benefits. */
+    /**
+     * ID of the application providing the benefits.
+     * @format GUID
+     */
     providerAppId?: string;
 }
 export interface PoolPaused {
@@ -473,13 +573,19 @@ export interface BenefitReserved {
 export interface BenefitReservationCanceled {
     /** Pool which was used to perform this transaction */
     pool?: Pool;
-    /** Id of the canceled reservation transaction */
+    /**
+     * Id of the canceled reservation transaction
+     * @format GUID
+     */
     transactionId?: string;
 }
 export interface BenefitReservationReleased {
     /** Pool which was used to perform this transaction */
     pool?: Pool;
-    /** Id of the released reservation transaction */
+    /**
+     * Id of the released reservation transaction
+     * @format GUID
+     */
     transactionId?: string;
 }
 export interface CreatePoolRequest {
@@ -491,7 +597,10 @@ export interface CreatePoolResponse {
     pool?: Pool;
 }
 export interface GetPoolRequest {
-    /** ID of the pool to retrieve. */
+    /**
+     * ID of the pool to retrieve.
+     * @format GUID
+     */
     poolId: string;
 }
 export interface GetPoolResponse {
@@ -507,7 +616,10 @@ export interface UpdatePoolResponse {
     pool?: Pool;
 }
 export interface DeletePoolRequest {
-    /** ID of the pool to delete. */
+    /**
+     * ID of the pool to delete.
+     * @format GUID
+     */
     poolId?: string;
 }
 export interface DeletePoolResponse {
@@ -531,6 +643,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /**
      * Sort object in the following format:
      * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 5
      */
     sort?: Sorting[];
 }
@@ -540,7 +653,10 @@ export interface CursorQueryPagingMethodOneOf {
     cursorPaging?: CursorPaging;
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -552,13 +668,17 @@ export declare enum SortOrder {
     DESC = "DESC"
 }
 export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
      *
      * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
      * Not relevant for the first request.
+     * @maxLength 16000
      */
     cursor?: string | null;
 }
@@ -582,13 +702,22 @@ export interface CursorPagingMetadata {
     hasNext?: boolean | null;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
     next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
     prev?: string | null;
 }
 export interface RedeemBenefitRequest {
-    /** ID of the benefit pool being redeemed. */
+    /**
+     * ID of the benefit pool being redeemed.
+     * @format GUID
+     */
     poolId: string;
     /** Reference of the benefit item that is being redeemed. */
     itemReference: ItemReference;
@@ -596,9 +725,13 @@ export interface RedeemBenefitRequest {
      * Key of the specific benefit to be redeemed.
      *
      * This needs to be specified to ensure the correct benefit is redeemed.
+     * @maxLength 64
      */
     benefitKey: string;
-    /** Number of of items to redeem. */
+    /**
+     * Number of of items to redeem.
+     * @min 1
+     */
     count?: number;
     /**
      * Date when the benefit item will be used.
@@ -611,6 +744,7 @@ export interface RedeemBenefitRequest {
     /**
      * Unique identifier, generated by the client.
      * Used to recognize repeated attempts to make the same request.
+     * @maxLength 200
      */
     idempotencyKey: string;
     /** Additional information. */
@@ -621,67 +755,121 @@ export interface RedeemBenefitRequest {
      * Module that is the source of the benefit pool creation.
      *
      * Must match the previously defined namespace in the associated pool definition.
+     * @minLength 1
+     * @maxLength 50
      */
     namespace: string;
 }
 export interface RedeemBenefitResponse {
-    /** Id of the resulting transaction. */
+    /**
+     * Id of the resulting transaction.
+     * @format GUID
+     */
     transactionId?: string;
 }
 export interface NotEnoughBalance {
-    /** Pool ID */
+    /**
+     * Pool ID
+     * @format GUID
+     */
     poolId?: string;
     /** Item reference */
     itemReference?: ItemReference;
-    /** Price of the item expressed in credits */
+    /**
+     * Price of the item expressed in credits
+     * @decimalValue options { maxScale:4 }
+     */
     availableBalance?: string;
-    /** Price of the item expressed in credits */
+    /**
+     * Price of the item expressed in credits
+     * @decimalValue options { maxScale:4 }
+     */
     requestedBalance?: string;
 }
 export interface PolicyExpressionEvaluatedToFalse {
-    /** Pool ID */
+    /**
+     * Pool ID
+     * @format GUID
+     */
     poolId?: string;
     /** Item reference */
     itemReference?: ItemReference;
-    /** Failure details */
+    /**
+     * Failure details
+     * @maxSize 10
+     */
     failureDetails?: FailureDetails[];
 }
 export interface FailureDetails {
-    /** Failure code */
+    /**
+     * Failure code
+     * @minLength 1
+     * @maxLength 64
+     */
     code?: string;
-    /** Failure message */
+    /**
+     * Failure message
+     * @maxLength 256
+     */
     message?: string | null;
-    /** Policy id */
+    /**
+     * Policy id
+     * @format GUID
+     */
     policyId?: string | null;
-    /** App that owns the policy */
+    /**
+     * App that owns the policy
+     * @format GUID
+     */
     appId?: string | null;
     /** Information provided by the policy */
     errorData?: Record<string, any> | null;
 }
 export interface PoolNotActive {
-    /** Pool ID */
+    /**
+     * Pool ID
+     * @format GUID
+     */
     poolId?: string;
     /** Pool status */
     poolStatus?: PoolStatus;
 }
 export interface PoolNotFound {
-    /** Pool ID */
+    /**
+     * Pool ID
+     * @format GUID
+     */
     poolId?: string;
 }
 export interface BenefitAlreadyRedeemed {
-    /** Pool ID */
+    /**
+     * Pool ID
+     * @format GUID
+     */
     poolId?: string;
-    /** Idempotency key of the request that failed */
+    /**
+     * Idempotency key of the request that failed
+     * @maxLength 200
+     */
     idempotencyKey?: string;
 }
 export interface BenefitNotFound {
-    /** Pool ID */
+    /**
+     * Pool ID
+     * @format GUID
+     */
     poolId?: string;
-    /** Key of the referenced benefit, if provided */
+    /**
+     * Key of the referenced benefit, if provided
+     * @format GUID
+     */
     benefitKey?: string | null;
 }
 export interface ReserveBenefitRequest {
-    /** Id of the pool that is being redeemed from */
+    /**
+     * Id of the pool that is being redeemed from
+     * @format GUID
+     */
     poolId?: string;
     /** Reference of the item that is being redeemed. */
     itemReference?: ItemReference;
@@ -691,9 +879,13 @@ export interface ReserveBenefitRequest {
      * This key must be specified to ensure the correct benefit is redeemed.
      *
      * Default: The first eligible benefit in the benefit pool will be redeemed.
+     * @maxLength 64
      */
     benefitKey?: string | null;
-    /** Number of items to redeem. */
+    /**
+     * Number of items to redeem.
+     * @min 1
+     */
     count?: number;
     /**
      * Date when the benefit item will be used.
@@ -703,7 +895,10 @@ export interface ReserveBenefitRequest {
      * Used for the app providing the benefit items to manage the logistics associated with the item.
      */
     targetDate?: Date | null;
-    /** Idempotency key */
+    /**
+     * Idempotency key
+     * @maxLength 200
+     */
     idempotencyKey?: string;
     /** Additional info */
     additionalData?: Record<string, any> | null;
@@ -715,31 +910,51 @@ export interface ReserveBenefitRequest {
      * 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.
+     * @minLength 1
+     * @maxLength 50
      */
     namespace?: string;
 }
 export interface ReserveBenefitResponse {
-    /** Id of the transaction that was created as a result of this request */
+    /**
+     * Id of the transaction that was created as a result of this request
+     * @format GUID
+     */
     transactionId?: string;
 }
 export interface CancelBenefitReservationRequest {
-    /** Id of the transaction that was created as a result of this request */
+    /**
+     * Id of the transaction that was created as a result of this request
+     * @format GUID
+     */
     transactionId?: string;
 }
 export interface CancelBenefitReservationResponse {
-    /** Id of the transaction that was created as a result of this request */
+    /**
+     * Id of the transaction that was created as a result of this request
+     * @format GUID
+     */
     transactionId?: string;
 }
 export interface ReleaseBenefitReservationRequest {
-    /** Id of the transaction that was created as a result of this request */
+    /**
+     * Id of the transaction that was created as a result of this request
+     * @format GUID
+     */
     transactionId?: string;
 }
 export interface ReleaseBenefitReservationResponse {
-    /** Id of the transaction that was created as a result of this request */
+    /**
+     * Id of the transaction that was created as a result of this request
+     * @format GUID
+     */
     transactionId?: string;
 }
 export interface CheckBenefitEligibilityRequest {
-    /** ID of the benefit pool to check eligibility against. */
+    /**
+     * ID of the benefit pool to check eligibility against.
+     * @format GUID
+     */
     poolId: string;
     /**
      * Key of the benefit to be redeemed, associated with a particular benefit.
@@ -747,6 +962,7 @@ export interface CheckBenefitEligibilityRequest {
      * This key must be specified to ensure the correct benefit is redeemed.
      *
      * Default: The first eligible benefit in the benefit pool will be redeemed.
+     * @maxLength 64
      */
     benefitKey?: string | null;
     /** Reference of the item for which to check benefit's eligibility. */
@@ -755,6 +971,7 @@ export interface CheckBenefitEligibilityRequest {
      * 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.
+     * @min 1
      */
     count?: number;
     /**
@@ -775,6 +992,8 @@ export interface CheckBenefitEligibilityRequest {
      * 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.
+     * @minLength 1
+     * @maxLength 50
      */
     namespace: string;
 }
@@ -820,14 +1039,21 @@ export interface EligibilityCheckResultResultOneOf {
 export interface EligibleBenefit {
     /**
      * Pool ID
+     * @format GUID
      * @readonly
      */
     poolId?: string;
-    /** Key of the specific benefit. */
+    /**
+     * Key of the specific benefit.
+     * @maxLength 64
+     */
     benefitKey?: string;
     /** Item reference */
     itemReference?: ItemReference;
-    /** Price of the item expressed in credits */
+    /**
+     * Price of the item expressed in credits
+     * @decimalValue options { gte:0, maxScale:4 }
+     */
     price?: string | null;
 }
 export declare enum EligibilityCheckResultType {
@@ -847,11 +1073,18 @@ export declare enum EligibilityCheckResultType {
     POOL_NOT_FOUND = "POOL_NOT_FOUND"
 }
 export interface Eligible {
-    /** Eligible benefits. */
+    /**
+     * Eligible benefits.
+     * @maxSize 100
+     */
     eligibleBenefits?: EligibleBenefit[];
 }
 export interface BulkCheckBenefitEligibilityRequest {
-    /** Benefits to check eligibility. */
+    /**
+     * Benefits to check eligibility.
+     * @minSize 1
+     * @maxSize 100
+     */
     benefitSelectors?: BenefitSelector[];
     /**
      * Module that is the source of the benefit pool creation.
@@ -859,15 +1092,23 @@ export interface BulkCheckBenefitEligibilityRequest {
      * 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.
+     * @minLength 1
+     * @maxLength 50
      */
     namespace: string;
     /** Benefit pool owner. */
     beneficiary?: CommonIdentificationData;
 }
 export interface BenefitSelector {
-    /** ID of the pool to check for eligibility. */
+    /**
+     * ID of the pool to check for eligibility.
+     * @format GUID
+     */
     poolId?: string;
-    /** ID of the benefit to check for eligibility. */
+    /**
+     * ID of the benefit to check for eligibility.
+     * @maxLength 64
+     */
     benefitKey?: string | null;
     /** Reference of the item for which to check benefit's eligibility. */
     itemReference?: ItemReference;
@@ -875,6 +1116,7 @@ export interface BenefitSelector {
      * 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.
+     * @min 1
      */
     count?: number;
     /**
@@ -889,7 +1131,11 @@ export interface BenefitSelector {
     additionalData?: Record<string, any> | null;
 }
 export interface BulkCheckBenefitEligibilityResponse {
-    /** List of results for pool benefit eligibility. */
+    /**
+     * List of results for pool benefit eligibility.
+     * @minSize 1
+     * @maxSize 100
+     */
     results?: BulkEligibilityCheckResult[];
 }
 export interface BulkEligibilityCheckResult {
@@ -905,6 +1151,7 @@ export interface GetEligibleBenefitsRequest {
      * 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.
+     * @min 1
      */
     count?: number;
     /**
@@ -925,6 +1172,8 @@ export interface GetEligibleBenefitsRequest {
      * 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.
+     * @minLength 1
+     * @maxLength 50
      */
     namespace: string;
 }
@@ -943,11 +1192,17 @@ export declare enum ListPoolsRequestType {
     BY_ITEM_REFERENCE = "BY_ITEM_REFERENCE"
 }
 export interface ByItemReference {
-    /** A list of filters */
+    /**
+     * A list of filters
+     * @maxSize 100
+     */
     filters?: ByItemReferenceFilter[];
     /** Beneficiary of the pool */
     beneficiary?: CommonIdentificationData;
-    /** Returns pools that are in the following statuses */
+    /**
+     * Returns pools that are in the following statuses
+     * @maxSize 10
+     */
     poolStatuses?: PoolStatus[];
 }
 export interface ByItemReferenceFilter {
@@ -965,6 +1220,7 @@ export interface Filter extends FilterFilterOneOf {
      * 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.
+     * @maxLength 50
      */
     namespace?: string;
 }
@@ -974,7 +1230,10 @@ export interface FilterFilterOneOf {
     byItemReferenceOptions?: ByItemReference;
 }
 export interface ListPoolsResponse {
-    /** The retrieved pools */
+    /**
+     * The retrieved pools
+     * @maxSize 100
+     */
     pools?: PoolWithItems[];
     /** Paging information */
     metadata?: CursorPagingMetadata;
@@ -982,11 +1241,18 @@ export interface ListPoolsResponse {
 export interface PoolWithItems {
     /** The pool */
     pool?: Pool;
-    /** The items in the pool */
+    /**
+     * The items in the pool
+     * @maxSize 100
+     */
     itemReference?: ItemReference[];
 }
 export interface BulkUpdatePoolsRequest {
-    /** Pools to update. */
+    /**
+     * Pools to update.
+     * @minSize 1
+     * @maxSize 100
+     */
     pools?: MaskedPool[];
     /**
      * Whether to return the full pool definition entities.
@@ -1006,6 +1272,8 @@ export interface BulkUpdatePoolsResponse {
      * List of results for each pool.
      *
      * Includes the pool, pool metadata, and whether the update was successful.
+     * @minSize 1
+     * @maxSize 100
      */
     results?: BulkPoolResult[];
     /** Bulk action metadata. */
@@ -1018,7 +1286,10 @@ export interface BulkPoolResult {
     pool?: Pool;
 }
 export interface ItemMetadata {
-    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    /**
+     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+     * @format GUID
+     */
     _id?: string | null;
     /** Index of the item within the request array. Allows for correlation between request and response items. */
     originalIndex?: number;
@@ -1046,20 +1317,35 @@ export interface BulkActionMetadata {
 export interface ProvisionPoolsForProgramRequest {
     /** Reference of the template that is used to provision the pools */
     poolDefinitionLookupId?: PoolDefinitionLookupId;
-    /** Program that the provisioned pools are part of */
+    /**
+     * Program that the provisioned pools are part of
+     * @format GUID
+     */
     programId?: string;
 }
 export interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
-    /** Pool definition ID. */
+    /**
+     * Pool definition ID.
+     * @format GUID
+     */
     poolDefinitionId?: string;
-    /** Program definition ID. */
+    /**
+     * Program definition ID.
+     * @format GUID
+     */
     programDefinitionId?: string;
 }
 /** @oneof */
 export interface PoolDefinitionLookupIdIdOneOf {
-    /** Pool definition ID. */
+    /**
+     * Pool definition ID.
+     * @format GUID
+     */
     poolDefinitionId?: string;
-    /** Program definition ID. */
+    /**
+     * Program definition ID.
+     * @format GUID
+     */
     programDefinitionId?: string;
 }
 export interface ProvisionPoolsForProgramResponse extends ProvisionPoolsForProgramResponseResultOneOf {
@@ -1067,7 +1353,10 @@ export interface ProvisionPoolsForProgramResponse extends ProvisionPoolsForProgr
     syncOptions?: SyncResult;
     /** Async result */
     asyncOptions?: AsyncResult;
-    /** Job ID of the program provision associated with this pool. */
+    /**
+     * Job ID of the program provision associated with this pool.
+     * @format GUID
+     */
     jobId?: string;
     /** Type of the result */
     type?: ProvisionPoolsForProgramResponseType;
@@ -1092,7 +1381,10 @@ export interface SyncResult {
     success?: boolean;
 }
 export interface AsyncResult {
-    /** Job ID of the program provision associated with this pool. */
+    /**
+     * Job ID of the program provision associated with this pool.
+     * @format GUID
+     */
     jobId?: string;
 }
 export interface InvalidPoolDefinitionReference {
@@ -1100,11 +1392,17 @@ export interface InvalidPoolDefinitionReference {
     poolDefinitionLookupId?: PoolDefinitionLookupId;
 }
 export interface RenewPoolsForProgramRequest {
-    /** Package of pools to grant. Package id should be the same that was used to provision programs. */
+    /**
+     * Package of pools to grant. Package id should be the same that was used to provision programs.
+     * @format GUID
+     */
     programId?: string;
 }
 export interface RenewPoolsForProgramResponse {
-    /** Job id of the renewal job */
+    /**
+     * Job id of the renewal job
+     * @format GUID
+     */
     jobId?: string;
 }
 export interface UpdatePoolStatusRequest extends UpdatePoolStatusRequestPoolSelectorOneOf {
@@ -1130,23 +1428,38 @@ export declare enum PoolSelectorType {
     BY_PROGRAM_ID = "BY_PROGRAM_ID"
 }
 export interface ByPoolDefinitionIdAndProgramDefinitionIdOptions {
-    /** Pool definition id */
+    /**
+     * Pool definition id
+     * @format GUID
+     */
     poolDefinitionId?: string;
-    /** Program definition id */
+    /**
+     * Program definition id
+     * @format GUID
+     */
     programDefinitionId?: string | null;
 }
 export interface ByProgramIdOptions {
-    /** Program id */
+    /**
+     * Program id
+     * @format GUID
+     */
     programId?: string;
     /** Additional data that gets added to the event once the async job completes */
     additionalData?: Record<string, any> | null;
 }
 export interface UpdatePoolStatusResponse {
-    /** Job ID of the program provision associated with this pool. */
+    /**
+     * Job ID of the program provision associated with this pool.
+     * @format GUID
+     */
     jobId?: string;
 }
 export interface CountNumberOfPoolsInProvisioningStatusRequest {
-    /** Program id */
+    /**
+     * Program id
+     * @format GUID
+     */
     programId?: string;
 }
 export interface CountNumberOfPoolsInProvisioningStatusResponse {
@@ -1224,9 +1537,15 @@ export interface ActionEvent {
     body?: string;
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -1234,26 +1553,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not 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 visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not 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 visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {
@@ -1436,6 +1779,13 @@ export interface BulkUpdatePoolsResponseNonNullableFields {
  * @documentationMaturity preview
  * @requiredField poolId
  * @permissionId BENEFIT_PROGRAMS.POOL_READ
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @applicableIdentity APP
  * @returns Retrieved pool.
  * @fqn wix.benefit_programs.v1.pool.PoolService.GetPool
  */
@@ -1455,6 +1805,9 @@ export declare function getPool(poolId: string): Promise<Pool & PoolNonNullableF
  * @requiredField pool
  * @requiredField pool.revision
  * @permissionId BENEFIT_PROGRAMS.POOL_UPDATE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
  * @returns Updated pool.
  * @fqn wix.benefit_programs.v1.pool.PoolService.UpdatePool
  */
@@ -1462,6 +1815,7 @@ export declare function updatePool(_id: string | null, pool: UpdatePool): Promis
 export interface UpdatePool {
     /**
      * Pool ID.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
@@ -1485,16 +1839,19 @@ export interface UpdatePool {
     _updatedDate?: Date | null;
     /**
      * Pool definition from which this benefit pool was created.
+     * @format GUID
      * @readonly
      */
     poolDefinitionId?: string | null;
     /**
      * Program definition from which this benefit pool was provisioned.
+     * @format GUID
      * @readonly
      */
     programDefinitionId?: string | null;
     /**
      * ID of the program to which this benefit pool is associated.
+     * @format GUID
      * @readonly
      */
     programId?: string | null;
@@ -1515,9 +1872,15 @@ export interface UpdatePool {
      * Pool name.
      *
      * It's recommended to keep the same as the associated pool definition's `displayName`.
+     * @maxLength 64
      */
     displayName?: string;
-    /** External system that is the source of the program creation. For example, `wix-pricing-plans`, `wix-loyalty`. */
+    /**
+     * External system that is the source of the program creation. For example, `wix-pricing-plans`, `wix-loyalty`.
+     * @immutable
+     * @minLength 1
+     * @maxLength 50
+     */
     namespace?: string | null;
     /**
      * Custom field data for the pool object.
@@ -1559,7 +1922,14 @@ export interface UpdatePool {
  * 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`.
  * @public
  * @documentationMaturity preview
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
  * @permissionId BENEFIT_PROGRAMS.POOL_READ
+ * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool.PoolService.QueryPools
  */
 export declare function queryPools(): PoolsQueryBuilder;
@@ -1659,6 +2029,9 @@ export interface PoolsQueryBuilder {
  * @requiredField options.namespace
  * @requiredField poolId
  * @permissionId BENEFIT_PROGRAMS.POOL_REDEEM
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool.PoolService.RedeemBenefit
  */
 export declare function redeemBenefit(poolId: string, options?: RedeemBenefitOptions): Promise<RedeemBenefitResponse & RedeemBenefitResponseNonNullableFields>;
@@ -1669,9 +2042,13 @@ export interface RedeemBenefitOptions {
      * Key of the specific benefit to be redeemed.
      *
      * This needs to be specified to ensure the correct benefit is redeemed.
+     * @maxLength 64
      */
     benefitKey: string;
-    /** Number of of items to redeem. */
+    /**
+     * Number of of items to redeem.
+     * @min 1
+     */
     count?: number;
     /**
      * Date when the benefit item will be used.
@@ -1684,6 +2061,7 @@ export interface RedeemBenefitOptions {
     /**
      * Unique identifier, generated by the client.
      * Used to recognize repeated attempts to make the same request.
+     * @maxLength 200
      */
     idempotencyKey: string;
     /** Additional information. */
@@ -1694,6 +2072,8 @@ export interface RedeemBenefitOptions {
      * Module that is the source of the benefit pool creation.
      *
      * Must match the previously defined namespace in the associated pool definition.
+     * @minLength 1
+     * @maxLength 50
      */
     namespace: string;
 }
@@ -1710,6 +2090,9 @@ export interface RedeemBenefitOptions {
  * @requiredField options.namespace
  * @requiredField poolId
  * @permissionId BENEFIT_PROGRAMS.POOL_REDEEM
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool.PoolService.CheckBenefitEligibility
  */
 export declare function checkBenefitEligibility(poolId: string, options?: CheckBenefitEligibilityOptions): Promise<CheckBenefitEligibilityResponse & CheckBenefitEligibilityResponseNonNullableFields>;
@@ -1720,6 +2103,7 @@ export interface CheckBenefitEligibilityOptions {
      * This key must be specified to ensure the correct benefit is redeemed.
      *
      * Default: The first eligible benefit in the benefit pool will be redeemed.
+     * @maxLength 64
      */
     benefitKey?: string | null;
     /** Reference of the item for which to check benefit's eligibility. */
@@ -1728,6 +2112,7 @@ export interface CheckBenefitEligibilityOptions {
      * 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.
+     * @min 1
      */
     count?: number;
     /**
@@ -1748,6 +2133,8 @@ export interface CheckBenefitEligibilityOptions {
      * 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.
+     * @minLength 1
+     * @maxLength 50
      */
     namespace: string;
 }
@@ -1763,11 +2150,18 @@ export interface CheckBenefitEligibilityOptions {
  * @requiredField options.benefitSelectors.poolId
  * @requiredField options.namespace
  * @permissionId BENEFIT_PROGRAMS.POOL_REDEEM
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool.PoolService.BulkCheckBenefitEligibility
  */
 export declare function bulkCheckBenefitEligibility(options?: BulkCheckBenefitEligibilityOptions): Promise<BulkCheckBenefitEligibilityResponse & BulkCheckBenefitEligibilityResponseNonNullableFields>;
 export interface BulkCheckBenefitEligibilityOptions {
-    /** Benefits to check eligibility. */
+    /**
+     * Benefits to check eligibility.
+     * @minSize 1
+     * @maxSize 100
+     */
     benefitSelectors?: BenefitSelector[];
     /**
      * Module that is the source of the benefit pool creation.
@@ -1775,6 +2169,8 @@ export interface BulkCheckBenefitEligibilityOptions {
      * 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.
+     * @minLength 1
+     * @maxLength 50
      */
     namespace: string;
     /** Benefit pool owner. */
@@ -1790,6 +2186,13 @@ export interface BulkCheckBenefitEligibilityOptions {
  * @requiredField itemReference.providerAppId
  * @requiredField options.namespace
  * @permissionId BENEFIT_PROGRAMS.POOL_READ
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool.PoolService.GetEligibleBenefits
  */
 export declare function getEligibleBenefits(itemReference: ItemReference, options?: GetEligibleBenefitsOptions): Promise<GetEligibleBenefitsResponse & GetEligibleBenefitsResponseNonNullableFields>;
@@ -1798,6 +2201,7 @@ 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.
+     * @min 1
      */
     count?: number;
     /**
@@ -1818,6 +2222,8 @@ export interface GetEligibleBenefitsOptions {
      * 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.
+     * @minLength 1
+     * @maxLength 50
      */
     namespace: string;
 }
@@ -1829,11 +2235,18 @@ export interface GetEligibleBenefitsOptions {
  * @requiredField options.pools.pool._id
  * @requiredField options.pools.pool.revision
  * @permissionId BENEFIT_PROGRAMS.POOL_UPDATE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool.PoolService.BulkUpdatePools
  */
 export declare function bulkUpdatePools(options?: BulkUpdatePoolsOptions): Promise<BulkUpdatePoolsResponse & BulkUpdatePoolsResponseNonNullableFields>;
 export interface BulkUpdatePoolsOptions {
-    /** Pools to update. */
+    /**
+     * Pools to update.
+     * @minSize 1
+     * @maxSize 100
+     */
     pools?: MaskedPool[];
     /**
      * Whether to return the full pool definition entities.