@wix/auto_sdk_benefit-programs_pool-definitions 1.0.12 → 1.0.14

package/build/internal/{benefit-programs-v1-pool-definition-pool-definitions.universal-C-P5ex9L.d.mts → es/src/benefit-programs-v1-pool-definition-pool-definitions.universal.d.ts}

@@ -1,4 +1,5 @@
-interface PoolDefinition {
+import { NonNullablePaths } from '@wix/sdk-types';
+export interface PoolDefinition {
     /**
      * Pool definition ID.
      * @format GUID
@@ -52,7 +53,7 @@ interface PoolDefinition {
      */
     extendedFields?: ExtendedFields;
 }
-interface Details {
+export interface Details {
     /**
      * List of benefits.
      * @maxSize 10
@@ -67,7 +68,7 @@ interface Details {
     /** Additional information relating to this object. */
     additionalData?: Record<string, any> | null;
 }
-interface Benefit {
+export interface Benefit {
     /**
      * Unique identifier for this benefit.
      *
@@ -106,7 +107,7 @@ interface Benefit {
      */
     description?: string | null;
 }
-interface PolicyExpression extends PolicyExpressionExpressionOneOf {
+export interface PolicyExpression extends PolicyExpressionExpressionOneOf {
     /** Benefits can be redeemed if the expression in this object is not fulfilled. */
     operatorNotOptions?: PolicyExpressionNot;
     /** Benefits can be redeemed if all the expression in this object's array are fulfilled. */
@@ -119,7 +120,7 @@ interface PolicyExpression extends PolicyExpressionExpressionOneOf {
     type?: PolicyExpressionType;
 }
 /** @oneof */
-interface PolicyExpressionExpressionOneOf {
+export interface PolicyExpressionExpressionOneOf {
     /** Benefits can be redeemed if the expression in this object is not fulfilled. */
     operatorNotOptions?: PolicyExpressionNot;
     /** Benefits can be redeemed if all the expression in this object's array are fulfilled. */
@@ -129,7 +130,7 @@ interface PolicyExpressionExpressionOneOf {
     /** Defines when benefits can be redeemed or how many benefits can be redeemed in a specific time period. */
     policyOptions?: Policy;
 }
-declare enum PolicyExpressionType {
+export declare enum PolicyExpressionType {
     UNKNOWN = "UNKNOWN",
     /** Use with `operatorNotOptions`. */
     OPERATOR_NOT = "OPERATOR_NOT",
@@ -140,11 +141,11 @@ declare enum PolicyExpressionType {
     /** Use with `policyOptions`. */
     POLICY = "POLICY"
 }
-interface PolicyExpressionNot {
+export interface PolicyExpressionNot {
     /** Policy expression. If this expression is not fulfilled, benefits can be redeemed. */
     expression?: PolicyExpression;
 }
-interface PolicyExpressionAnd {
+export interface PolicyExpressionAnd {
     /**
      * Array of policy expressions. If all expressions are fulfilled, benefits can be redeemed.
      * @minSize 2
@@ -152,7 +153,7 @@ interface PolicyExpressionAnd {
      */
     expressions?: PolicyExpression[];
 }
-interface PolicyExpressionOr {
+export interface PolicyExpressionOr {
     /**
      * Array of policy expressions. If at least one expression is fulfilled, benefits can be redeemed.
      * @minSize 2
@@ -160,7 +161,7 @@ interface PolicyExpressionOr {
      */
     expressions?: PolicyExpression[];
 }
-interface Policy extends PolicyPolicyOneOf {
+export interface Policy extends PolicyPolicyOneOf {
     /**
      * Defines an interval during which the policy expression is fulfilled.
      *
@@ -175,7 +176,7 @@ interface Policy extends PolicyPolicyOneOf {
     type?: Type;
 }
 /** @oneof */
-interface PolicyPolicyOneOf {
+export interface PolicyPolicyOneOf {
     /**
      * Defines an interval during which the policy expression is fulfilled.
      *
@@ -187,7 +188,7 @@ interface PolicyPolicyOneOf {
     /** Custom policy defined by a different app. */
     customOptions?: CustomPolicy;
 }
-declare enum Type {
+export declare enum Type {
     /** Unknown policy type. */
     UNKNOWN = "UNKNOWN",
     /** Use with `fixedIntervalOptions`. */
@@ -197,7 +198,7 @@ declare enum Type {
     /** Use with `customOptions`. */
     CUSTOM = "CUSTOM"
 }
-interface FixedIntervalPolicy {
+export interface FixedIntervalPolicy {
     /** Weekday that this interval starts from. If this field is defined, then `toWeekDay` is required. */
     fromWeekDay?: WeekDay;
     /** Weekday that this interval ends at. If this field is defined, then `fromWeekDay` is required. */
@@ -223,7 +224,7 @@ interface FixedIntervalPolicy {
      */
     toMinute?: number | null;
 }
-declare enum WeekDay {
+export declare enum WeekDay {
     /** Unknown weekday. */
     UNKNOWN = "UNKNOWN",
     /** Monday. */
@@ -241,7 +242,7 @@ declare enum WeekDay {
     /** Sunday. */
     SUNDAY = "SUNDAY"
 }
-interface RateLimitedPolicy extends RateLimitedPolicyPeriodOneOf {
+export interface RateLimitedPolicy extends RateLimitedPolicyPeriodOneOf {
     /** Fixed interval used to limit benefit redemption. */
     fixedIntervalOptions?: FixedIntervalPolicy;
     /** Maximum number of times a benefit can be redeemed per specified time period. */
@@ -250,11 +251,11 @@ interface RateLimitedPolicy extends RateLimitedPolicyPeriodOneOf {
     type?: RateLimitedPolicyType;
 }
 /** @oneof */
-interface RateLimitedPolicyPeriodOneOf {
+export interface RateLimitedPolicyPeriodOneOf {
     /** Fixed interval used to limit benefit redemption. */
     fixedIntervalOptions?: FixedIntervalPolicy;
 }
-declare enum RateLimitedPolicyType {
+export declare enum RateLimitedPolicyType {
     /** Unknown rate limit method. */
     UNKNOWN = "UNKNOWN",
     /** Time period is defined using `fixedIntervalOptions`. */
@@ -263,7 +264,7 @@ declare enum RateLimitedPolicyType {
     PER_CYCLE = "PER_CYCLE"
 }
 /** Custom policy as implemented by the Entitlement Policy Provider */
-interface CustomPolicy {
+export interface CustomPolicy {
     /**
      * Policy ID.
      * @format GUID
@@ -277,7 +278,7 @@ interface CustomPolicy {
     /** Additional information for this custom policy. */
     additionalData?: Record<string, any> | null;
 }
-interface CreditConfiguration {
+export interface CreditConfiguration {
     /**
      * Initial available amount for associated balances.
      * @decimalValue options { gte:0, maxScale:4 }
@@ -291,7 +292,7 @@ interface CreditConfiguration {
      */
     unitDisplayName?: string | null;
 }
-interface RolloverConfiguration {
+export interface RolloverConfiguration {
     /** Whether unused credits roll over to a new cycle when a program renews. */
     enabled?: boolean | null;
     /**
@@ -300,7 +301,7 @@ interface RolloverConfiguration {
      */
     balanceCap?: string | null;
 }
-interface ExtendedFields {
+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.
@@ -311,7 +312,7 @@ interface ExtendedFields {
      */
     namespaces?: Record<string, Record<string, any>>;
 }
-interface PoolDefinitionAddedToProgramDefinition {
+export interface PoolDefinitionAddedToProgramDefinition {
     /** PoolDefinition that was added to the program definition */
     poolDefinition?: PoolDefinition;
     /**
@@ -322,7 +323,7 @@ interface PoolDefinitionAddedToProgramDefinition {
     /** Type of cascade */
     cascadeType?: Cascade;
 }
-declare enum Cascade {
+export declare enum Cascade {
     /** Unknown cascade. */
     UNKNOWN_CASCADE = "UNKNOWN_CASCADE",
     /** Changes are applied to existing programs and pools when they are next renewed. */
@@ -332,7 +333,7 @@ declare enum Cascade {
     /** Changes are not applied to existing associated programs and pools. They are only applied to future programs and pools. */
     FUTURE_PROVISIONS = "FUTURE_PROVISIONS"
 }
-interface PoolDefinitionRemovedFromProgramDefinition {
+export interface PoolDefinitionRemovedFromProgramDefinition {
     /** PoolDefinition that was removed from the program definition */
     poolDefinition?: PoolDefinition;
     /**
@@ -344,18 +345,18 @@ interface PoolDefinitionRemovedFromProgramDefinition {
     cascadeType?: Cascade;
 }
 /** This event is needed to support legacy benefit notification event. Should be only consumed in the proxy. */
-interface PoolDefinitionUpdatedProxySupport {
+export interface PoolDefinitionUpdatedProxySupport {
     /** PoolDefinition after the update */
     currentPoolDefinition?: PoolDefinition;
     /** PoolDefinition before the update */
     previousPoolDefinition?: PoolDefinition;
 }
 /** This event is needed to support legacy benefit notification event. Should be only consumed in the proxy. */
-interface PoolDefinitionDeletedProxySupport {
+export interface PoolDefinitionDeletedProxySupport {
     /** PoolDefinition which was deleted */
     deletedPoolDefinition?: PoolDefinition;
 }
-interface CreatePoolDefinitionRequest {
+export interface CreatePoolDefinitionRequest {
     /** Pool definition to create. */
     poolDefinition: PoolDefinition;
     /**
@@ -365,11 +366,11 @@ interface CreatePoolDefinitionRequest {
      */
     cascade?: Cascade;
 }
-interface CreatePoolDefinitionResponse {
+export interface CreatePoolDefinitionResponse {
     /** Created pool definition. */
     poolDefinition?: PoolDefinition;
 }
-interface BulkCreatePoolDefinitionsRequest {
+export interface BulkCreatePoolDefinitionsRequest {
     /**
      * Pool definitions to create.
      * @minSize 1
@@ -389,7 +390,7 @@ interface BulkCreatePoolDefinitionsRequest {
      */
     returnEntity?: boolean;
 }
-interface BulkCreatePoolDefinitionsResponse {
+export interface BulkCreatePoolDefinitionsResponse {
     /**
      * List of created pool definitions and associated metadata.
      * @minSize 1
@@ -399,13 +400,13 @@ interface BulkCreatePoolDefinitionsResponse {
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
-interface BulkPoolDefinitionResult {
+export interface BulkPoolDefinitionResult {
     /** Item metadata. */
     itemMetadata?: ItemMetadata;
     /** Pool definition. */
     poolDefinition?: PoolDefinition;
 }
-interface ItemMetadata {
+export interface ItemMetadata {
     /**
      * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
      * @format GUID
@@ -418,7 +419,7 @@ interface ItemMetadata {
     /** Details about the error in case of failure. */
     error?: ApplicationError;
 }
-interface ApplicationError {
+export interface ApplicationError {
     /** Error code. */
     code?: string;
     /** Description of the error. */
@@ -426,7 +427,7 @@ interface ApplicationError {
     /** Data related to the error. */
     data?: Record<string, any> | null;
 }
-interface BulkActionMetadata {
+export interface BulkActionMetadata {
     /** Number of items that were successfully processed. */
     totalSuccesses?: number;
     /** Number of items that couldn't be processed. */
@@ -434,17 +435,17 @@ interface BulkActionMetadata {
     /** Number of failures without details because detailed failure threshold was exceeded. */
     undetailedFailures?: number;
 }
-interface UpdatePoolDefinitionRequest {
+export interface UpdatePoolDefinitionRequest {
     /** Pool definition to update. */
     poolDefinition: PoolDefinition;
     /** *Required.** Determines when the changes to this pool definition and program definitions containing it will be applied to associated programs and pools. */
     cascade?: Cascade;
 }
-interface UpdatePoolDefinitionResponse {
+export interface UpdatePoolDefinitionResponse {
     /** Updated pool definition. */
     poolDefinition?: PoolDefinition;
 }
-interface BulkUpdatePoolDefinitionsRequest {
+export interface BulkUpdatePoolDefinitionsRequest {
     /**
      * Pool definitions to update.
      * @minSize 1
@@ -460,13 +461,13 @@ interface BulkUpdatePoolDefinitionsRequest {
      */
     returnEntity?: boolean;
 }
-interface MaskedPoolDefinition {
+export interface MaskedPoolDefinition {
     /** Pool definition to update. */
     poolDefinition?: PoolDefinition;
     /** Explicit list of fields to update. */
     fieldMask?: string[];
 }
-interface BulkUpdatePoolDefinitionsResponse {
+export interface BulkUpdatePoolDefinitionsResponse {
     /**
      * List of updated pool definitions and associated metadata.
      * @minSize 1
@@ -476,7 +477,7 @@ interface BulkUpdatePoolDefinitionsResponse {
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
-interface DeletePoolDefinitionRequest {
+export interface DeletePoolDefinitionRequest {
     /**
      * ID of the pool definition to delete.
      * @format GUID
@@ -485,9 +486,9 @@ interface DeletePoolDefinitionRequest {
     /** *Required**. Determines when the changes to this pool definition the program definitions containing it will be applied to associated programs and pools. */
     cascade?: Cascade;
 }
-interface DeletePoolDefinitionResponse {
+export interface DeletePoolDefinitionResponse {
 }
-interface BulkDeletePoolDefinitionsRequest {
+export interface BulkDeletePoolDefinitionsRequest {
     /**
      * List of IDs of the pool definitions to delete.
      * @minSize 1
@@ -498,7 +499,7 @@ interface BulkDeletePoolDefinitionsRequest {
     /** *Required**. Determines when the changes to these pool definitions the program definitions containing it will be applied to associated programs and pools. */
     cascade?: Cascade;
 }
-interface BulkDeletePoolDefinitionsResponse {
+export interface BulkDeletePoolDefinitionsResponse {
     /**
      * List of deleted pool definitions and associated metadata.
      * @minSize 1
@@ -508,22 +509,22 @@ interface BulkDeletePoolDefinitionsResponse {
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
-interface GetPoolDefinitionRequest {
+export interface GetPoolDefinitionRequest {
     /**
      * ID of the pool definition to retrieve.
      * @format GUID
      */
     poolDefinitionId: string;
 }
-interface GetPoolDefinitionResponse {
+export interface GetPoolDefinitionResponse {
     /** Retrieved pool definition. */
     poolDefinition?: PoolDefinition;
 }
-interface QueryPoolDefinitionsRequest {
+export interface QueryPoolDefinitionsRequest {
     /** Filter, sort, and paging to apply to the query. */
     query?: CursorQuery;
 }
-interface CursorQuery extends CursorQueryPagingMethodOneOf {
+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;
     /**
@@ -539,11 +540,11 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
     sort?: Sorting[];
 }
 /** @oneof */
-interface CursorQueryPagingMethodOneOf {
+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;
 }
-interface Sorting {
+export interface Sorting {
     /**
      * Field to sort by.
      * @maxLength 512
@@ -556,13 +557,13 @@ interface Sorting {
      */
     order?: SortOrder;
 }
-declare enum SortOrder {
+export declare enum SortOrder {
     /** Ascending sort order. */
     ASC = "ASC",
     /** Descending sort order. */
     DESC = "DESC"
 }
-interface CursorPaging {
+export interface CursorPaging {
     /**
      * Maximum number of items to return.
      * @max 100
@@ -577,13 +578,13 @@ interface CursorPaging {
      */
     cursor?: string | null;
 }
-interface QueryPoolDefinitionsResponse {
+export interface QueryPoolDefinitionsResponse {
     /** List of retrieved pool definitions. */
     poolDefinitions?: PoolDefinition[];
     /** Metadata for the paginated results. */
     metadata?: CursorPagingMetadata;
 }
-interface 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. */
@@ -596,7 +597,7 @@ interface CursorPagingMetadata {
      */
     hasNext?: boolean | null;
 }
-interface Cursors {
+export interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -608,7 +609,7 @@ interface Cursors {
      */
     prev?: string | null;
 }
-interface AddPoolDefinitionToProgramDefinitionRequest {
+export interface AddPoolDefinitionToProgramDefinitionRequest {
     /**
      * ID of the pool definition to add to the program definition.
      * @format GUID
@@ -622,11 +623,11 @@ interface AddPoolDefinitionToProgramDefinitionRequest {
     /** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
     cascade: Cascade;
 }
-interface AddPoolDefinitionToProgramDefinitionResponse {
+export interface AddPoolDefinitionToProgramDefinitionResponse {
     /** Updated pool definition. */
     poolDefinition?: PoolDefinition;
 }
-interface RemovePoolDefinitionFromProgramDefinitionRequest {
+export interface RemovePoolDefinitionFromProgramDefinitionRequest {
     /**
      * ID of the pool definition to remove from the program definition.
      * @format GUID
@@ -640,11 +641,11 @@ interface RemovePoolDefinitionFromProgramDefinitionRequest {
     /** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
     cascade: Cascade;
 }
-interface RemovePoolDefinitionFromProgramDefinitionResponse {
+export interface RemovePoolDefinitionFromProgramDefinitionResponse {
     /** Updated pool definition. */
     poolDefinition?: PoolDefinition;
 }
-interface FindPoolDefinitionsByProgramDefinitionRequest {
+export interface FindPoolDefinitionsByProgramDefinitionRequest {
     /**
      * ID of the program definition to retrieve its pool definitions.
      * @format GUID
@@ -657,11 +658,11 @@ interface FindPoolDefinitionsByProgramDefinitionRequest {
      */
     namespace: string;
 }
-interface FindPoolDefinitionsByProgramDefinitionResponse {
+export interface FindPoolDefinitionsByProgramDefinitionResponse {
     /** Retrieved pool definitions. */
     poolDefinitions?: PoolDefinition[];
 }
-interface DomainEvent extends DomainEventBodyOneOf {
+export interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -704,19 +705,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-interface DomainEventBodyOneOf {
+export interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-interface EntityCreatedEvent {
+export interface EntityCreatedEvent {
     entity?: string;
 }
-interface RestoreInfo {
+export interface RestoreInfo {
     deletedDate?: Date | null;
 }
-interface EntityUpdatedEvent {
+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.
@@ -724,14 +725,14 @@ interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-interface EntityDeletedEvent {
+export interface EntityDeletedEvent {
     /** Entity that was deleted */
     deletedEntity?: string | null;
 }
-interface ActionEvent {
+export interface ActionEvent {
     body?: string;
 }
-interface MessageEnvelope {
+export interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -747,7 +748,7 @@ interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-interface IdentificationData extends IdentificationDataIdOneOf {
+export interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -772,7 +773,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-interface IdentificationDataIdOneOf {
+export interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -794,14 +795,34 @@ interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-declare enum WebhookIdentityType {
+export declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-interface CreatePoolDefinitionOptions {
+type PoolDefinitionNonNullablePaths = `displayName` | `programDefinitionIds` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.creditConfiguration.amount`;
+/**
+ * Creates a pool definition.
+ * @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
+ * @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
+ */
+export declare function createPoolDefinition(poolDefinition: NonNullablePaths<PoolDefinition, `details` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.benefits.${number}.providerAppId` | `namespace`>, options?: CreatePoolDefinitionOptions): Promise<NonNullablePaths<PoolDefinition, PoolDefinitionNonNullablePaths>>;
+export interface CreatePoolDefinitionOptions {
     /**
      * Determines when the changes to the program definitions containing this pool definition will be applied to associated programs.
      *
@@ -809,7 +830,27 @@ interface CreatePoolDefinitionOptions {
      */
     cascade?: Cascade;
 }
-interface BulkCreatePoolDefinitionsOptions {
+/**
+ * Creates 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
+ * @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: NonNullablePaths<PoolDefinition, `details` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.benefits.${number}.providerAppId` | `namespace`>[], options?: BulkCreatePoolDefinitionsOptions): Promise<NonNullablePaths<BulkCreatePoolDefinitionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+    [P in PoolDefinitionNonNullablePaths]: `results.${number}.poolDefinition.${P}`;
+}[PoolDefinitionNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
+export interface BulkCreatePoolDefinitionsOptions {
     /**
      * Determines when the changes to the program definitions containing these pool definitions will be applied to associated programs.
      *
@@ -823,7 +864,29 @@ interface BulkCreatePoolDefinitionsOptions {
      */
     returnEntity?: boolean;
 }
-interface UpdatePoolDefinition {
+/**
+ * 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
+ * @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
+ */
+export declare function updatePoolDefinition(_id: string, poolDefinition: NonNullablePaths<UpdatePoolDefinition, `revision`>, options?: UpdatePoolDefinitionOptions): Promise<NonNullablePaths<PoolDefinition, PoolDefinitionNonNullablePaths>>;
+export interface UpdatePoolDefinition {
     /**
      * Pool definition ID.
      * @format GUID
@@ -877,11 +940,27 @@ interface UpdatePoolDefinition {
      */
     extendedFields?: ExtendedFields;
 }
-interface UpdatePoolDefinitionOptions {
+export interface UpdatePoolDefinitionOptions {
     /** Required.** Determines when the changes to this pool definition and program definitions containing it will be applied to associated programs and pools. */
     cascade?: Cascade;
 }
-interface BulkUpdatePoolDefinitionsOptions {
+/**
+ * Updates 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
+ * @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?: NonNullablePaths<BulkUpdatePoolDefinitionsOptions, `poolDefinitions.${number}.poolDefinition` | `poolDefinitions.${number}.poolDefinition._id` | `poolDefinitions.${number}.poolDefinition.revision`>): Promise<NonNullablePaths<BulkUpdatePoolDefinitionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+    [P in PoolDefinitionNonNullablePaths]: `results.${number}.poolDefinition.${P}`;
+}[PoolDefinitionNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
+export interface BulkUpdatePoolDefinitionsOptions {
     /**
      * Pool definitions to update.
      * @minSize 1
@@ -897,14 +976,87 @@ interface BulkUpdatePoolDefinitionsOptions {
      */
     returnEntity?: boolean;
 }
-interface DeletePoolDefinitionOptions {
+/**
+ * Deletes a pool definition.
+ * @param poolDefinitionId - ID of the pool definition to delete.
+ * @public
+ * @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>;
+export interface DeletePoolDefinitionOptions {
     /** Required**. Determines when the changes to this pool definition the program definitions containing it will be applied to associated programs and pools. */
     cascade?: Cascade;
 }
-interface BulkDeletePoolDefinitionsOptions {
+/**
+ * Deletes pool definitions.
+ * @param poolDefinitionIds - List of IDs of the pool definitions to delete.
+ * @public
+ * @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<NonNullablePaths<BulkDeletePoolDefinitionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+    [P in PoolDefinitionNonNullablePaths]: `results.${number}.poolDefinition.${P}`;
+}[PoolDefinitionNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
+export interface BulkDeletePoolDefinitionsOptions {
     /** Required**. Determines when the changes to these pool definitions the program definitions containing it will be applied to associated programs and pools. */
     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
+ * @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
+ */
+export declare function getPoolDefinition(poolDefinitionId: string): Promise<NonNullablePaths<PoolDefinition, PoolDefinitionNonNullablePaths>>;
+/**
+ * Creates a query to retrieve a list of pool definitions.
+ *
+ * The Query Pool Definitions 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()` method.
+ *
+ * You can refine the query by chaining `PoolDefinitionsQueryBuilder` methods onto the query. `PoolDefinitionsQueryBuilder` methods enable you to filter, sort, and control the results that Query Pool Definitions returns.
+ *
+ * Query Pool Definitions has a default paging limit of 50, which you can override.
+ *
+ *  For a full description of the item object, see the object returned for the `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
+ */
+export declare function queryPoolDefinitions(): PoolDefinitionsQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -912,13 +1064,13 @@ interface QueryCursorResult {
     length: number;
     pageSize: number;
 }
-interface PoolDefinitionsQueryResult extends QueryCursorResult {
+export interface PoolDefinitionsQueryResult extends QueryCursorResult {
     items: PoolDefinition[];
     query: PoolDefinitionsQueryBuilder;
     next: () => Promise<PoolDefinitionsQueryResult>;
     prev: () => Promise<PoolDefinitionsQueryResult>;
 }
-interface PoolDefinitionsQueryBuilder {
+export interface PoolDefinitionsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
@@ -987,7 +1139,27 @@ interface PoolDefinitionsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<PoolDefinitionsQueryResult>;
 }
-interface AddPoolDefinitionToProgramDefinitionOptions {
+/**
+ * Adds a pool definition to a program definition.
+ *
+ * Pool definitions can be contained by multiple program definitions, so this doesn't affect other program definitions that contain this pool definition.
+ * @param poolDefinitionId - ID of the pool definition to add to the program definition.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options
+ * @requiredField options.cascade
+ * @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: NonNullablePaths<AddPoolDefinitionToProgramDefinitionOptions, `cascade` | `programDefinitionId`>): Promise<NonNullablePaths<AddPoolDefinitionToProgramDefinitionResponse, {
+    [P in PoolDefinitionNonNullablePaths]: `poolDefinition.${P}`;
+}[PoolDefinitionNonNullablePaths]>>;
+export interface AddPoolDefinitionToProgramDefinitionOptions {
     /**
      * ID of the program definition to add the pool definition to.
      * @format GUID
@@ -996,7 +1168,27 @@ interface AddPoolDefinitionToProgramDefinitionOptions {
     /** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
     cascade: Cascade;
 }
-interface RemovePoolDefinitionFromProgramDefinitionOptions {
+/**
+ * Removes a pool definition from a program definition.
+ *
+ * Pool definitions don't need to be contained by a program definition, so this doesn't affect the usability of this pool definition.
+ * @param poolDefinitionId - ID of the pool definition to remove from the program definition.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options
+ * @requiredField options.cascade
+ * @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: NonNullablePaths<RemovePoolDefinitionFromProgramDefinitionOptions, `cascade` | `programDefinitionId`>): Promise<NonNullablePaths<RemovePoolDefinitionFromProgramDefinitionResponse, {
+    [P in PoolDefinitionNonNullablePaths]: `poolDefinition.${P}`;
+}[PoolDefinitionNonNullablePaths]>>;
+export interface RemovePoolDefinitionFromProgramDefinitionOptions {
     /**
      * ID of the program definition to remove the pool definition from.
      * @format GUID
@@ -1005,7 +1197,29 @@ interface RemovePoolDefinitionFromProgramDefinitionOptions {
     /** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
     cascade: Cascade;
 }
-interface FindPoolDefinitionsByProgramDefinitionOptions {
+/**
+ * Retrieve all a program definition's pool definitions.
+ * @param programDefinitionId - ID of the program definition to retrieve its pool definitions.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options
+ * @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
+ */
+export declare function findPoolDefinitionsByProgramDefinition(programDefinitionId: string, options: NonNullablePaths<FindPoolDefinitionsByProgramDefinitionOptions, `namespace`>): Promise<NonNullablePaths<FindPoolDefinitionsByProgramDefinitionResponse, {
+    [P in PoolDefinitionNonNullablePaths]: `poolDefinitions.${number}.${P}`;
+}[PoolDefinitionNonNullablePaths]>>;
+export interface FindPoolDefinitionsByProgramDefinitionOptions {
     /**
      * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
      * @minLength 1
@@ -1013,5 +1227,4 @@ interface FindPoolDefinitionsByProgramDefinitionOptions {
      */
     namespace: string;
 }
-
-export { type UpdatePoolDefinitionResponse as $, type AddPoolDefinitionToProgramDefinitionOptions as A, type BulkCreatePoolDefinitionsOptions as B, type CreatePoolDefinitionOptions as C, type DeletePoolDefinitionOptions as D, type CustomPolicy as E, type FindPoolDefinitionsByProgramDefinitionOptions as F, type CreditConfiguration as G, type RolloverConfiguration as H, type ExtendedFields as I, type PoolDefinitionAddedToProgramDefinition as J, type PoolDefinitionRemovedFromProgramDefinition as K, type PoolDefinitionUpdatedProxySupport as L, type PoolDefinitionDeletedProxySupport as M, type CreatePoolDefinitionRequest as N, type CreatePoolDefinitionResponse as O, type PoolDefinition as P, type BulkCreatePoolDefinitionsRequest as Q, type RemovePoolDefinitionFromProgramDefinitionOptions as R, SortOrder as S, Type as T, type UpdatePoolDefinition as U, type BulkPoolDefinitionResult as V, WeekDay as W, type ItemMetadata as X, type ApplicationError as Y, type BulkActionMetadata as Z, type UpdatePoolDefinitionRequest as _, type BulkCreatePoolDefinitionsResponse as a, type BulkUpdatePoolDefinitionsRequest as a0, type MaskedPoolDefinition as a1, type DeletePoolDefinitionRequest as a2, type DeletePoolDefinitionResponse as a3, type BulkDeletePoolDefinitionsRequest as a4, type GetPoolDefinitionRequest as a5, type GetPoolDefinitionResponse as a6, type QueryPoolDefinitionsRequest as a7, type CursorQuery as a8, type CursorQueryPagingMethodOneOf as a9, type Sorting as aa, type CursorPaging as ab, type QueryPoolDefinitionsResponse as ac, type CursorPagingMetadata as ad, type Cursors as ae, type AddPoolDefinitionToProgramDefinitionRequest as af, type RemovePoolDefinitionFromProgramDefinitionRequest as ag, type FindPoolDefinitionsByProgramDefinitionRequest as ah, type DomainEvent as ai, type DomainEventBodyOneOf as aj, type EntityCreatedEvent as ak, type RestoreInfo as al, type EntityUpdatedEvent as am, type EntityDeletedEvent as an, type ActionEvent as ao, type MessageEnvelope as ap, type IdentificationData as aq, type IdentificationDataIdOneOf as ar, type PoolDefinitionsQueryResult as as, type UpdatePoolDefinitionOptions as b, type BulkUpdatePoolDefinitionsOptions as c, type BulkUpdatePoolDefinitionsResponse as d, type BulkDeletePoolDefinitionsOptions as e, type BulkDeletePoolDefinitionsResponse as f, type PoolDefinitionsQueryBuilder as g, type AddPoolDefinitionToProgramDefinitionResponse as h, type RemovePoolDefinitionFromProgramDefinitionResponse as i, type FindPoolDefinitionsByProgramDefinitionResponse as j, PolicyExpressionType as k, RateLimitedPolicyType as l, Cascade as m, WebhookIdentityType as n, type Details as o, type Benefit as p, type PolicyExpression as q, type PolicyExpressionExpressionOneOf as r, type PolicyExpressionNot as s, type PolicyExpressionAnd as t, type PolicyExpressionOr as u, type Policy as v, type PolicyPolicyOneOf as w, type FixedIntervalPolicy as x, type RateLimitedPolicy as y, type RateLimitedPolicyPeriodOneOf as z };
+export {};