@wix/auto_sdk_benefit-programs_pool-definitions 1.0.19 → 1.0.21

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

@@ -1,5 +1,4 @@
-import { NonNullablePaths } from '@wix/sdk-types';
-export interface PoolDefinition {
+interface PoolDefinition {
     /**
      * Pool definition ID.
      * @format GUID
@@ -53,7 +52,7 @@ export interface PoolDefinition {
      */
     extendedFields?: ExtendedFields;
 }
-export interface Details {
+interface Details {
     /**
      * List of benefits.
      * @maxSize 10
@@ -68,7 +67,7 @@ export interface Details {
     /** Additional information relating to this object. */
     additionalData?: Record<string, any> | null;
 }
-export interface Benefit {
+interface Benefit {
     /**
      * Unique identifier for this benefit.
      *
@@ -107,7 +106,7 @@ export interface Benefit {
      */
     description?: string | null;
 }
-export interface PolicyExpression extends PolicyExpressionExpressionOneOf {
+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. */
@@ -120,7 +119,7 @@ export interface PolicyExpression extends PolicyExpressionExpressionOneOf {
     type?: PolicyExpressionTypeWithLiterals;
 }
 /** @oneof */
-export interface PolicyExpressionExpressionOneOf {
+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. */
@@ -130,7 +129,7 @@ export interface PolicyExpressionExpressionOneOf {
     /** Defines when benefits can be redeemed or how many benefits can be redeemed in a specific time period. */
     policyOptions?: Policy;
 }
-export declare enum PolicyExpressionType {
+declare enum PolicyExpressionType {
     UNKNOWN = "UNKNOWN",
     /** Use with `operatorNotOptions`. */
     OPERATOR_NOT = "OPERATOR_NOT",
@@ -142,12 +141,12 @@ export declare enum PolicyExpressionType {
     POLICY = "POLICY"
 }
 /** @enumType */
-export type PolicyExpressionTypeWithLiterals = PolicyExpressionType | 'UNKNOWN' | 'OPERATOR_NOT' | 'OPERATOR_AND' | 'OPERATOR_OR' | 'POLICY';
-export interface PolicyExpressionNot {
+type PolicyExpressionTypeWithLiterals = PolicyExpressionType | 'UNKNOWN' | 'OPERATOR_NOT' | 'OPERATOR_AND' | 'OPERATOR_OR' | 'POLICY';
+interface PolicyExpressionNot {
     /** Policy expression. If this expression is not fulfilled, benefits can be redeemed. */
     expression?: PolicyExpression;
 }
-export interface PolicyExpressionAnd {
+interface PolicyExpressionAnd {
     /**
      * Array of policy expressions. If all expressions are fulfilled, benefits can be redeemed.
      * @minSize 2
@@ -155,7 +154,7 @@ export interface PolicyExpressionAnd {
      */
     expressions?: PolicyExpression[];
 }
-export interface PolicyExpressionOr {
+interface PolicyExpressionOr {
     /**
      * Array of policy expressions. If at least one expression is fulfilled, benefits can be redeemed.
      * @minSize 2
@@ -163,7 +162,7 @@ export interface PolicyExpressionOr {
      */
     expressions?: PolicyExpression[];
 }
-export interface Policy extends PolicyPolicyOneOf {
+interface Policy extends PolicyPolicyOneOf {
     /**
      * Defines an interval during which the policy expression is fulfilled.
      *
@@ -178,7 +177,7 @@ export interface Policy extends PolicyPolicyOneOf {
     type?: TypeWithLiterals;
 }
 /** @oneof */
-export interface PolicyPolicyOneOf {
+interface PolicyPolicyOneOf {
     /**
      * Defines an interval during which the policy expression is fulfilled.
      *
@@ -190,7 +189,7 @@ export interface PolicyPolicyOneOf {
     /** Custom policy defined by a different app. */
     customOptions?: CustomPolicy;
 }
-export declare enum Type {
+declare enum Type {
     /** Unknown policy type. */
     UNKNOWN = "UNKNOWN",
     /** Use with `fixedIntervalOptions`. */
@@ -201,8 +200,8 @@ export declare enum Type {
     CUSTOM = "CUSTOM"
 }
 /** @enumType */
-export type TypeWithLiterals = Type | 'UNKNOWN' | 'FIXED_INTERVAL' | 'RATE_LIMITED' | 'CUSTOM';
-export interface FixedIntervalPolicy {
+type TypeWithLiterals = Type | 'UNKNOWN' | 'FIXED_INTERVAL' | 'RATE_LIMITED' | 'CUSTOM';
+interface FixedIntervalPolicy {
     /** Weekday that this interval starts from. If this field is defined, then `toWeekDay` is required. */
     fromWeekDay?: WeekDayWithLiterals;
     /** Weekday that this interval ends at. If this field is defined, then `fromWeekDay` is required. */
@@ -228,7 +227,7 @@ export interface FixedIntervalPolicy {
      */
     toMinute?: number | null;
 }
-export declare enum WeekDay {
+declare enum WeekDay {
     /** Unknown weekday. */
     UNKNOWN = "UNKNOWN",
     /** Monday. */
@@ -247,8 +246,8 @@ export declare enum WeekDay {
     SUNDAY = "SUNDAY"
 }
 /** @enumType */
-export type WeekDayWithLiterals = WeekDay | 'UNKNOWN' | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
-export interface RateLimitedPolicy extends RateLimitedPolicyPeriodOneOf {
+type WeekDayWithLiterals = WeekDay | 'UNKNOWN' | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
+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. */
@@ -257,11 +256,11 @@ export interface RateLimitedPolicy extends RateLimitedPolicyPeriodOneOf {
     type?: RateLimitedPolicyTypeWithLiterals;
 }
 /** @oneof */
-export interface RateLimitedPolicyPeriodOneOf {
+interface RateLimitedPolicyPeriodOneOf {
     /** Fixed interval used to limit benefit redemption. */
     fixedIntervalOptions?: FixedIntervalPolicy;
 }
-export declare enum RateLimitedPolicyType {
+declare enum RateLimitedPolicyType {
     /** Unknown rate limit method. */
     UNKNOWN = "UNKNOWN",
     /** Time period is defined using `fixedIntervalOptions`. */
@@ -270,9 +269,9 @@ export declare enum RateLimitedPolicyType {
     PER_CYCLE = "PER_CYCLE"
 }
 /** @enumType */
-export type RateLimitedPolicyTypeWithLiterals = RateLimitedPolicyType | 'UNKNOWN' | 'FIXED_INTERVAL' | 'PER_CYCLE';
+type RateLimitedPolicyTypeWithLiterals = RateLimitedPolicyType | 'UNKNOWN' | 'FIXED_INTERVAL' | 'PER_CYCLE';
 /** Custom policy as implemented by the Entitlement Policy Provider */
-export interface CustomPolicy {
+interface CustomPolicy {
     /**
      * Policy ID.
      * @format GUID
@@ -286,7 +285,7 @@ export interface CustomPolicy {
     /** Additional information for this custom policy. */
     additionalData?: Record<string, any> | null;
 }
-export interface CreditConfiguration {
+interface CreditConfiguration {
     /**
      * Initial available amount for associated balances.
      * @decimalValue options { gte:0, maxScale:4 }
@@ -300,7 +299,7 @@ export interface CreditConfiguration {
      */
     unitDisplayName?: string | null;
 }
-export interface RolloverConfiguration {
+interface RolloverConfiguration {
     /** Whether unused credits roll over to a new cycle when a program renews. */
     enabled?: boolean | null;
     /**
@@ -309,7 +308,7 @@ export interface RolloverConfiguration {
      */
     balanceCap?: string | null;
 }
-export interface ExtendedFields {
+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.
@@ -320,7 +319,7 @@ export interface ExtendedFields {
      */
     namespaces?: Record<string, Record<string, any>>;
 }
-export interface PoolDefinitionAddedToProgramDefinition {
+interface PoolDefinitionAddedToProgramDefinition {
     /** PoolDefinition that was added to the program definition */
     poolDefinition?: PoolDefinition;
     /**
@@ -331,7 +330,7 @@ export interface PoolDefinitionAddedToProgramDefinition {
     /** Type of cascade */
     cascadeType?: CascadeWithLiterals;
 }
-export declare enum Cascade {
+declare enum Cascade {
     /** Unknown cascade. */
     UNKNOWN_CASCADE = "UNKNOWN_CASCADE",
     /** Changes are applied to existing programs and pools when they are next renewed. */
@@ -342,8 +341,8 @@ export declare enum Cascade {
     FUTURE_PROVISIONS = "FUTURE_PROVISIONS"
 }
 /** @enumType */
-export type CascadeWithLiterals = Cascade | 'UNKNOWN_CASCADE' | 'NEXT_RENEWAL' | 'IMMEDIATELY' | 'FUTURE_PROVISIONS';
-export interface PoolDefinitionRemovedFromProgramDefinition {
+type CascadeWithLiterals = Cascade | 'UNKNOWN_CASCADE' | 'NEXT_RENEWAL' | 'IMMEDIATELY' | 'FUTURE_PROVISIONS';
+interface PoolDefinitionRemovedFromProgramDefinition {
     /** PoolDefinition that was removed from the program definition */
     poolDefinition?: PoolDefinition;
     /**
@@ -355,18 +354,18 @@ export interface PoolDefinitionRemovedFromProgramDefinition {
     cascadeType?: CascadeWithLiterals;
 }
 /** This event is needed to support legacy benefit notification event. Should be only consumed in the proxy. */
-export interface PoolDefinitionUpdatedProxySupport {
+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. */
-export interface PoolDefinitionDeletedProxySupport {
+interface PoolDefinitionDeletedProxySupport {
     /** PoolDefinition which was deleted */
     deletedPoolDefinition?: PoolDefinition;
 }
-export interface CreatePoolDefinitionRequest {
+interface CreatePoolDefinitionRequest {
     /** Pool definition to create. */
     poolDefinition: PoolDefinition;
     /**
@@ -376,11 +375,11 @@ export interface CreatePoolDefinitionRequest {
      */
     cascade?: CascadeWithLiterals;
 }
-export interface CreatePoolDefinitionResponse {
+interface CreatePoolDefinitionResponse {
     /** Created pool definition. */
     poolDefinition?: PoolDefinition;
 }
-export interface BulkCreatePoolDefinitionsRequest {
+interface BulkCreatePoolDefinitionsRequest {
     /**
      * Pool definitions to create.
      * @minSize 1
@@ -400,7 +399,7 @@ export interface BulkCreatePoolDefinitionsRequest {
      */
     returnEntity?: boolean;
 }
-export interface BulkCreatePoolDefinitionsResponse {
+interface BulkCreatePoolDefinitionsResponse {
     /**
      * List of created pool definitions and associated metadata.
      * @minSize 1
@@ -410,13 +409,13 @@ export interface BulkCreatePoolDefinitionsResponse {
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
-export interface BulkPoolDefinitionResult {
+interface BulkPoolDefinitionResult {
     /** Item metadata. */
     itemMetadata?: ItemMetadata;
     /** Pool definition. */
     poolDefinition?: PoolDefinition;
 }
-export interface ItemMetadata {
+interface ItemMetadata {
     /**
      * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
      * @format GUID
@@ -429,7 +428,7 @@ export interface ItemMetadata {
     /** Details about the error in case of failure. */
     error?: ApplicationError;
 }
-export interface ApplicationError {
+interface ApplicationError {
     /** Error code. */
     code?: string;
     /** Description of the error. */
@@ -437,7 +436,7 @@ export interface ApplicationError {
     /** Data related to the error. */
     data?: Record<string, any> | null;
 }
-export interface BulkActionMetadata {
+interface BulkActionMetadata {
     /** Number of items that were successfully processed. */
     totalSuccesses?: number;
     /** Number of items that couldn't be processed. */
@@ -445,17 +444,17 @@ export interface BulkActionMetadata {
     /** Number of failures without details because detailed failure threshold was exceeded. */
     undetailedFailures?: number;
 }
-export interface UpdatePoolDefinitionRequest {
+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?: CascadeWithLiterals;
 }
-export interface UpdatePoolDefinitionResponse {
+interface UpdatePoolDefinitionResponse {
     /** Updated pool definition. */
     poolDefinition?: PoolDefinition;
 }
-export interface BulkUpdatePoolDefinitionsRequest {
+interface BulkUpdatePoolDefinitionsRequest {
     /**
      * Pool definitions to update.
      * @minSize 1
@@ -471,13 +470,13 @@ export interface BulkUpdatePoolDefinitionsRequest {
      */
     returnEntity?: boolean;
 }
-export interface MaskedPoolDefinition {
+interface MaskedPoolDefinition {
     /** Pool definition to update. */
     poolDefinition?: PoolDefinition;
     /** Explicit list of fields to update. */
     fieldMask?: string[];
 }
-export interface BulkUpdatePoolDefinitionsResponse {
+interface BulkUpdatePoolDefinitionsResponse {
     /**
      * List of updated pool definitions and associated metadata.
      * @minSize 1
@@ -487,7 +486,7 @@ export interface BulkUpdatePoolDefinitionsResponse {
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
-export interface DeletePoolDefinitionRequest {
+interface DeletePoolDefinitionRequest {
     /**
      * ID of the pool definition to delete.
      * @format GUID
@@ -496,9 +495,9 @@ export 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?: CascadeWithLiterals;
 }
-export interface DeletePoolDefinitionResponse {
+interface DeletePoolDefinitionResponse {
 }
-export interface BulkDeletePoolDefinitionsRequest {
+interface BulkDeletePoolDefinitionsRequest {
     /**
      * List of IDs of the pool definitions to delete.
      * @minSize 1
@@ -509,7 +508,7 @@ export 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?: CascadeWithLiterals;
 }
-export interface BulkDeletePoolDefinitionsResponse {
+interface BulkDeletePoolDefinitionsResponse {
     /**
      * List of deleted pool definitions and associated metadata.
      * @minSize 1
@@ -519,22 +518,22 @@ export interface BulkDeletePoolDefinitionsResponse {
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
-export interface GetPoolDefinitionRequest {
+interface GetPoolDefinitionRequest {
     /**
      * ID of the pool definition to retrieve.
      * @format GUID
      */
     poolDefinitionId: string;
 }
-export interface GetPoolDefinitionResponse {
+interface GetPoolDefinitionResponse {
     /** Retrieved pool definition. */
     poolDefinition?: PoolDefinition;
 }
-export interface QueryPoolDefinitionsRequest {
+interface QueryPoolDefinitionsRequest {
     /** Filter, sort, and paging to apply to the query. */
     query?: CursorQuery;
 }
-export interface CursorQuery extends CursorQueryPagingMethodOneOf {
+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;
     /**
@@ -550,11 +549,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     sort?: Sorting[];
 }
 /** @oneof */
-export interface CursorQueryPagingMethodOneOf {
+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 {
+interface Sorting {
     /**
      * Field to sort by.
      * @maxLength 512
@@ -567,15 +566,15 @@ export interface Sorting {
      */
     order?: SortOrderWithLiterals;
 }
-export declare enum SortOrder {
+declare enum SortOrder {
     /** Ascending sort order. */
     ASC = "ASC",
     /** Descending sort order. */
     DESC = "DESC"
 }
 /** @enumType */
-export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
-export interface CursorPaging {
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
     /**
      * Maximum number of items to return.
      * @max 100
@@ -590,13 +589,13 @@ export interface CursorPaging {
      */
     cursor?: string | null;
 }
-export interface QueryPoolDefinitionsResponse {
+interface QueryPoolDefinitionsResponse {
     /** List of retrieved pool definitions. */
     poolDefinitions?: PoolDefinition[];
     /** Metadata for the paginated results. */
     metadata?: CursorPagingMetadata;
 }
-export interface CursorPagingMetadata {
+interface CursorPagingMetadata {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
@@ -609,7 +608,7 @@ export interface CursorPagingMetadata {
      */
     hasNext?: boolean | null;
 }
-export interface Cursors {
+interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -621,7 +620,7 @@ export interface Cursors {
      */
     prev?: string | null;
 }
-export interface AddPoolDefinitionToProgramDefinitionRequest {
+interface AddPoolDefinitionToProgramDefinitionRequest {
     /**
      * ID of the pool definition to add to the program definition.
      * @format GUID
@@ -635,11 +634,11 @@ export interface AddPoolDefinitionToProgramDefinitionRequest {
     /** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
     cascade: CascadeWithLiterals;
 }
-export interface AddPoolDefinitionToProgramDefinitionResponse {
+interface AddPoolDefinitionToProgramDefinitionResponse {
     /** Updated pool definition. */
     poolDefinition?: PoolDefinition;
 }
-export interface RemovePoolDefinitionFromProgramDefinitionRequest {
+interface RemovePoolDefinitionFromProgramDefinitionRequest {
     /**
      * ID of the pool definition to remove from the program definition.
      * @format GUID
@@ -653,11 +652,11 @@ export interface RemovePoolDefinitionFromProgramDefinitionRequest {
     /** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
     cascade: CascadeWithLiterals;
 }
-export interface RemovePoolDefinitionFromProgramDefinitionResponse {
+interface RemovePoolDefinitionFromProgramDefinitionResponse {
     /** Updated pool definition. */
     poolDefinition?: PoolDefinition;
 }
-export interface FindPoolDefinitionsByProgramDefinitionRequest {
+interface FindPoolDefinitionsByProgramDefinitionRequest {
     /**
      * ID of the program definition to retrieve its pool definitions.
      * @format GUID
@@ -670,11 +669,11 @@ export interface FindPoolDefinitionsByProgramDefinitionRequest {
      */
     namespace: string;
 }
-export interface FindPoolDefinitionsByProgramDefinitionResponse {
+interface FindPoolDefinitionsByProgramDefinitionResponse {
     /** Retrieved pool definitions. */
     poolDefinitions?: PoolDefinition[];
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
+interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -709,19 +708,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-export interface DomainEventBodyOneOf {
+interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-export interface EntityCreatedEvent {
+interface EntityCreatedEvent {
     entity?: string;
 }
-export interface RestoreInfo {
+interface RestoreInfo {
     deletedDate?: Date | null;
 }
-export interface EntityUpdatedEvent {
+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.
@@ -729,14 +728,14 @@ export interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-export interface EntityDeletedEvent {
+interface EntityDeletedEvent {
     /** Entity that was deleted. */
     deletedEntity?: string | null;
 }
-export interface ActionEvent {
+interface ActionEvent {
     body?: string;
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -752,7 +751,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -777,7 +776,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityTypeWithLiterals;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -799,7 +798,7 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
@@ -807,28 +806,8 @@ export declare enum WebhookIdentityType {
     APP = "APP"
 }
 /** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
-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 {
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface CreatePoolDefinitionOptions {
     /**
      * Determines when the changes to the program definitions containing this pool definition will be applied to associated programs.
      *
@@ -836,27 +815,7 @@ export interface CreatePoolDefinitionOptions {
      */
     cascade?: CascadeWithLiterals;
 }
-/**
- * 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 {
+interface BulkCreatePoolDefinitionsOptions {
     /**
      * Determines when the changes to the program definitions containing these pool definitions will be applied to associated programs.
      *
@@ -870,29 +829,7 @@ export interface BulkCreatePoolDefinitionsOptions {
      */
     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
- * @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 {
+interface UpdatePoolDefinition {
     /**
      * Pool definition ID.
      * @format GUID
@@ -946,27 +883,11 @@ export interface UpdatePoolDefinition {
      */
     extendedFields?: ExtendedFields;
 }
-export interface UpdatePoolDefinitionOptions {
+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?: CascadeWithLiterals;
 }
-/**
- * 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 {
+interface BulkUpdatePoolDefinitionsOptions {
     /**
      * Pool definitions to update.
      * @minSize 1
@@ -982,87 +903,14 @@ export interface BulkUpdatePoolDefinitionsOptions {
      */
     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
- * @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 {
+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?: CascadeWithLiterals;
 }
-/**
- * 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 {
+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?: CascadeWithLiterals;
 }
-/**
- * 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;
@@ -1070,13 +918,13 @@ interface QueryCursorResult {
     length: number;
     pageSize: number;
 }
-export interface PoolDefinitionsQueryResult extends QueryCursorResult {
+interface PoolDefinitionsQueryResult extends QueryCursorResult {
     items: PoolDefinition[];
     query: PoolDefinitionsQueryBuilder;
     next: () => Promise<PoolDefinitionsQueryResult>;
     prev: () => Promise<PoolDefinitionsQueryResult>;
 }
-export interface PoolDefinitionsQueryBuilder {
+interface PoolDefinitionsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
@@ -1145,27 +993,7 @@ export interface PoolDefinitionsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<PoolDefinitionsQueryResult>;
 }
-/**
- * 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 {
+interface AddPoolDefinitionToProgramDefinitionOptions {
     /**
      * ID of the program definition to add the pool definition to.
      * @format GUID
@@ -1174,27 +1002,7 @@ export interface AddPoolDefinitionToProgramDefinitionOptions {
     /** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
     cascade: CascadeWithLiterals;
 }
-/**
- * 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 {
+interface RemovePoolDefinitionFromProgramDefinitionOptions {
     /**
      * ID of the program definition to remove the pool definition from.
      * @format GUID
@@ -1203,29 +1011,7 @@ export interface RemovePoolDefinitionFromProgramDefinitionOptions {
     /** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
     cascade: CascadeWithLiterals;
 }
-/**
- * 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 {
+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
@@ -1233,4 +1019,5 @@ export interface FindPoolDefinitionsByProgramDefinitionOptions {
      */
     namespace: string;
 }
-export {};
+
+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 };