@wix/auto_sdk_benefit-programs_pool-definitions 1.0.0 → 1.0.2

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

@@ -1,6 +1,7 @@
 export interface PoolDefinition {
     /**
      * Pool definition ID.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
@@ -22,9 +23,16 @@ export interface PoolDefinition {
      * @readonly
      */
     _updatedDate?: Date | null;
-    /** Name of the pool definition. */
+    /**
+     * Name of the pool definition.
+     * @maxLength 128
+     */
     displayName?: string;
-    /** List of program definitions that are associated with this pool definition. */
+    /**
+     * List of program definitions that are associated with this pool definition.
+     * @format GUID
+     * @maxSize 100
+     */
     programDefinitionIds?: string[];
     /**
      * Benefit pool information.
@@ -38,6 +46,9 @@ export interface PoolDefinition {
      * This namespace is used to organize and retrieve pool definitions and their associated benefit pools.
      *
      * It should match the namespace used in the program definitions.
+     * @immutable
+     * @minLength 1
+     * @maxLength 50
      */
     namespace?: string | null;
     /**
@@ -48,7 +59,10 @@ export interface PoolDefinition {
     extendedFields?: ExtendedFields;
 }
 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.
@@ -78,6 +92,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;
     /**
@@ -86,6 +101,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;
@@ -94,6 +111,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;
     /**
@@ -104,11 +122,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 {
@@ -154,11 +182,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 {
@@ -194,13 +230,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 {
@@ -252,19 +300,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 {
@@ -274,6 +334,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;
 }
@@ -291,7 +352,10 @@ export interface ExtendedFields {
 export interface PoolDefinitionAddedToProgramDefinition {
     /** PoolDefinition that was added to the program definition */
     poolDefinition?: PoolDefinition;
-    /** Program Definition that the pool definition was added to */
+    /**
+     * Program Definition that the pool definition was added to
+     * @format GUID
+     */
     programDefinitionId?: string;
     /** Type of cascade */
     cascadeType?: Cascade;
@@ -321,11 +385,21 @@ export declare enum Cascade {
 export interface PoolDefinitionRemovedFromProgramDefinition {
     /** PoolDefinition that was removed from the program definition */
     poolDefinition?: PoolDefinition;
-    /** Program Definition that the pool definition was removed from */
+    /**
+     * Program Definition that the pool definition was removed from
+     * @format GUID
+     */
     programDefinitionId?: string;
     /** Type of cascade */
     cascadeType?: Cascade;
 }
+/** This event is needed to support legacy benefit notification event. Should be only consumed in the proxy. */
+export interface PoolDefinitionUpdatedProxySupport {
+    /** PoolDefinition after the update */
+    currentPoolDefinition?: PoolDefinition;
+    /** PoolDefinition before the update */
+    previousPoolDefinition?: PoolDefinition;
+}
 export interface CreatePoolDefinitionRequest {
     /** Pool definition to create. */
     poolDefinition: PoolDefinition;
@@ -341,7 +415,11 @@ export interface CreatePoolDefinitionResponse {
     poolDefinition?: PoolDefinition;
 }
 export interface BulkCreatePoolDefinitionsRequest {
-    /** Pool definitions to create. */
+    /**
+     * Pool definitions to create.
+     * @minSize 1
+     * @maxSize 100
+     */
     poolDefinitions: PoolDefinition[];
     /**
      * Specifies the timing of updates to associated benefit pools.
@@ -361,6 +439,8 @@ export interface BulkCreatePoolDefinitionsResponse {
      * List of results for each pool definition.
      *
      * Includes the pool definition and whether the creation was successful.
+     * @minSize 1
+     * @maxSize 100
      */
     results?: BulkPoolDefinitionResult[];
     /** Bulk action metadata. */
@@ -373,7 +453,10 @@ export interface BulkPoolDefinitionResult {
     poolDefinition?: PoolDefinition;
 }
 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;
@@ -413,7 +496,11 @@ export interface UpdatePoolDefinitionResponse {
     poolDefinition?: PoolDefinition;
 }
 export interface BulkUpdatePoolDefinitionsRequest {
-    /** Pool definitions to update. */
+    /**
+     * Pool definitions to update.
+     * @minSize 1
+     * @maxSize 100
+     */
     poolDefinitions?: MaskedPoolDefinition[];
     /**
      * Specifies the timing of updates to associated benefit pools.
@@ -439,13 +526,18 @@ export interface BulkUpdatePoolDefinitionsResponse {
      * List of results for each pool definition.
      *
      * Includes the pool definition and whether the update was successful.
+     * @minSize 1
+     * @maxSize 100
      */
     results?: BulkPoolDefinitionResult[];
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 export interface DeletePoolDefinitionRequest {
-    /** ID of the pool definition to delete. */
+    /**
+     * ID of the pool definition to delete.
+     * @format GUID
+     */
     poolDefinitionId: string;
     /**
      * Defines how the delete operation cascades to related pools.
@@ -457,7 +549,12 @@ export interface DeletePoolDefinitionRequest {
 export interface DeletePoolDefinitionResponse {
 }
 export interface BulkDeletePoolDefinitionsRequest {
-    /** ID of the pool definitions to delete. */
+    /**
+     * ID of the pool definitions to delete.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
     poolDefinitionIds: string[];
     /**
      * Specifies the timing of updates to associated benefit pools.
@@ -470,13 +567,18 @@ export interface BulkDeletePoolDefinitionsResponse {
      * List of results for each pool definition.
      *
      * Includes the pool definition and whether the deletion was successful.
+     * @minSize 1
+     * @maxSize 100
      */
     results?: BulkPoolDefinitionResult[];
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 export interface GetPoolDefinitionRequest {
-    /** ID of the pool definition to retrieve. */
+    /**
+     * ID of the pool definition to retrieve.
+     * @format GUID
+     */
     poolDefinitionId: string;
 }
 export interface GetPoolDefinitionResponse {
@@ -502,6 +604,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /**
      * Sort object in the following format:
      * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 5
      */
     sort?: Sorting[];
 }
@@ -511,7 +614,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;
@@ -523,13 +629,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;
 }
@@ -553,15 +663,27 @@ 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 AddPoolDefinitionToProgramDefinitionRequest {
-    /** Pool definition to assign to the program definition. */
+    /**
+     * Pool definition to assign to the program definition.
+     * @format GUID
+     */
     poolDefinitionId: string;
-    /** Program definition that the pool definition is assigned to. */
+    /**
+     * Program definition that the pool definition is assigned to.
+     * @format GUID
+     */
     programDefinitionId: string;
     /**
      * Specifies the timing of updates to associated benefit pools.
@@ -574,9 +696,15 @@ export interface AddPoolDefinitionToProgramDefinitionResponse {
     poolDefinition?: PoolDefinition;
 }
 export interface RemovePoolDefinitionFromProgramDefinitionRequest {
-    /** ID of the pool definition to be removed from the program definition. */
+    /**
+     * ID of the pool definition to be removed from the program definition.
+     * @format GUID
+     */
     poolDefinitionId: string;
-    /** ID of the program definition being removed from the pool definition. */
+    /**
+     * ID of the program definition being removed from the pool definition.
+     * @format GUID
+     */
     programDefinitionId: string;
     /**
      * Specifies the timing of updates to associated benefit pools.
@@ -589,7 +717,10 @@ export interface RemovePoolDefinitionFromProgramDefinitionResponse {
     poolDefinition?: PoolDefinition;
 }
 export interface FindPoolDefinitionsByProgramDefinitionRequest {
-    /** ID of the program definition of which its assigned pool definitions are retrieved. */
+    /**
+     * ID of the program definition of which its assigned pool definitions are retrieved.
+     * @format GUID
+     */
     programDefinitionId: string;
     /**
      * Application sub-module that represents the source of the pool definition. Specified by the external developer.
@@ -597,6 +728,8 @@ export interface FindPoolDefinitionsByProgramDefinitionRequest {
      * This namespace is used to organize and retrieve pool definitions and their associated benefit pools.
      *
      * It should match the namespace used in the program definitions.
+     * @minLength 1
+     * @maxLength 50
      */
     namespace: string;
 }
@@ -675,9 +808,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;
@@ -685,26 +824,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 {
@@ -834,6 +997,9 @@ export interface FindPoolDefinitionsByProgramDefinitionResponseNonNullableFields
  * @requiredField poolDefinition.details.benefits.providerAppId
  * @requiredField poolDefinition.namespace
  * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_CREATE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
  * @returns Created pool definition.
  * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.CreatePoolDefinition
  */
@@ -858,6 +1024,9 @@ export interface CreatePoolDefinitionOptions {
  * @requiredField poolDefinitions.details.benefits.providerAppId
  * @requiredField poolDefinitions.namespace
  * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_CREATE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.BulkCreatePoolDefinitions
  */
 export declare function bulkCreatePoolDefinitions(poolDefinitions: PoolDefinition[], options?: BulkCreatePoolDefinitionsOptions): Promise<BulkCreatePoolDefinitionsResponse & BulkCreatePoolDefinitionsResponseNonNullableFields>;
@@ -890,6 +1059,9 @@ export interface BulkCreatePoolDefinitionsOptions {
  * @requiredField poolDefinition
  * @requiredField poolDefinition.revision
  * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
  * @returns Updated pool definition.
  * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.UpdatePoolDefinition
  */
@@ -897,6 +1069,7 @@ export declare function updatePoolDefinition(_id: string | null, poolDefinition:
 export interface UpdatePoolDefinition {
     /**
      * Pool definition ID.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
@@ -918,9 +1091,16 @@ export interface UpdatePoolDefinition {
      * @readonly
      */
     _updatedDate?: Date | null;
-    /** Name of the pool definition. */
+    /**
+     * Name of the pool definition.
+     * @maxLength 128
+     */
     displayName?: string;
-    /** List of program definitions that are associated with this pool definition. */
+    /**
+     * List of program definitions that are associated with this pool definition.
+     * @format GUID
+     * @maxSize 100
+     */
     programDefinitionIds?: string[];
     /**
      * Benefit pool information.
@@ -934,6 +1114,9 @@ export interface UpdatePoolDefinition {
      * This namespace is used to organize and retrieve pool definitions and their associated benefit pools.
      *
      * It should match the namespace used in the program definitions.
+     * @immutable
+     * @minLength 1
+     * @maxLength 50
      */
     namespace?: string | null;
     /**
@@ -959,11 +1142,18 @@ export interface UpdatePoolDefinitionOptions {
  * @requiredField options.poolDefinitions.poolDefinition._id
  * @requiredField options.poolDefinitions.poolDefinition.revision
  * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.BulkUpdatePoolDefinitions
  */
 export declare function bulkUpdatePoolDefinitions(options?: BulkUpdatePoolDefinitionsOptions): Promise<BulkUpdatePoolDefinitionsResponse & BulkUpdatePoolDefinitionsResponseNonNullableFields>;
 export interface BulkUpdatePoolDefinitionsOptions {
-    /** Pool definitions to update. */
+    /**
+     * Pool definitions to update.
+     * @minSize 1
+     * @maxSize 100
+     */
     poolDefinitions?: MaskedPoolDefinition[];
     /**
      * Specifies the timing of updates to associated benefit pools.
@@ -985,6 +1175,9 @@ export interface BulkUpdatePoolDefinitionsOptions {
  * @documentationMaturity preview
  * @requiredField poolDefinitionId
  * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_DELETE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.DeletePoolDefinition
  */
 export declare function deletePoolDefinition(poolDefinitionId: string, options?: DeletePoolDefinitionOptions): Promise<void>;
@@ -1003,6 +1196,9 @@ export interface DeletePoolDefinitionOptions {
  * @documentationMaturity preview
  * @requiredField poolDefinitionIds
  * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_DELETE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.BulkDeletePoolDefinitions
  */
 export declare function bulkDeletePoolDefinitions(poolDefinitionIds: string[], options?: BulkDeletePoolDefinitionsOptions): Promise<BulkDeletePoolDefinitionsResponse & BulkDeletePoolDefinitionsResponseNonNullableFields>;
@@ -1020,6 +1216,13 @@ export interface BulkDeletePoolDefinitionsOptions {
  * @documentationMaturity preview
  * @requiredField poolDefinitionId
  * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_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
  * @applicableIdentity VISITOR
  * @returns Retrieved pool definition.
  * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.GetPoolDefinition
@@ -1037,7 +1240,14 @@ export declare function getPoolDefinition(poolDefinitionId: string): Promise<Poo
  * The following `PoolDefinitionsQueryBuilder` functions are supported for `queryPoolDefinitions()`. For a full description of the pool definition object, see the object returned for the [`items`](/pool-definitions/pool-definitions-query-result/items) property in `PoolDefinitionsQueryResult`.
  * @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_DEFINITION_READ
+ * @applicableIdentity APP
  * @applicableIdentity VISITOR
  * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.QueryPoolDefinitions
  */
@@ -1136,11 +1346,17 @@ export interface PoolDefinitionsQueryBuilder {
  * @requiredField options.programDefinitionId
  * @requiredField poolDefinitionId
  * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.AddPoolDefinitionToProgramDefinition
  */
 export declare function addPoolDefinitionToProgramDefinition(poolDefinitionId: string, options: AddPoolDefinitionToProgramDefinitionOptions): Promise<AddPoolDefinitionToProgramDefinitionResponse & AddPoolDefinitionToProgramDefinitionResponseNonNullableFields>;
 export interface AddPoolDefinitionToProgramDefinitionOptions {
-    /** Program definition that the pool definition is assigned to. */
+    /**
+     * Program definition that the pool definition is assigned to.
+     * @format GUID
+     */
     programDefinitionId: string;
     /**
      * Specifies the timing of updates to associated benefit pools.
@@ -1162,11 +1378,17 @@ export interface AddPoolDefinitionToProgramDefinitionOptions {
  * @requiredField options.programDefinitionId
  * @requiredField poolDefinitionId
  * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.RemovePoolDefinitionFromProgramDefinition
  */
 export declare function removePoolDefinitionFromProgramDefinition(poolDefinitionId: string, options: RemovePoolDefinitionFromProgramDefinitionOptions): Promise<RemovePoolDefinitionFromProgramDefinitionResponse & RemovePoolDefinitionFromProgramDefinitionResponseNonNullableFields>;
 export interface RemovePoolDefinitionFromProgramDefinitionOptions {
-    /** ID of the program definition being removed from the pool definition. */
+    /**
+     * ID of the program definition being removed from the pool definition.
+     * @format GUID
+     */
     programDefinitionId: string;
     /**
      * Specifies the timing of updates to associated benefit pools.
@@ -1185,6 +1407,13 @@ export interface RemovePoolDefinitionFromProgramDefinitionOptions {
  * @requiredField options.namespace
  * @requiredField programDefinitionId
  * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_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
  * @applicableIdentity VISITOR
  * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.FindPoolDefinitionsByProgramDefinition
  */
@@ -1196,6 +1425,8 @@ export interface FindPoolDefinitionsByProgramDefinitionOptions {
      * This namespace is used to organize and retrieve pool definitions and their associated benefit pools.
      *
      * It should match the namespace used in the program definitions.
+     * @minLength 1
+     * @maxLength 50
      */
     namespace: string;
 }