@wix/auto_sdk_benefit-programs_pool-definitions 1.0.0

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

@@ -0,0 +1,1202 @@
+export interface PoolDefinition {
+    /**
+     * Pool definition ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the pool definition is updated.
+     * To prevent conflicting changes, the current revision must be specified when updating the pool definition.
+     *
+     * Ignored when creating a pool definition.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the pool definition was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the pool definition was updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /** Name of the pool definition. */
+    displayName?: string;
+    /** List of program definitions that are associated with this pool definition. */
+    programDefinitionIds?: string[];
+    /**
+     * Benefit pool information.
+     *
+     * Includes the item, policy, and credit configurations.
+     */
+    details?: Details;
+    /**
+     * Application sub-module that represents the source of the pool definition. Specified by the external developer.
+     *
+     * 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.
+     */
+    namespace?: string | null;
+    /**
+     * Custom field data for the pool definition object.
+     *
+     * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
+     */
+    extendedFields?: ExtendedFields;
+}
+export interface Details {
+    /** Array of benefits, each containing price and policy settings specific to that benefit within the pool. */
+    benefits?: Benefit[];
+    /**
+     * Settings that control the initial credits and renewal cycle configurations of the benefit pool.
+     *
+     * Default: Benefits may be redeemed without limit.
+     */
+    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. */
+    additionalData?: Record<string, any> | null;
+}
+export interface Benefit {
+    /**
+     * An unique identifier for a pool benefit.
+     *
+     * This key is consistent across the pool definition and all its associated benefit pools.
+     */
+    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.
+     * @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?: 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. */
+    additionalData?: Record<string, any> | null;
+    /** ID of the app providing the benefit. */
+    providerAppId?: string | null;
+    /** Benefit display name. */
+    displayName?: string | null;
+    /** Benefit description. */
+    description?: string | null;
+}
+export interface PolicyExpression extends PolicyExpressionExpressionOneOf {
+    /** Negates the expression. */
+    operatorNotOptions?: PolicyExpressionNot;
+    /** Combines the expressions with an `AND` operator. */
+    operatorAndOptions?: PolicyExpressionAnd;
+    /** Combines the expressions with an `OR` operator. */
+    operatorOrOptions?: PolicyExpressionOr;
+    /** Defines policy terms for benefit redemption. */
+    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.
+     */
+    type?: PolicyExpressionType;
+}
+/** @oneof */
+export interface PolicyExpressionExpressionOneOf {
+    /** Negates the expression. */
+    operatorNotOptions?: PolicyExpressionNot;
+    /** Combines the expressions with an `AND` operator. */
+    operatorAndOptions?: PolicyExpressionAnd;
+    /** Combines the expressions with an `OR` operator. */
+    operatorOrOptions?: PolicyExpressionOr;
+    /** Defines policy terms for benefit redemption. */
+    policyOptions?: Policy;
+}
+export declare enum PolicyExpressionType {
+    UNKNOWN = "UNKNOWN",
+    /** Use with associated `operatorNotOptions`. */
+    OPERATOR_NOT = "OPERATOR_NOT",
+    /** Use with associated `operatorAndOptions`. */
+    OPERATOR_AND = "OPERATOR_AND",
+    /** Use with associated `operatorOrOptions`. */
+    OPERATOR_OR = "OPERATOR_OR",
+    /** Use with associated `policyOptions` to define a policy. */
+    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. */
+    expression?: PolicyExpression;
+}
+export interface PolicyExpressionAnd {
+    /** Specify policy terms where all policy conditions must be met. Must specify an object with an `expressions` property. */
+    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. */
+    expressions?: PolicyExpression[];
+}
+export interface Policy extends PolicyPolicyOneOf {
+    /** Defines the timing of benefit policy redemption for specific days or hours. */
+    fixedIntervalOptions?: FixedIntervalPolicy;
+    /** Sets a limit on the number of times a benefit can be redeemed within a given renewal cycle. */
+    rateLimitedOptions?: RateLimitedPolicy;
+    /** Custom policy definition that is controlled by the CustomPolicyProvider. */
+    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. */
+    type?: Type;
+}
+/** @oneof */
+export interface PolicyPolicyOneOf {
+    /** Defines the timing of benefit policy redemption for specific days or hours. */
+    fixedIntervalOptions?: FixedIntervalPolicy;
+    /** Sets a limit on the number of times a benefit can be redeemed within a given renewal cycle. */
+    rateLimitedOptions?: RateLimitedPolicy;
+    /** Custom policy definition that is controlled by the CustomPolicyProvider. */
+    customOptions?: CustomPolicy;
+}
+export declare enum Type {
+    /** Unknown policy type. */
+    UNKNOWN = "UNKNOWN",
+    /** Fixed interval policy type. */
+    FIXED_INTERVAL = "FIXED_INTERVAL",
+    /** Rate limited policy type. */
+    RATE_LIMITED = "RATE_LIMITED",
+    CUSTOM = "CUSTOM"
+}
+export interface FixedIntervalPolicy {
+    /** Weekday that this interval starts from. If this field is set, then `toWeekDay` must also be set. */
+    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. */
+    fromHour?: number | null;
+    /** Hour that this interval ends at. If this field is set, then `fromHour` must also be set. */
+    toHour?: number | null;
+    /** Minute that this interval starts from. If this field is set, then `toMinute` must also be set. */
+    fromMinute?: number | null;
+    /** Minute that this interval ends at. If this field is set, then `fromMinute` must also be set. */
+    toMinute?: number | null;
+}
+export declare enum WeekDay {
+    /** Unknown weekday. */
+    UNKNOWN = "UNKNOWN",
+    /** Monday. */
+    MONDAY = "MONDAY",
+    /** Tuesday. */
+    TUESDAY = "TUESDAY",
+    /** Wednesday. */
+    WEDNESDAY = "WEDNESDAY",
+    /** Thursday. */
+    THURSDAY = "THURSDAY",
+    /** Friday. */
+    FRIDAY = "FRIDAY",
+    /** Saturday. */
+    SATURDAY = "SATURDAY",
+    /** Sunday. */
+    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.
+     */
+    fixedIntervalOptions?: FixedIntervalPolicy;
+    /** Maximum number of times benefit can be redeemed per renewal cycle. */
+    times?: number;
+    /** Specific method of setting the benefit limit. `FIXED_INTERVAL` type must be used with its corresponding `fixIntervalPolicyOptions` parameter. */
+    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.
+     */
+    fixedIntervalOptions?: FixedIntervalPolicy;
+}
+export declare enum RateLimitedPolicyType {
+    /** Unknown rate limit method. */
+    UNKNOWN = "UNKNOWN",
+    /** Fixed interval rate limit. The intervals are set using `fixIntervalPolicyOptions`. */
+    FIXED_INTERVAL = "FIXED_INTERVAL",
+    /** Rate limit is set with `times` field above. */
+    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 */
+    _id?: string;
+    /** Custom policy provider id */
+    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. */
+    amount?: string;
+    /** Rollover configuration. */
+    rolloverConfiguration?: RolloverConfiguration;
+    /** Display name of the unit. */
+    unitDisplayName?: string | null;
+}
+export interface RolloverConfiguration {
+    /** Determine whether unused credits are rolled over to the new cycle. */
+    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.
+     */
+    balanceCap?: string | null;
+}
+export interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+export interface PoolDefinitionAddedToProgramDefinition {
+    /** PoolDefinition that was added to the program definition */
+    poolDefinition?: PoolDefinition;
+    /** Program Definition that the pool definition was added to */
+    programDefinitionId?: string;
+    /** Type of cascade */
+    cascadeType?: Cascade;
+}
+export declare enum Cascade {
+    /** Unknown cascade. */
+    UNKNOWN_CASCADE = "UNKNOWN_CASCADE",
+    /**
+     * Updates the associated benefit pools to reflect the new or modified pool definition. The benefits will appear in existing programs at the beginning of their next renewal cycle.
+     *
+     * Existing programs will be updated in their next renewal cycle.
+     */
+    NEXT_RENEWAL = "NEXT_RENEWAL",
+    /**
+     * Updates the associated benefit pools to reflect the new or modified pool definition immediately.
+     *
+     * Existing programs will be updated immediately.
+     */
+    IMMEDIATELY = "IMMEDIATELY",
+    /**
+     * Updates the associated benefit pools to reflect the new or modified pool definition the next time the benefit pools are provisioned to a program.
+     *
+     * Existing programs will remain unaffected. Only newly purchased programs will display the benefits of this pool definition.
+     */
+    FUTURE_PROVISIONS = "FUTURE_PROVISIONS"
+}
+export interface PoolDefinitionRemovedFromProgramDefinition {
+    /** PoolDefinition that was removed from the program definition */
+    poolDefinition?: PoolDefinition;
+    /** Program Definition that the pool definition was removed from */
+    programDefinitionId?: string;
+    /** Type of cascade */
+    cascadeType?: Cascade;
+}
+export interface CreatePoolDefinitionRequest {
+    /** Pool definition to create. */
+    poolDefinition: PoolDefinition;
+    /**
+     * Specifies the timing of updates to associated benefit pools.
+     * Determines how and when changes are applied to existing and future benefit pools.
+     * Must be provided if `programDefinitionIds` are included in the `poolDefinition` parameter.
+     */
+    cascade?: Cascade;
+}
+export interface CreatePoolDefinitionResponse {
+    /** Created pool definition. */
+    poolDefinition?: PoolDefinition;
+}
+export interface BulkCreatePoolDefinitionsRequest {
+    /** Pool definitions to create. */
+    poolDefinitions: PoolDefinition[];
+    /**
+     * Specifies the timing of updates to associated benefit pools.
+     * Determines how and when changes are applied to existing and future benefit pools.
+     * Must be provided if `programDefinitionIds` are included in the `poolDefinition` parameter.
+     */
+    cascade?: Cascade;
+    /**
+     * Whether to return the full pool definition entities.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+export interface BulkCreatePoolDefinitionsResponse {
+    /**
+     * List of results for each pool definition.
+     *
+     * Includes the pool definition and whether the creation was successful.
+     */
+    results?: BulkPoolDefinitionResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkPoolDefinitionResult {
+    /** Item metadata. */
+    itemMetadata?: ItemMetadata;
+    /** Pool definition. */
+    poolDefinition?: PoolDefinition;
+}
+export interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+export interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+export interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+export interface UpdatePoolDefinitionRequest {
+    /** Pool definition to update. */
+    poolDefinition: PoolDefinition;
+    /**
+     * Specifies the timing of updates to associated benefit pools.
+     * Determines how and when changes are applied to existing and future benefit pools.
+     * Required field.
+     */
+    cascade?: Cascade;
+}
+export interface UpdatePoolDefinitionResponse {
+    /** Updated pool definition. */
+    poolDefinition?: PoolDefinition;
+}
+export interface BulkUpdatePoolDefinitionsRequest {
+    /** Pool definitions to update. */
+    poolDefinitions?: MaskedPoolDefinition[];
+    /**
+     * Specifies the timing of updates to associated benefit pools.
+     * Determines how and when changes are applied to existing and future benefit pools.
+     * Required field.
+     */
+    cascade?: Cascade;
+    /**
+     * Whether to return the full pool definition entities.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+export interface MaskedPoolDefinition {
+    /** Pool definition to be updated. */
+    poolDefinition?: PoolDefinition;
+    /** Explicit list of fields to update. */
+    fieldMask?: string[];
+}
+export interface BulkUpdatePoolDefinitionsResponse {
+    /**
+     * List of results for each pool definition.
+     *
+     * Includes the pool definition and whether the update was successful.
+     */
+    results?: BulkPoolDefinitionResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface DeletePoolDefinitionRequest {
+    /** ID of the pool definition to delete. */
+    poolDefinitionId: string;
+    /**
+     * Defines how the delete operation cascades to related pools.
+     * Specifies the timing of deletion regarding associated benefit pools.
+     * Required if the pool definition is associated with any program definition IDs.
+     */
+    cascade?: Cascade;
+}
+export interface DeletePoolDefinitionResponse {
+}
+export interface BulkDeletePoolDefinitionsRequest {
+    /** ID of the pool definitions to delete. */
+    poolDefinitionIds: string[];
+    /**
+     * Specifies the timing of updates to associated benefit pools.
+     * Required if any of the pool definitions listed for deletion are associated with a program definition ID.
+     */
+    cascade?: Cascade;
+}
+export interface BulkDeletePoolDefinitionsResponse {
+    /**
+     * List of results for each pool definition.
+     *
+     * Includes the pool definition and whether the deletion was successful.
+     */
+    results?: BulkPoolDefinitionResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface GetPoolDefinitionRequest {
+    /** ID of the pool definition to retrieve. */
+    poolDefinitionId: string;
+}
+export interface GetPoolDefinitionResponse {
+    /** Retrieved pool definition. */
+    poolDefinition?: PoolDefinition;
+}
+export interface QueryPoolDefinitionsRequest {
+    /** Query to select pool definitions. */
+    query?: CursorQuery;
+}
+export interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+export interface CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    /** Ascending sort order. */
+    ASC = "ASC",
+    /** Descending sort order. */
+    DESC = "DESC"
+}
+export interface CursorPaging {
+    /** Maximum number of items to return in the results. */
+    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.
+     */
+    cursor?: string | null;
+}
+export interface QueryPoolDefinitionsResponse {
+    /** List of pool definitions. */
+    poolDefinitions?: PoolDefinition[];
+    /** Metadata for the paginated results. */
+    metadata?: CursorPagingMetadata;
+}
+export interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+export interface Cursors {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+export interface AddPoolDefinitionToProgramDefinitionRequest {
+    /** Pool definition to assign to the program definition. */
+    poolDefinitionId: string;
+    /** Program definition that the pool definition is assigned to. */
+    programDefinitionId: string;
+    /**
+     * Specifies the timing of updates to associated benefit pools.
+     * Determines how and when changes are applied to existing and future benefit pools.
+     */
+    cascade: Cascade;
+}
+export interface AddPoolDefinitionToProgramDefinitionResponse {
+    /** Pool definition. */
+    poolDefinition?: PoolDefinition;
+}
+export interface RemovePoolDefinitionFromProgramDefinitionRequest {
+    /** ID of the pool definition to be removed from the program definition. */
+    poolDefinitionId: string;
+    /** ID of the program definition being removed from the pool definition. */
+    programDefinitionId: string;
+    /**
+     * Specifies the timing of updates to associated benefit pools.
+     * Determines how and when changes are applied to existing and future benefit pools.
+     */
+    cascade: Cascade;
+}
+export interface RemovePoolDefinitionFromProgramDefinitionResponse {
+    /** Updated pool definition. */
+    poolDefinition?: PoolDefinition;
+}
+export interface FindPoolDefinitionsByProgramDefinitionRequest {
+    /** ID of the program definition of which its assigned pool definitions are retrieved. */
+    programDefinitionId: string;
+    /**
+     * Application sub-module that represents the source of the pool definition. Specified by the external developer.
+     *
+     * 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.
+     */
+    namespace: string;
+}
+export interface FindPoolDefinitionsByProgramDefinitionResponse {
+    /** Retrieved pool definitions. */
+    poolDefinitions?: PoolDefinition[];
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entity?: string;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+export interface ActionEvent {
+    body?: string;
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface PolicyExpressionNotNonNullableFields {
+    expression?: PolicyExpressionNonNullableFields;
+}
+interface PolicyExpressionAndNonNullableFields {
+    expressions: PolicyExpressionNonNullableFields[];
+}
+interface PolicyExpressionOrNonNullableFields {
+    expressions: PolicyExpressionNonNullableFields[];
+}
+interface FixedIntervalPolicyNonNullableFields {
+    fromWeekDay: WeekDay;
+    toWeekDay: WeekDay;
+}
+interface RateLimitedPolicyNonNullableFields {
+    fixedIntervalOptions?: FixedIntervalPolicyNonNullableFields;
+    times: number;
+    type: RateLimitedPolicyType;
+}
+interface CustomPolicyNonNullableFields {
+    _id: string;
+}
+interface PolicyNonNullableFields {
+    fixedIntervalOptions?: FixedIntervalPolicyNonNullableFields;
+    rateLimitedOptions?: RateLimitedPolicyNonNullableFields;
+    customOptions?: CustomPolicyNonNullableFields;
+    type: Type;
+}
+interface PolicyExpressionNonNullableFields {
+    operatorNotOptions?: PolicyExpressionNotNonNullableFields;
+    operatorAndOptions?: PolicyExpressionAndNonNullableFields;
+    operatorOrOptions?: PolicyExpressionOrNonNullableFields;
+    policyOptions?: PolicyNonNullableFields;
+    type: PolicyExpressionType;
+}
+interface BenefitNonNullableFields {
+    benefitKey: string;
+    policyExpression?: PolicyExpressionNonNullableFields;
+}
+interface CreditConfigurationNonNullableFields {
+    amount: string;
+}
+interface DetailsNonNullableFields {
+    benefits: BenefitNonNullableFields[];
+    creditConfiguration?: CreditConfigurationNonNullableFields;
+    policyExpression?: PolicyExpressionNonNullableFields;
+}
+export interface PoolDefinitionNonNullableFields {
+    displayName: string;
+    programDefinitionIds: string[];
+    details?: DetailsNonNullableFields;
+}
+export interface CreatePoolDefinitionResponseNonNullableFields {
+    poolDefinition?: PoolDefinitionNonNullableFields;
+}
+interface ApplicationErrorNonNullableFields {
+    code: string;
+    description: string;
+}
+interface ItemMetadataNonNullableFields {
+    originalIndex: number;
+    success: boolean;
+    error?: ApplicationErrorNonNullableFields;
+}
+interface BulkPoolDefinitionResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+    poolDefinition?: PoolDefinitionNonNullableFields;
+}
+interface BulkActionMetadataNonNullableFields {
+    totalSuccesses: number;
+    totalFailures: number;
+    undetailedFailures: number;
+}
+export interface BulkCreatePoolDefinitionsResponseNonNullableFields {
+    results: BulkPoolDefinitionResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface UpdatePoolDefinitionResponseNonNullableFields {
+    poolDefinition?: PoolDefinitionNonNullableFields;
+}
+export interface BulkUpdatePoolDefinitionsResponseNonNullableFields {
+    results: BulkPoolDefinitionResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface BulkDeletePoolDefinitionsResponseNonNullableFields {
+    results: BulkPoolDefinitionResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface GetPoolDefinitionResponseNonNullableFields {
+    poolDefinition?: PoolDefinitionNonNullableFields;
+}
+export interface QueryPoolDefinitionsResponseNonNullableFields {
+    poolDefinitions: PoolDefinitionNonNullableFields[];
+}
+export interface AddPoolDefinitionToProgramDefinitionResponseNonNullableFields {
+    poolDefinition?: PoolDefinitionNonNullableFields;
+}
+export interface RemovePoolDefinitionFromProgramDefinitionResponseNonNullableFields {
+    poolDefinition?: PoolDefinitionNonNullableFields;
+}
+export interface FindPoolDefinitionsByProgramDefinitionResponseNonNullableFields {
+    poolDefinitions: PoolDefinitionNonNullableFields[];
+}
+/**
+ * Creates a new pool definition.
+ *
+ * A pool definition can be assigned to multiple program definitions by specifying its program definition ID in the `programDefinitionIds` parameter.
+ *
+ * If `programDefinitionIds` included in the request are associated with any active programs, then new benefit pools will be instantly created and added to the programs.
+ *
+ * If you specify program definition IDs in the request, you must include the `cascade` parameter, to specify the timing of the update to existing programs.
+ * @param poolDefinition - Pool definition to create.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField poolDefinition
+ * @requiredField poolDefinition.details
+ * @requiredField poolDefinition.details.benefits
+ * @requiredField poolDefinition.details.benefits.benefitKey
+ * @requiredField poolDefinition.details.benefits.providerAppId
+ * @requiredField poolDefinition.namespace
+ * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_CREATE
+ * @returns Created pool definition.
+ * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.CreatePoolDefinition
+ */
+export declare function createPoolDefinition(poolDefinition: PoolDefinition, options?: CreatePoolDefinitionOptions): Promise<PoolDefinition & PoolDefinitionNonNullableFields>;
+export interface CreatePoolDefinitionOptions {
+    /**
+     * Specifies the timing of updates to associated benefit pools.
+     * Determines how and when changes are applied to existing and future benefit pools.
+     * Must be provided if `programDefinitionIds` are included in the `poolDefinition` parameter.
+     */
+    cascade?: Cascade;
+}
+/**
+ * Creates new pool definitions.
+ * @param poolDefinitions - Pool definitions to create.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField poolDefinitions
+ * @requiredField poolDefinitions.details
+ * @requiredField poolDefinitions.details.benefits
+ * @requiredField poolDefinitions.details.benefits.benefitKey
+ * @requiredField poolDefinitions.details.benefits.providerAppId
+ * @requiredField poolDefinitions.namespace
+ * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_CREATE
+ * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.BulkCreatePoolDefinitions
+ */
+export declare function bulkCreatePoolDefinitions(poolDefinitions: PoolDefinition[], options?: BulkCreatePoolDefinitionsOptions): Promise<BulkCreatePoolDefinitionsResponse & BulkCreatePoolDefinitionsResponseNonNullableFields>;
+export interface BulkCreatePoolDefinitionsOptions {
+    /**
+     * Specifies the timing of updates to associated benefit pools.
+     * Determines how and when changes are applied to existing and future benefit pools.
+     * Must be provided if `programDefinitionIds` are included in the `poolDefinition` parameter.
+     */
+    cascade?: Cascade;
+    /**
+     * Whether to return the full pool definition entities.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+/**
+ * Updates a pool definition.
+ *
+ * Each time the pool definition is updated,
+ * `revision` increments by 1.
+ * The current `revision` must be passed when updating the pool definition.
+ * This ensures you're working with the latest pool definition
+ * and prevents unintended overwrites.
+ * @param _id - Pool definition ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField poolDefinition
+ * @requiredField poolDefinition.revision
+ * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
+ * @returns Updated pool definition.
+ * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.UpdatePoolDefinition
+ */
+export declare function updatePoolDefinition(_id: string | null, poolDefinition: UpdatePoolDefinition, options?: UpdatePoolDefinitionOptions): Promise<PoolDefinition & PoolDefinitionNonNullableFields>;
+export interface UpdatePoolDefinition {
+    /**
+     * Pool definition ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the pool definition is updated.
+     * To prevent conflicting changes, the current revision must be specified when updating the pool definition.
+     *
+     * Ignored when creating a pool definition.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the pool definition was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the pool definition was updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /** Name of the pool definition. */
+    displayName?: string;
+    /** List of program definitions that are associated with this pool definition. */
+    programDefinitionIds?: string[];
+    /**
+     * Benefit pool information.
+     *
+     * Includes the item, policy, and credit configurations.
+     */
+    details?: Details;
+    /**
+     * Application sub-module that represents the source of the pool definition. Specified by the external developer.
+     *
+     * 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.
+     */
+    namespace?: string | null;
+    /**
+     * Custom field data for the pool definition object.
+     *
+     * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
+     */
+    extendedFields?: ExtendedFields;
+}
+export interface UpdatePoolDefinitionOptions {
+    /**
+     * Specifies the timing of updates to associated benefit pools.
+     * Determines how and when changes are applied to existing and future benefit pools.
+     * Required field.
+     */
+    cascade?: Cascade;
+}
+/**
+ * Updates multiple pool definitions.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.poolDefinitions.poolDefinition
+ * @requiredField options.poolDefinitions.poolDefinition._id
+ * @requiredField options.poolDefinitions.poolDefinition.revision
+ * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
+ * @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. */
+    poolDefinitions?: MaskedPoolDefinition[];
+    /**
+     * Specifies the timing of updates to associated benefit pools.
+     * Determines how and when changes are applied to existing and future benefit pools.
+     * Required field.
+     */
+    cascade?: Cascade;
+    /**
+     * Whether to return the full pool definition entities.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+/**
+ * Deletes a pool definition.
+ * @param poolDefinitionId - ID of the pool definition to delete.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField poolDefinitionId
+ * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_DELETE
+ * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.DeletePoolDefinition
+ */
+export declare function deletePoolDefinition(poolDefinitionId: string, options?: DeletePoolDefinitionOptions): Promise<void>;
+export interface DeletePoolDefinitionOptions {
+    /**
+     * Defines how the delete operation cascades to related pools.
+     * Specifies the timing of deletion regarding associated benefit pools.
+     * Required if the pool definition is associated with any program definition IDs.
+     */
+    cascade?: Cascade;
+}
+/**
+ * Delete multiple pool definitions.
+ * @param poolDefinitionIds - ID of the pool definitions to delete.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField poolDefinitionIds
+ * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_DELETE
+ * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.BulkDeletePoolDefinitions
+ */
+export declare function bulkDeletePoolDefinitions(poolDefinitionIds: string[], options?: BulkDeletePoolDefinitionsOptions): Promise<BulkDeletePoolDefinitionsResponse & BulkDeletePoolDefinitionsResponseNonNullableFields>;
+export interface BulkDeletePoolDefinitionsOptions {
+    /**
+     * Specifies the timing of updates to associated benefit pools.
+     * Required if any of the pool definitions listed for deletion are associated with a program definition ID.
+     */
+    cascade?: Cascade;
+}
+/**
+ * Retrieves a pool definition.
+ * @param poolDefinitionId - ID of the pool definition to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField poolDefinitionId
+ * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_READ
+ * @applicableIdentity VISITOR
+ * @returns Retrieved pool definition.
+ * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.GetPoolDefinition
+ */
+export declare function getPoolDefinition(poolDefinitionId: string): Promise<PoolDefinition & PoolDefinitionNonNullableFields>;
+/**
+ * Creates a query to retrieve a list of pool definitions.
+ *
+ * The `queryPoolDefinitions()` method builds a query to retrieve a list of pool definitions and returns a `PoolDefinitionsQueryBuilder` object.
+ *
+ * The returned object contains the query definition, which is used to run the query using the [`find()`](/pool-definitions/pool-definitions-query-builder/find) function.
+ *
+ * You can refine the query by chaining `PoolDefinitionsQueryBuilder` methods onto the query. `PoolDefinitionsQueryBuilder` methods enable you to filter, sort, and control the results that `queryPoolDefinitions()` returns.
+ *
+ * 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
+ * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_READ
+ * @applicableIdentity VISITOR
+ * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.QueryPoolDefinitions
+ */
+export declare function queryPoolDefinitions(): PoolDefinitionsQueryBuilder;
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+export interface PoolDefinitionsQueryResult extends QueryCursorResult {
+    items: PoolDefinition[];
+    query: PoolDefinitionsQueryBuilder;
+    next: () => Promise<PoolDefinitionsQueryResult>;
+    prev: () => Promise<PoolDefinitionsQueryResult>;
+}
+export interface PoolDefinitionsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | '_createdDate' | 'programDefinitionIds' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace', value: any) => PoolDefinitionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | '_createdDate' | 'programDefinitionIds' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace', value: any) => PoolDefinitionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_createdDate', value: any) => PoolDefinitionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_createdDate', value: any) => PoolDefinitionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_createdDate', value: any) => PoolDefinitionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_createdDate', value: any) => PoolDefinitionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: '_id' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace', value: string) => PoolDefinitionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: '_id' | '_createdDate' | 'programDefinitionIds' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace', value: any[]) => PoolDefinitionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasAll: (propertyName: 'programDefinitionIds', value: any[]) => PoolDefinitionsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | '_createdDate' | 'programDefinitionIds' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace', value: any) => PoolDefinitionsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: '_id' | '_createdDate' | 'programDefinitionIds' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace', value: boolean) => PoolDefinitionsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'programDefinitionIds' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace'>) => PoolDefinitionsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_id' | '_createdDate' | 'programDefinitionIds' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace'>) => PoolDefinitionsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => PoolDefinitionsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => PoolDefinitionsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<PoolDefinitionsQueryResult>;
+}
+/**
+ * Assign a pool definition to a program definition.
+ *
+ * Links program definitions to existing pool definition so the defined pools will be included in the associated programs when they are provisioned.
+ * @param poolDefinitionId - Pool definition to assign to the program definition.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options
+ * @requiredField options.cascade
+ * @requiredField options.programDefinitionId
+ * @requiredField poolDefinitionId
+ * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
+ * @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. */
+    programDefinitionId: string;
+    /**
+     * Specifies the timing of updates to associated benefit pools.
+     * Determines how and when changes are applied to existing and future benefit pools.
+     */
+    cascade: Cascade;
+}
+/**
+ * Unassign a pool definition from a program definition.
+ *
+ * This action prevents the programs from including the specified benefit pool in future provisioning cycles.
+ *
+ * Can modify or exclude benefit pools from active programs.
+ * @param poolDefinitionId - ID of the pool definition to be removed from the program definition.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options
+ * @requiredField options.cascade
+ * @requiredField options.programDefinitionId
+ * @requiredField poolDefinitionId
+ * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
+ * @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. */
+    programDefinitionId: string;
+    /**
+     * Specifies the timing of updates to associated benefit pools.
+     * Determines how and when changes are applied to existing and future benefit pools.
+     */
+    cascade: Cascade;
+}
+/**
+ * Retrieve all pool definitions associated with a specific program definition.
+ *
+ * Find multiple pool definitions that belong to a given program definition.
+ * @param programDefinitionId - ID of the program definition of which its assigned pool definitions are retrieved.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options
+ * @requiredField options.namespace
+ * @requiredField programDefinitionId
+ * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_READ
+ * @applicableIdentity VISITOR
+ * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.FindPoolDefinitionsByProgramDefinition
+ */
+export declare function findPoolDefinitionsByProgramDefinition(programDefinitionId: string, options: FindPoolDefinitionsByProgramDefinitionOptions): Promise<FindPoolDefinitionsByProgramDefinitionResponse & FindPoolDefinitionsByProgramDefinitionResponseNonNullableFields>;
+export interface FindPoolDefinitionsByProgramDefinitionOptions {
+    /**
+     * Application sub-module that represents the source of the pool definition. Specified by the external developer.
+     *
+     * 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.
+     */
+    namespace: string;
+}
+export {};