@wix/auto_sdk_benefit-programs_pool-definitions 1.0.2 → 1.0.4

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

@@ -24,28 +24,20 @@ export interface PoolDefinition {
      */
     updatedDate?: Date | null;
     /**
-     * Name of the pool definition.
+     * Pool definition name.
      * @maxLength 128
      */
     displayName?: string;
     /**
-     * List of program definitions that are associated with this pool definition.
+     * List of program definition IDs that are associated with this pool definition.
      * @format GUID
      * @maxSize 100
      */
     programDefinitionIds?: string[];
-    /**
-     * Benefit pool information.
-     *
-     * Includes the item, policy, and credit configurations.
-     */
+    /** Pool definition benefits and settings. */
     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 for your app or site's benefit programs.
      * @immutable
      * @minLength 1
      * @maxLength 50
@@ -54,82 +46,55 @@ export interface PoolDefinition {
     /**
      * 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.
+     * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) 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.
+     * Array of benefits.
      * @maxSize 10
      */
     benefits?: Benefit[];
     /**
-     * Settings that control the initial credits and renewal cycle configurations of the benefit pool.
+     * Credit settings.
      *
-     * Default: Benefits may be redeemed without limit.
+     * If this object is empty, you can't set a price for the benefit.
      */
     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. */
+    /** Additional information relating to this object. */
     additionalData?: Record<string, any> | null;
 }
 export interface Benefit {
     /**
-     * An unique identifier for a pool benefit.
+     * Unique identifier for this benefit.
      *
-     * This key is consistent across the pool definition and all its associated benefit pools.
+     * This key is consistent across the pool definition and all associated pools that contain this benefit.
      * @maxLength 64
      */
     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.
+     * ID that is used to associated items with this benefit.
      * @format GUID
      * @immutable
      * @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 of the benefit in credits. The price is the same for all of this benefit's items.
      * @decimalValue options { gte:0, maxScale:4 }
      */
     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. */
+    /** Additional information for this benefit. */
     additionalData?: Record<string, any> | null;
     /**
-     * ID of the app providing the benefit.
+     * ID of the app providing the benefit items.
      * @format GUID
      * @immutable
      */
     providerAppId?: string | null;
     /**
-     * Benefit display name.
+     * Benefit name.
      * @maxLength 40
      */
     displayName?: string | null;
@@ -140,50 +105,46 @@ export interface Benefit {
     description?: string | null;
 }
 export interface PolicyExpression extends PolicyExpressionExpressionOneOf {
-    /** Negates the expression. */
+    /** Benefits can be redeemed if the expression in this object is not fulfilled. */
     operatorNotOptions?: PolicyExpressionNot;
-    /** Combines the expressions with an `AND` operator. */
+    /** Benefits can be redeemed if all the expression in this object's array are fulfilled. */
     operatorAndOptions?: PolicyExpressionAnd;
-    /** Combines the expressions with an `OR` operator. */
+    /** Benefits can be redeemed if at least one of the expressions in this object's array is fulfilled. */
     operatorOrOptions?: PolicyExpressionOr;
-    /** Defines policy terms for benefit redemption. */
+    /** Defines when benefits can be redeemed or how many benefits can be redeemed in a specific time period. */
     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.
-     */
+    /** Policy expression type. */
     type?: PolicyExpressionType;
 }
 /** @oneof */
 export interface PolicyExpressionExpressionOneOf {
-    /** Negates the expression. */
+    /** Benefits can be redeemed if the expression in this object is not fulfilled. */
     operatorNotOptions?: PolicyExpressionNot;
-    /** Combines the expressions with an `AND` operator. */
+    /** Benefits can be redeemed if all the expression in this object's array are fulfilled. */
     operatorAndOptions?: PolicyExpressionAnd;
-    /** Combines the expressions with an `OR` operator. */
+    /** Benefits can be redeemed if at least one of the expressions in this object's array is fulfilled. */
     operatorOrOptions?: PolicyExpressionOr;
-    /** Defines policy terms for benefit redemption. */
+    /** Defines when benefits can be redeemed or how many benefits can be redeemed in a specific time period. */
     policyOptions?: Policy;
 }
 export declare enum PolicyExpressionType {
     UNKNOWN = "UNKNOWN",
-    /** Use with associated `operatorNotOptions`. */
+    /** Use with `operatorNotOptions`. */
     OPERATOR_NOT = "OPERATOR_NOT",
-    /** Use with associated `operatorAndOptions`. */
+    /** Use with `operatorAndOptions`. */
     OPERATOR_AND = "OPERATOR_AND",
-    /** Use with associated `operatorOrOptions`. */
+    /** Use with `operatorOrOptions`. */
     OPERATOR_OR = "OPERATOR_OR",
-    /** Use with associated `policyOptions` to define a policy. */
+    /** Use with `policyOptions`. */
     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. */
+    /** Policy expression. If this expression is not fulfilled, benefits can be redeemed. */
     expression?: PolicyExpression;
 }
 export interface PolicyExpressionAnd {
     /**
-     * Specify policy terms where all policy conditions must be met. Must specify an object with an `expressions` property.
+     * Array of policy expressions. If all expressions are fulfilled, benefits can be redeemed.
      * @minSize 2
      * @maxSize 10
      */
@@ -191,62 +152,71 @@ export interface PolicyExpressionAnd {
 }
 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.
+     * Array of policy expressions. If at least one expression is fulfilled, benefits can be redeemed.
      * @minSize 2
      * @maxSize 10
      */
     expressions?: PolicyExpression[];
 }
 export interface Policy extends PolicyPolicyOneOf {
-    /** Defines the timing of benefit policy redemption for specific days or hours. */
+    /**
+     * Defines an interval during which the policy expression is fulfilled.
+     *
+     * If `fromWeekDay` and `toWeekDay` are defined, this interval applies weekly. Otherwise, it applies daily.
+     */
     fixedIntervalOptions?: FixedIntervalPolicy;
-    /** Sets a limit on the number of times a benefit can be redeemed within a given renewal cycle. */
+    /** Maximum amount of times a benefit can be redeemed during a specified time period. */
     rateLimitedOptions?: RateLimitedPolicy;
-    /** Custom policy definition that is controlled by the CustomPolicyProvider. */
+    /** Custom policy defined by a different app. */
     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. */
+    /** Policy type. */
     type?: Type;
 }
 /** @oneof */
 export interface PolicyPolicyOneOf {
-    /** Defines the timing of benefit policy redemption for specific days or hours. */
+    /**
+     * Defines an interval during which the policy expression is fulfilled.
+     *
+     * If `fromWeekDay` and `toWeekDay` are defined, this interval applies weekly. Otherwise, it applies daily.
+     */
     fixedIntervalOptions?: FixedIntervalPolicy;
-    /** Sets a limit on the number of times a benefit can be redeemed within a given renewal cycle. */
+    /** Maximum amount of times a benefit can be redeemed during a specified time period. */
     rateLimitedOptions?: RateLimitedPolicy;
-    /** Custom policy definition that is controlled by the CustomPolicyProvider. */
+    /** Custom policy defined by a different app. */
     customOptions?: CustomPolicy;
 }
 export declare enum Type {
     /** Unknown policy type. */
     UNKNOWN = "UNKNOWN",
-    /** Fixed interval policy type. */
+    /** Use with `fixedIntervalOptions`. */
     FIXED_INTERVAL = "FIXED_INTERVAL",
-    /** Rate limited policy type. */
+    /** Use with `rateLimitedOptions`. */
     RATE_LIMITED = "RATE_LIMITED",
+    /** Use with `customOptions`. */
     CUSTOM = "CUSTOM"
 }
 export interface FixedIntervalPolicy {
-    /** Weekday that this interval starts from. If this field is set, then `toWeekDay` must also be set. */
+    /** 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 set, then `fromWeekDay` must also be set. */
+    /** Weekday that this interval ends at. If this field is defined, then `fromWeekDay` is required. */
     toWeekDay?: WeekDay;
     /**
-     * Hour that this interval starts from. If this field is set, then `toHour` must also be set.
+     * Hour that this interval starts from. If this field is defined, then `toHour` is required.
      * @max 23
      */
     fromHour?: number | null;
     /**
-     * Hour that this interval ends at. If this field is set, then `fromHour` must also be set.
+     * Hour that this interval ends at. If this field is defined, then `fromHour` is required.
      * @max 23
      */
     toHour?: number | null;
     /**
-     * Minute that this interval starts from. If this field is set, then `toMinute` must also be set.
+     * Minute that this interval starts from. If this field is defined, then `toMinute` is required.
      * @max 59
      */
     fromMinute?: number | null;
     /**
-     * Minute that this interval ends at. If this field is set, then `fromMinute` must also be set.
+     * Minute that this interval ends at. If this field is defined, then `fromMinute` is required.
      * @max 59
      */
     toMinute?: number | null;
@@ -270,70 +240,60 @@ export declare enum WeekDay {
     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.
-     */
+    /** Fixed interval used to limit benefit redemption. */
     fixedIntervalOptions?: FixedIntervalPolicy;
-    /** Maximum number of times benefit can be redeemed per renewal cycle. */
+    /** Maximum number of times a benefit can be redeemed per specified time period. */
     times?: number;
-    /** Specific method of setting the benefit limit. `FIXED_INTERVAL` type must be used with its corresponding `fixIntervalPolicyOptions` parameter. */
+    /** Time period type. */
     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.
-     */
+    /** Fixed interval used to limit benefit redemption. */
     fixedIntervalOptions?: FixedIntervalPolicy;
 }
 export declare enum RateLimitedPolicyType {
     /** Unknown rate limit method. */
     UNKNOWN = "UNKNOWN",
-    /** Fixed interval rate limit. The intervals are set using `fixIntervalPolicyOptions`. */
+    /** Time period is defined using `fixedIntervalOptions`. */
     FIXED_INTERVAL = "FIXED_INTERVAL",
-    /** Rate limit is set with `times` field above. */
+    /** Time period is from one program renewal to the next. */
     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
+     * Policy ID.
      * @format GUID
      */
     id?: string;
     /**
-     * Custom policy provider id
+     * ID of the app providing the policy.
      * @format GUID
      */
     appId?: string | null;
-    /** Additional info for this custom policy. It's going to be passed to the policy provider during eligibility checks */
+    /** Additional information for this custom policy. */
     additionalData?: Record<string, any> | null;
 }
 export interface CreditConfiguration {
     /**
-     * The initial total amount of credits available in this benefit pool.
+     * Initial available amount for associated balances.
      * @decimalValue options { gte:0, maxScale:4 }
      */
     amount?: string;
-    /** Rollover configuration. */
+    /** Rollover settings. */
     rolloverConfiguration?: RolloverConfiguration;
     /**
-     * Display name of the unit.
+     * Credit unit display name.
      * @maxLength 32
      */
     unitDisplayName?: string | null;
 }
 export interface RolloverConfiguration {
-    /** Determine whether unused credits are rolled over to the new cycle. */
+    /** Whether any amount of unused credits are rolled over to a new cycle when a program renews. */
     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.
+     * The maximum amount of credits that can rollover to the next cycle when a program renews.
      * @decimalValue options { gte:0, maxScale:4 }
      */
     balanceCap?: string | null;
@@ -363,23 +323,11 @@ export interface PoolDefinitionAddedToProgramDefinition {
 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.
-     */
+    /** Changes are applied to existing programs and pools when they are next renewed. */
     NEXT_RENEWAL = "NEXT_RENEWAL",
-    /**
-     * Updates the associated benefit pools to reflect the new or modified pool definition immediately.
-     *
-     * Existing programs will be updated immediately.
-     */
+    /** Changes are applied to associated programs and pools 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.
-     */
+    /** Changes are not applied to existing associated programs and pools. They are only applied to future programs and pools. */
     FUTURE_PROVISIONS = "FUTURE_PROVISIONS"
 }
 export interface PoolDefinitionRemovedFromProgramDefinition {
@@ -400,13 +348,18 @@ export interface PoolDefinitionUpdatedProxySupport {
     /** 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 {
+    /** PoolDefinition which was deleted */
+    deletedPoolDefinition?: PoolDefinition;
+}
 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.
+     * Determines when the changes to this pool definition's associated program definitions will be applied to associated programs.
+     *
+     * Required if the `poolDefinition.programDefinitionIds` parameter is defined.
      */
     cascade?: Cascade;
 }
@@ -422,13 +375,13 @@ export interface BulkCreatePoolDefinitionsRequest {
      */
     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.
+     * Determines when the changes to these pool definitions' associated program definitions will be applied to associated programs.
+     *
+     * Required if the `poolDefinition.programDefinitionIds` parameter is defined.
      */
     cascade?: Cascade;
     /**
-     * Whether to return the full pool definition entities.
+     * Whether to return the created pool definitions.
      *
      * Default: `false`
      */
@@ -436,9 +389,7 @@ export interface BulkCreatePoolDefinitionsRequest {
 }
 export interface BulkCreatePoolDefinitionsResponse {
     /**
-     * List of results for each pool definition.
-     *
-     * Includes the pool definition and whether the creation was successful.
+     * List of created pool definitions and associated metadata.
      * @minSize 1
      * @maxSize 100
      */
@@ -484,11 +435,7 @@ export interface BulkActionMetadata {
 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.
-     */
+    /** *Required.** Determines when the changes to this pool definition and its associated program definitions will be applied to associated programs and pools. */
     cascade?: Cascade;
 }
 export interface UpdatePoolDefinitionResponse {
@@ -502,30 +449,24 @@ export interface BulkUpdatePoolDefinitionsRequest {
      * @maxSize 100
      */
     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.
-     */
+    /** *Required.** Determines when the changes to these pool definitions and their associated program definitions will be applied to associated programs and pools. */
     cascade?: Cascade;
     /**
-     * Whether to return the full pool definition entities.
+     * Whether to return the updated pool definitions.
      *
      * Default: `false`
      */
     returnEntity?: boolean;
 }
 export interface MaskedPoolDefinition {
-    /** Pool definition to be updated. */
+    /** Pool definition to update. */
     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.
+     * List of updated pool definitions and associated metadata.
      * @minSize 1
      * @maxSize 100
      */
@@ -539,11 +480,7 @@ export interface DeletePoolDefinitionRequest {
      * @format GUID
      */
     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.
-     */
+    /** *Required**. Determines when the changes to this pool definition and its associated program definitions will be applied to associated programs and pools. */
     cascade?: Cascade;
 }
 export interface DeletePoolDefinitionResponse {
@@ -556,17 +493,12 @@ export interface BulkDeletePoolDefinitionsRequest {
      * @format GUID
      */
     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.
-     */
+    /** *Required**. Determines when the changes to these pool definitions and their associated program definitions will be applied to associated programs and pools. */
     cascade?: Cascade;
 }
 export interface BulkDeletePoolDefinitionsResponse {
     /**
-     * List of results for each pool definition.
-     *
-     * Includes the pool definition and whether the deletion was successful.
+     * List of deleted pool definitions and associated metadata.
      * @minSize 1
      * @maxSize 100
      */
@@ -586,7 +518,7 @@ export interface GetPoolDefinitionResponse {
     poolDefinition?: PoolDefinition;
 }
 export interface QueryPoolDefinitionsRequest {
-    /** Query to select pool definitions. */
+    /** Filter, sort, and paging to apply to the query. */
     query?: CursorQuery;
 }
 export interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -644,7 +576,7 @@ export interface CursorPaging {
     cursor?: string | null;
 }
 export interface QueryPoolDefinitionsResponse {
-    /** List of pool definitions. */
+    /** List of retrieved pool definitions. */
     poolDefinitions?: PoolDefinition[];
     /** Metadata for the paginated results. */
     metadata?: CursorPagingMetadata;
@@ -676,12 +608,12 @@ export interface Cursors {
 }
 export interface AddPoolDefinitionToProgramDefinitionRequest {
     /**
-     * Pool definition to assign to the program definition.
+     * ID of the pool definition to assign to the program definition.
      * @format GUID
      */
     poolDefinitionId: string;
     /**
-     * Program definition that the pool definition is assigned to.
+     * ID of the program definition to assign the pool definition to.
      * @format GUID
      */
     programDefinitionId: string;
@@ -692,24 +624,21 @@ export interface AddPoolDefinitionToProgramDefinitionRequest {
     cascade: Cascade;
 }
 export interface AddPoolDefinitionToProgramDefinitionResponse {
-    /** Pool definition. */
+    /** Updated pool definition. */
     poolDefinition?: PoolDefinition;
 }
 export interface RemovePoolDefinitionFromProgramDefinitionRequest {
     /**
-     * ID of the pool definition to be removed from the program definition.
+     * ID of the pool definition to remove from the program definition.
      * @format GUID
      */
     poolDefinitionId: string;
     /**
-     * ID of the program definition being removed from the pool definition.
+     * ID of the program definition to remove the pool definition from.
      * @format GUID
      */
     programDefinitionId: string;
-    /**
-     * Specifies the timing of updates to associated benefit pools.
-     * Determines how and when changes are applied to existing and future benefit pools.
-     */
+    /** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
     cascade: Cascade;
 }
 export interface RemovePoolDefinitionFromProgramDefinitionResponse {
@@ -718,16 +647,12 @@ export interface RemovePoolDefinitionFromProgramDefinitionResponse {
 }
 export interface FindPoolDefinitionsByProgramDefinitionRequest {
     /**
-     * ID of the program definition of which its assigned pool definitions are retrieved.
+     * ID of the program definition to retrieve its associated pool definitions.
      * @format GUID
      */
     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 for your app or site's benefit programs.
      * @minLength 1
      * @maxLength 50
      */