@wix/auto_sdk_benefit-programs_pools 1.0.28 → 1.0.29

package/build/cjs/meta.d.ts

@@ -154,6 +154,18 @@ interface CommonIdentificationDataIdOneOf {
      */
     wixUserId?: string;
 }
+declare enum IdentityType {
+    /** Unknown type. This value is not used. */
+    UNKNOWN = "UNKNOWN",
+    /** A site visitor who has not logged in. */
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    /** A logged-in site member. */
+    MEMBER = "MEMBER",
+    /** A Wix account holder, such as a site owner or contributor. */
+    WIX_USER = "WIX_USER"
+}
+/** @enumType */
+type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER';
 interface Details {
     /**
      * List of benefits.
@@ -208,6 +220,185 @@ interface Benefit {
      */
     description?: string | null;
 }
+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. */
+    operatorAndOptions?: PolicyExpressionAnd;
+    /** Benefits can be redeemed if at least one of the expressions in this object's array is fulfilled. */
+    operatorOrOptions?: PolicyExpressionOr;
+    /** Defines when benefits can be redeemed or how many benefits can be redeemed in a specific time period. */
+    policyOptions?: Policy;
+    /** Policy expression type. */
+    type?: PolicyExpressionTypeWithLiterals;
+}
+/** @oneof */
+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. */
+    operatorAndOptions?: PolicyExpressionAnd;
+    /** Benefits can be redeemed if at least one of the expressions in this object's array is fulfilled. */
+    operatorOrOptions?: PolicyExpressionOr;
+    /** Defines when benefits can be redeemed or how many benefits can be redeemed in a specific time period. */
+    policyOptions?: Policy;
+}
+declare enum PolicyExpressionType {
+    UNKNOWN = "UNKNOWN",
+    /** Use with `operatorNotOptions`. */
+    OPERATOR_NOT = "OPERATOR_NOT",
+    /** Use with `operatorAndOptions`. */
+    OPERATOR_AND = "OPERATOR_AND",
+    /** Use with `operatorOrOptions`. */
+    OPERATOR_OR = "OPERATOR_OR",
+    /** Use with `policyOptions`. */
+    POLICY = "POLICY"
+}
+/** @enumType */
+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;
+}
+interface PolicyExpressionAnd {
+    /**
+     * Array of policy expressions. If all expressions are fulfilled, benefits can be redeemed.
+     * @minSize 2
+     * @maxSize 10
+     */
+    expressions?: PolicyExpression[];
+}
+interface PolicyExpressionOr {
+    /**
+     * Array of policy expressions. If at least one expression is fulfilled, benefits can be redeemed.
+     * @minSize 2
+     * @maxSize 10
+     */
+    expressions?: PolicyExpression[];
+}
+interface Policy extends PolicyPolicyOneOf {
+    /**
+     * 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;
+    /** Maximum amount of times a benefit can be redeemed during a specified time period. */
+    rateLimitedOptions?: RateLimitedPolicy;
+    /** Custom policy defined by a different app. */
+    customOptions?: CustomPolicy;
+    /** Policy type. */
+    type?: TypeWithLiterals;
+}
+/** @oneof */
+interface PolicyPolicyOneOf {
+    /**
+     * 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;
+    /** Maximum amount of times a benefit can be redeemed during a specified time period. */
+    rateLimitedOptions?: RateLimitedPolicy;
+    /** Custom policy defined by a different app. */
+    customOptions?: CustomPolicy;
+}
+declare enum Type {
+    /** Unknown policy type. */
+    UNKNOWN = "UNKNOWN",
+    /** Use with `fixedIntervalOptions`. */
+    FIXED_INTERVAL = "FIXED_INTERVAL",
+    /** Use with `rateLimitedOptions`. */
+    RATE_LIMITED = "RATE_LIMITED",
+    /** Use with `customOptions`. */
+    CUSTOM = "CUSTOM"
+}
+/** @enumType */
+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. */
+    toWeekDay?: WeekDayWithLiterals;
+    /**
+     * 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 defined, then `fromHour` is required.
+     * @max 23
+     */
+    toHour?: number | null;
+    /**
+     * 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 defined, then `fromMinute` is required.
+     * @max 59
+     */
+    toMinute?: number | null;
+}
+declare enum WeekDay {
+    /** Unknown weekday. */
+    UNKNOWN = "UNKNOWN",
+    /** Monday. */
+    MONDAY = "MONDAY",
+    /** Tuesday. */
+    TUESDAY = "TUESDAY",
+    /** Wednesday. */
+    WEDNESDAY = "WEDNESDAY",
+    /** Thursday. */
+    THURSDAY = "THURSDAY",
+    /** Friday. */
+    FRIDAY = "FRIDAY",
+    /** Saturday. */
+    SATURDAY = "SATURDAY",
+    /** Sunday. */
+    SUNDAY = "SUNDAY"
+}
+/** @enumType */
+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. */
+    times?: number;
+    /** Time period type. */
+    type?: RateLimitedPolicyTypeWithLiterals;
+}
+/** @oneof */
+interface RateLimitedPolicyPeriodOneOf {
+    /** Fixed interval used to limit benefit redemption. */
+    fixedIntervalOptions?: FixedIntervalPolicy;
+}
+declare enum RateLimitedPolicyType {
+    /** Unknown rate limit method. */
+    UNKNOWN = "UNKNOWN",
+    /** Time period is defined using `fixedIntervalOptions`. */
+    FIXED_INTERVAL = "FIXED_INTERVAL",
+    /** Time period is from one program renewal to the next. */
+    PER_CYCLE = "PER_CYCLE"
+}
+/** @enumType */
+type RateLimitedPolicyTypeWithLiterals = RateLimitedPolicyType | 'UNKNOWN' | 'FIXED_INTERVAL' | 'PER_CYCLE';
+/** Custom policy as implemented by the Entitlement Policy Provider */
+interface CustomPolicy {
+    /**
+     * Policy ID.
+     * @format GUID
+     */
+    id?: string;
+    /**
+     * ID of the app providing the policy.
+     * @format GUID
+     */
+    appId?: string | null;
+    /** Additional information for this custom policy. */
+    additionalData?: Record<string, any> | null;
+}
 interface CreditConfiguration {
     /**
      * Initial available amount for associated balances.
@@ -270,6 +461,58 @@ interface PoolProgramInfo {
      */
     externalId?: string | null;
 }
+declare enum PoolOrigin {
+    /** Unknown pool origin. */
+    UNKNOWN = "UNKNOWN",
+    /** Benefit pool created by a program provision. */
+    PROVISION = "PROVISION",
+    /** Benefit pool was created when pool definition was added to program definition. */
+    CASCADE = "CASCADE"
+}
+/** @enumType */
+type PoolOriginWithLiterals = PoolOrigin | 'UNKNOWN' | 'PROVISION' | 'CASCADE';
+interface PoolProvisioned {
+    /** Pool which has been provisioned */
+    pool?: Pool;
+}
+interface PoolRenewed {
+    /** Pool which has been granted */
+    pool?: Pool;
+}
+interface BenefitRedeemed {
+    /** Pool which has been redeemed */
+    pool?: Pool;
+    /** Details of the redemption */
+    redemptionDetails?: RedemptionDetails;
+}
+interface RedemptionDetails {
+    /**
+     * Id of the redemption transaction
+     * @format GUID
+     */
+    transactionId?: string;
+    /** Reference of the item that is being redeemed */
+    itemReference?: ItemReference;
+    /**
+     * Number of of items to redeem
+     * @min 1
+     */
+    itemCount?: number;
+    /**
+     * Date at which the item will be used. Target date does not necessarily equal the redemption date. Credits are redeemed immediately.
+     * This date is only used for validations that may be performed by entitlement providers
+     */
+    targetDate?: Date | null;
+    /**
+     * Idempotency key
+     * @maxLength 200
+     */
+    idempotencyKey?: string;
+    /** Additional info provided during redemption */
+    additionalData?: Record<string, any> | null;
+    /** Beneficiary of the entitlement */
+    beneficiary?: CommonIdentificationData;
+}
 interface ItemReference {
     /**
      * External ID of the item.
@@ -287,6 +530,100 @@ interface ItemReference {
      */
     providerAppId?: string;
 }
+interface PoolPaused {
+    /** Pool which has been paused */
+    pool?: Pool;
+}
+interface PoolResumed {
+    /** Pool which has been resumed */
+    pool?: Pool;
+}
+interface PoolEnded {
+    /** Pool which has been ended */
+    pool?: Pool;
+}
+interface BenefitReserved {
+    /** Pool which was used to perform this transaction */
+    pool?: Pool;
+    /** Details of the redemption */
+    redemptionDetails?: RedemptionDetails;
+}
+interface BenefitReservationCanceled {
+    /** Pool which was used to perform this transaction */
+    pool?: Pool;
+    /**
+     * Id of the canceled reservation transaction
+     * @format GUID
+     */
+    transactionId?: string;
+}
+interface BenefitReservationReleased {
+    /** Pool which was used to perform this transaction */
+    pool?: Pool;
+    /**
+     * Id of the released reservation transaction
+     * @format GUID
+     */
+    transactionId?: string;
+}
+interface PoolProvisionJobFinished {
+    /**
+     * Program id
+     * @format GUID
+     */
+    programId?: string;
+    /** Processed item count */
+    processedItemCount?: number;
+    /** Origin of the pool */
+    origin?: PoolOriginWithLiterals;
+}
+interface PoolStatusUpdateJobFinished extends PoolStatusUpdateJobFinishedContextOneOf {
+    /** The id of the pool definition that is being updated */
+    poolDefinitionAndProgramDefinition?: PoolDefinitionAndProgramDefinition;
+    /** Update the status of all pools in the program */
+    programInfo?: ProgramInfo;
+    /** Target status of the pool */
+    targetStatus?: PoolStatusWithLiterals;
+    /** The total number of items that were processed */
+    processedItemCount?: number;
+}
+/** @oneof */
+interface PoolStatusUpdateJobFinishedContextOneOf {
+    /** The id of the pool definition that is being updated */
+    poolDefinitionAndProgramDefinition?: PoolDefinitionAndProgramDefinition;
+    /** Update the status of all pools in the program */
+    programInfo?: ProgramInfo;
+}
+interface PoolDefinitionAndProgramDefinition {
+    /**
+     * The id of the pool definition that is being updated
+     * @format GUID
+     * @readonly
+     */
+    poolDefinitionId?: string;
+    /**
+     * The key of the program that is being updated
+     * @format GUID
+     */
+    programDefinitionId?: string | null;
+}
+interface ProgramInfo {
+    /**
+     * The key of the program that is being updated
+     * @format GUID
+     */
+    programId?: string;
+    /** Additional data that was provided when the job was submitted */
+    additionalData?: Record<string, any> | null;
+}
+interface CreatePoolRequest {
+    /** Pool to be created. */
+    pool?: Pool;
+}
+interface CreatePoolResponse {
+    /** Created pool. */
+    pool?: Pool;
+}
 interface GetPoolRequest {
     /**
      * ID of the pool to retrieve.
@@ -306,6 +643,15 @@ interface UpdatePoolResponse {
     /** Updated pool. */
     pool?: Pool;
 }
+interface DeletePoolRequest {
+    /**
+     * ID of the pool to delete.
+     * @format GUID
+     */
+    poolId?: string;
+}
+interface DeletePoolResponse {
+}
 interface QueryPoolsRequest {
     /** Filter, sort, and paging to apply to the query. */
     query: CursorQuery;
@@ -464,6 +810,45 @@ interface NotEnoughBalance {
      */
     requestedBalance?: string;
 }
+interface PolicyExpressionEvaluatedToFalse {
+    /**
+     * Pool ID.
+     * @format GUID
+     */
+    poolId?: string;
+    /** Item reference. */
+    itemReference?: ItemReference;
+    /**
+     * Failure details.
+     * @maxSize 10
+     */
+    failureDetails?: FailureDetails[];
+}
+interface FailureDetails {
+    /**
+     * Failure code
+     * @minLength 1
+     * @maxLength 64
+     */
+    code?: string;
+    /**
+     * Failure message
+     * @maxLength 256
+     */
+    message?: string | null;
+    /**
+     * Policy id
+     * @format GUID
+     */
+    policyId?: string | null;
+    /**
+     * App that owns the policy
+     * @format GUID
+     */
+    appId?: string | null;
+    /** Information provided by the policy */
+    errorData?: Record<string, any> | null;
+}
 interface PoolNotActive {
     /**
      * Pool ID.
@@ -480,6 +865,18 @@ interface PoolNotFound {
      */
     poolId?: string;
 }
+interface BenefitAlreadyRedeemed {
+    /**
+     * Pool ID
+     * @format GUID
+     */
+    poolId?: string;
+    /**
+     * Idempotency key of the request that failed
+     * @maxLength 200
+     */
+    idempotencyKey?: string;
+}
 interface BenefitNotFound {
     /**
      * Pool ID.
@@ -492,6 +889,91 @@ interface BenefitNotFound {
      */
     benefitKey?: string | null;
 }
+interface ReserveBenefitRequest {
+    /**
+     * Id of the pool that is being redeemed from
+     * @format GUID
+     */
+    poolId?: string;
+    /** Reference of the item that is being redeemed. */
+    itemReference?: ItemReference;
+    /**
+     * Key of the benefit to be redeemed, associated with a particular benefit.
+     *
+     * This key must be specified to ensure the correct benefit is redeemed.
+     *
+     * Default: The first eligible benefit in the benefit pool will be redeemed.
+     * @maxLength 64
+     */
+    benefitKey?: string | null;
+    /**
+     * Number of items to redeem.
+     * @min 1
+     */
+    count?: number;
+    /**
+     * Date when the benefit item will be used.
+     *
+     * While the credit balance is adjusted immediately upon the redemption request, the target date may be set for a later time than the date of the request.
+     *
+     * Used for the app providing the benefit items to manage the logistics associated with the item.
+     */
+    targetDate?: Date | null;
+    /**
+     * Idempotency key
+     * @maxLength 200
+     */
+    idempotencyKey?: string;
+    /** Additional info */
+    additionalData?: Record<string, any> | null;
+    /** Benefit pool owner. */
+    beneficiary?: CommonIdentificationData;
+    /**
+     * Module that is the source of the benefit pool creation.
+     *
+     * This value must correspond with the previously defined namespace established when creating the associated pool definition.
+     *
+     * It ensures efficient processing and management of pools and benefits.
+     * @minLength 1
+     * @maxLength 20
+     */
+    namespace?: string;
+}
+interface ReserveBenefitResponse {
+    /**
+     * Id of the transaction that was created as a result of this request
+     * @format GUID
+     */
+    transactionId?: string;
+}
+interface CancelBenefitReservationRequest {
+    /**
+     * Id of the transaction that was created as a result of this request
+     * @format GUID
+     */
+    transactionId?: string;
+}
+interface CancelBenefitReservationResponse {
+    /**
+     * Id of the transaction that was created as a result of this request
+     * @format GUID
+     */
+    transactionId?: string;
+}
+interface ReleaseBenefitReservationRequest {
+    /**
+     * Id of the transaction that was created as a result of this request
+     * @format GUID
+     */
+    transactionId?: string;
+}
+interface ReleaseBenefitReservationResponse {
+    /**
+     * Id of the transaction that was created as a result of this request
+     * @format GUID
+     */
+    transactionId?: string;
+}
 interface CheckBenefitEligibilityRequest {
     /**
      * ID of the pool that the benefit to check belongs to.
@@ -691,6 +1173,75 @@ interface GetEligibleBenefitsResponse {
     /** Retrieved benefits that can be redeemed. */
     eligibleBenefits?: EligibleBenefit[];
 }
+interface ListPoolsRequest {
+    /** The filter */
+    filter?: Filter;
+    /** Cursor paging */
+    cursorPaging?: CursorPaging;
+}
+declare enum ListPoolsRequestType {
+    UNKNOWN_FILTER = "UNKNOWN_FILTER",
+    BY_ITEM_REFERENCE = "BY_ITEM_REFERENCE"
+}
+/** @enumType */
+type ListPoolsRequestTypeWithLiterals = ListPoolsRequestType | 'UNKNOWN_FILTER' | 'BY_ITEM_REFERENCE';
+interface ByItemReference {
+    /**
+     * A list of filters
+     * @maxSize 100
+     */
+    filters?: ByItemReferenceFilter[];
+    /** Beneficiary of the pool */
+    beneficiary?: CommonIdentificationData;
+    /**
+     * Returns pools that are in the following statuses
+     * @maxSize 10
+     */
+    poolStatuses?: PoolStatusWithLiterals[];
+}
+interface ByItemReferenceFilter {
+    /** Reference of the item */
+    itemReference?: ItemReference;
+}
+interface Filter extends FilterFilterOneOf {
+    /** A list of filters by reference */
+    byItemReferenceOptions?: ByItemReference;
+    /** Type of the filter */
+    type?: ListPoolsRequestTypeWithLiterals;
+    /**
+     * Module that is the source of the benefit pool creation.
+     *
+     * This value must correspond with the previously defined namespace established when creating the associated pool definition.
+     *
+     * It ensures efficient processing and management of pools and benefits.
+     * @minLength 1
+     * @maxLength 20
+     */
+    namespace?: string;
+}
+/** @oneof */
+interface FilterFilterOneOf {
+    /** A list of filters by reference */
+    byItemReferenceOptions?: ByItemReference;
+}
+interface ListPoolsResponse {
+    /**
+     * The retrieved pools
+     * @maxSize 100
+     */
+    pools?: PoolWithItems[];
+    /** Paging information */
+    metadata?: CursorPagingMetadata;
+}
+interface PoolWithItems {
+    /** The pool */
+    pool?: Pool;
+    /**
+     * The items in the pool
+     * @maxSize 100
+     */
+    itemReference?: ItemReference[];
+}
 interface BulkUpdatePoolsRequest {
     /**
      * Pools to update.
@@ -756,6 +1307,330 @@ interface BulkActionMetadata {
     /** Number of failures without details because detailed failure threshold was exceeded. */
     undetailedFailures?: number;
 }
+interface ProvisionPoolsForProgramRequest {
+    /** Reference of the template that is used to provision the pools */
+    poolDefinitionLookupId?: PoolDefinitionLookupId;
+    /**
+     * Program that the provisioned pools are part of
+     * @format GUID
+     */
+    programId?: string;
+}
+interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
+    /**
+     * Pool definition ID.
+     * @format GUID
+     */
+    poolDefinitionId?: string;
+    /**
+     * Program definition ID.
+     * @format GUID
+     */
+    programDefinitionId?: string;
+}
+/** @oneof */
+interface PoolDefinitionLookupIdIdOneOf {
+    /**
+     * Pool definition ID.
+     * @format GUID
+     */
+    poolDefinitionId?: string;
+    /**
+     * Program definition ID.
+     * @format GUID
+     */
+    programDefinitionId?: string;
+}
+interface ProvisionPoolsForProgramResponse extends ProvisionPoolsForProgramResponseResultOneOf {
+    /** Sync result */
+    syncOptions?: SyncResult;
+    /** Async result */
+    asyncOptions?: AsyncResult;
+    /**
+     * Job ID of the program provision associated with this pool. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
+     * @format GUID
+     */
+    jobId?: string;
+    /** Type of the result */
+    type?: ProvisionPoolsForProgramResponseTypeWithLiterals;
+}
+/** @oneof */
+interface ProvisionPoolsForProgramResponseResultOneOf {
+    /** Sync result */
+    syncOptions?: SyncResult;
+    /** Async result */
+    asyncOptions?: AsyncResult;
+}
+declare enum ProvisionPoolsForProgramResponseType {
+    /** Unknown result type */
+    UNKNOWN = "UNKNOWN",
+    /** Sync result */
+    SYNC = "SYNC",
+    /** Async result */
+    ASYNC = "ASYNC"
+}
+/** @enumType */
+type ProvisionPoolsForProgramResponseTypeWithLiterals = ProvisionPoolsForProgramResponseType | 'UNKNOWN' | 'SYNC' | 'ASYNC';
+interface SyncResult {
+    /** Indicates if the operation was successful */
+    success?: boolean;
+}
+interface AsyncResult {
+    /**
+     * Job ID of the program provision associated with this pool. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
+     * @format GUID
+     */
+    jobId?: string;
+}
+interface InvalidPoolDefinitionReference {
+    /** Reference of the template that didn't find any pool definitions */
+    poolDefinitionLookupId?: PoolDefinitionLookupId;
+}
+interface RenewPoolsForProgramRequest {
+    /**
+     * Package of pools to grant. Package id should be the same that was used to provision programs.
+     * @format GUID
+     */
+    programId?: string;
+}
+interface RenewPoolsForProgramResponse {
+    /**
+     * Job id of the renewal job
+     * @format GUID
+     */
+    jobId?: string;
+}
+interface UpdatePoolStatusRequest extends UpdatePoolStatusRequestPoolSelectorOneOf {
+    /** Pool selector by pool definition id and program definition id */
+    byPoolDefinitionIdAndProgramDefinitionIdOptions?: ByPoolDefinitionIdAndProgramDefinitionIdOptions;
+    /** Pool selector by program id */
+    byProgramIdOptions?: ByProgramIdOptions;
+    /** New pool status */
+    status?: PoolStatusWithLiterals;
+    /** Pool selector type */
+    poolSelectorType?: PoolSelectorTypeWithLiterals;
+}
+/** @oneof */
+interface UpdatePoolStatusRequestPoolSelectorOneOf {
+    /** Pool selector by pool definition id and program definition id */
+    byPoolDefinitionIdAndProgramDefinitionIdOptions?: ByPoolDefinitionIdAndProgramDefinitionIdOptions;
+    /** Pool selector by program id */
+    byProgramIdOptions?: ByProgramIdOptions;
+}
+declare enum PoolSelectorType {
+    UNKNOWN_SELECTOR = "UNKNOWN_SELECTOR",
+    BY_POOL_DEFINITION_ID_AND_PROGRAM_DEFINITION_ID = "BY_POOL_DEFINITION_ID_AND_PROGRAM_DEFINITION_ID",
+    BY_PROGRAM_ID = "BY_PROGRAM_ID"
+}
+/** @enumType */
+type PoolSelectorTypeWithLiterals = PoolSelectorType | 'UNKNOWN_SELECTOR' | 'BY_POOL_DEFINITION_ID_AND_PROGRAM_DEFINITION_ID' | 'BY_PROGRAM_ID';
+interface ByPoolDefinitionIdAndProgramDefinitionIdOptions {
+    /**
+     * Pool definition id
+     * @format GUID
+     */
+    poolDefinitionId?: string;
+    /**
+     * Program definition id
+     * @format GUID
+     */
+    programDefinitionId?: string | null;
+}
+interface ByProgramIdOptions {
+    /**
+     * Program id
+     * @format GUID
+     */
+    programId?: string;
+    /** Additional data that gets added to the event once the async job completes */
+    additionalData?: Record<string, any> | null;
+}
+interface UpdatePoolStatusResponse {
+    /**
+     * Job ID of the program provision associated with this pool. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
+     * @format GUID
+     */
+    jobId?: string;
+}
+interface CountNumberOfPoolsInProvisioningStatusRequest {
+    /**
+     * Program id
+     * @format GUID
+     */
+    programId?: string;
+}
+interface CountNumberOfPoolsInProvisioningStatusResponse {
+    /** Number of pools in provisioning status */
+    count?: number;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntityAsJson?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntityAsJson?: string | null;
+}
+interface ActionEvent {
+    bodyAsJson?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+/** @docsIgnore */
+type RedeemBenefitApplicationErrors = {
+    code?: 'NOT_ENOUGH_BALANCE';
+    description?: string;
+    data?: NotEnoughBalance;
+} | {
+    code?: 'POLICY_EXPRESSION_EVALUATED_TO_FALSE';
+    description?: string;
+    data?: PolicyExpressionEvaluatedToFalse;
+} | {
+    code?: 'POOL_NOT_ACTIVE';
+    description?: string;
+    data?: PoolNotActive;
+} | {
+    code?: 'POOL_NOT_FOUND';
+    description?: string;
+    data?: PoolNotFound;
+} | {
+    code?: 'BENEFIT_ALREADY_REDEEMED';
+    description?: string;
+    data?: BenefitAlreadyRedeemed;
+} | {
+    code?: 'BENEFIT_NOT_FOUND';
+    description?: string;
+    data?: BenefitNotFound;
+};
+/** @docsIgnore */
+type GetEligibleBenefitsApplicationErrors = {
+    code?: 'INVALID_ITEM_REFERENCE';
+    description?: string;
+    data?: Record<string, any>;
+};
 
 type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
     getUrl: (context: any) => string;
@@ -780,4 +1655,4 @@ declare function bulkCheckBenefitEligibility(): __PublicMethodMetaInfo<'POST', {
 declare function getEligibleBenefits(): __PublicMethodMetaInfo<'POST', {}, GetEligibleBenefitsRequest$1, GetEligibleBenefitsRequest, GetEligibleBenefitsResponse$1, GetEligibleBenefitsResponse>;
 declare function bulkUpdatePools(): __PublicMethodMetaInfo<'POST', {}, BulkUpdatePoolsRequest$1, BulkUpdatePoolsRequest, BulkUpdatePoolsResponse$1, BulkUpdatePoolsResponse>;
 
-export { type __PublicMethodMetaInfo, bulkCheckBenefitEligibility, bulkUpdatePools, checkBenefitEligibility, getEligibleBenefits, getPool, queryPools, redeemBenefit, updatePool };
+export { type ActionEvent as ActionEventOriginal, type ApplicationError as ApplicationErrorOriginal, type AsyncResult as AsyncResultOriginal, type BenefitAlreadyRedeemed as BenefitAlreadyRedeemedOriginal, type BenefitNotFound as BenefitNotFoundOriginal, type Benefit as BenefitOriginal, type BenefitRedeemed as BenefitRedeemedOriginal, type BenefitReservationCanceled as BenefitReservationCanceledOriginal, type BenefitReservationReleased as BenefitReservationReleasedOriginal, type BenefitReserved as BenefitReservedOriginal, type BenefitSelector as BenefitSelectorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCheckBenefitEligibilityRequest as BulkCheckBenefitEligibilityRequestOriginal, type BulkCheckBenefitEligibilityResponse as BulkCheckBenefitEligibilityResponseOriginal, type BulkEligibilityCheckResult as BulkEligibilityCheckResultOriginal, type BulkPoolResult as BulkPoolResultOriginal, type BulkUpdatePoolsRequest as BulkUpdatePoolsRequestOriginal, type BulkUpdatePoolsResponse as BulkUpdatePoolsResponseOriginal, type ByItemReferenceFilter as ByItemReferenceFilterOriginal, type ByItemReference as ByItemReferenceOriginal, type ByPoolDefinitionIdAndProgramDefinitionIdOptions as ByPoolDefinitionIdAndProgramDefinitionIdOptionsOriginal, type ByProgramIdOptions as ByProgramIdOptionsOriginal, type CancelBenefitReservationRequest as CancelBenefitReservationRequestOriginal, type CancelBenefitReservationResponse as CancelBenefitReservationResponseOriginal, type CheckBenefitEligibilityRequest as CheckBenefitEligibilityRequestOriginal, type CheckBenefitEligibilityResponse as CheckBenefitEligibilityResponseOriginal, type CommonIdentificationDataIdOneOf as CommonIdentificationDataIdOneOfOriginal, type CommonIdentificationData as CommonIdentificationDataOriginal, type CountNumberOfPoolsInProvisioningStatusRequest as CountNumberOfPoolsInProvisioningStatusRequestOriginal, type CountNumberOfPoolsInProvisioningStatusResponse as CountNumberOfPoolsInProvisioningStatusResponseOriginal, type CreatePoolRequest as CreatePoolRequestOriginal, type CreatePoolResponse as CreatePoolResponseOriginal, type CreditConfiguration as CreditConfigurationOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomPolicy as CustomPolicyOriginal, type DeletePoolRequest as DeletePoolRequestOriginal, type DeletePoolResponse as DeletePoolResponseOriginal, type Details as DetailsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EligibilityCheckResult as EligibilityCheckResultOriginal, type EligibilityCheckResultResultOneOf as EligibilityCheckResultResultOneOfOriginal, EligibilityCheckResultType as EligibilityCheckResultTypeOriginal, type EligibilityCheckResultTypeWithLiterals as EligibilityCheckResultTypeWithLiteralsOriginal, type EligibleBenefit as EligibleBenefitOriginal, type Eligible as EligibleOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type FailureDetails as FailureDetailsOriginal, type FilterFilterOneOf as FilterFilterOneOfOriginal, type Filter as FilterOriginal, type FixedIntervalPolicy as FixedIntervalPolicyOriginal, type GetEligibleBenefitsApplicationErrors as GetEligibleBenefitsApplicationErrorsOriginal, type GetEligibleBenefitsRequest as GetEligibleBenefitsRequestOriginal, type GetEligibleBenefitsResponse as GetEligibleBenefitsResponseOriginal, type GetPoolRequest as GetPoolRequestOriginal, type GetPoolResponse as GetPoolResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, IdentityType as IdentityTypeOriginal, type IdentityTypeWithLiterals as IdentityTypeWithLiteralsOriginal, type InvalidPoolDefinitionReference as InvalidPoolDefinitionReferenceOriginal, type ItemMetadata as ItemMetadataOriginal, type ItemReference as ItemReferenceOriginal, type ListPoolsRequest as ListPoolsRequestOriginal, ListPoolsRequestType as ListPoolsRequestTypeOriginal, type ListPoolsRequestTypeWithLiterals as ListPoolsRequestTypeWithLiteralsOriginal, type ListPoolsResponse as ListPoolsResponseOriginal, type MaskedPool as MaskedPoolOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type NotEnoughBalance as NotEnoughBalanceOriginal, type PolicyExpressionAnd as PolicyExpressionAndOriginal, type PolicyExpressionEvaluatedToFalse as PolicyExpressionEvaluatedToFalseOriginal, type PolicyExpressionExpressionOneOf as PolicyExpressionExpressionOneOfOriginal, type PolicyExpressionNot as PolicyExpressionNotOriginal, type PolicyExpressionOr as PolicyExpressionOrOriginal, type PolicyExpression as PolicyExpressionOriginal, PolicyExpressionType as PolicyExpressionTypeOriginal, type PolicyExpressionTypeWithLiterals as PolicyExpressionTypeWithLiteralsOriginal, type Policy as PolicyOriginal, type PolicyPolicyOneOf as PolicyPolicyOneOfOriginal, type PoolDefinitionAndProgramDefinition as PoolDefinitionAndProgramDefinitionOriginal, type PoolDefinitionLookupIdIdOneOf as PoolDefinitionLookupIdIdOneOfOriginal, type PoolDefinitionLookupId as PoolDefinitionLookupIdOriginal, type PoolEnded as PoolEndedOriginal, type PoolNotActive as PoolNotActiveOriginal, type PoolNotFound as PoolNotFoundOriginal, PoolOrigin as PoolOriginOriginal, type PoolOriginWithLiterals as PoolOriginWithLiteralsOriginal, type Pool as PoolOriginal, type PoolPaused as PoolPausedOriginal, type PoolProgramInfo as PoolProgramInfoOriginal, type PoolProvisionJobFinished as PoolProvisionJobFinishedOriginal, type PoolProvisioned as PoolProvisionedOriginal, type PoolRenewed as PoolRenewedOriginal, type PoolResumed as PoolResumedOriginal, PoolSelectorType as PoolSelectorTypeOriginal, type PoolSelectorTypeWithLiterals as PoolSelectorTypeWithLiteralsOriginal, PoolStatus as PoolStatusOriginal, type PoolStatusUpdateJobFinishedContextOneOf as PoolStatusUpdateJobFinishedContextOneOfOriginal, type PoolStatusUpdateJobFinished as PoolStatusUpdateJobFinishedOriginal, type PoolStatusWithLiterals as PoolStatusWithLiteralsOriginal, type PoolWithItems as PoolWithItemsOriginal, type ProgramDefinitionInfo as ProgramDefinitionInfoOriginal, type ProgramInfo as ProgramInfoOriginal, type ProvisionPoolsForProgramRequest as ProvisionPoolsForProgramRequestOriginal, type ProvisionPoolsForProgramResponse as ProvisionPoolsForProgramResponseOriginal, type ProvisionPoolsForProgramResponseResultOneOf as ProvisionPoolsForProgramResponseResultOneOfOriginal, ProvisionPoolsForProgramResponseType as ProvisionPoolsForProgramResponseTypeOriginal, type ProvisionPoolsForProgramResponseTypeWithLiterals as ProvisionPoolsForProgramResponseTypeWithLiteralsOriginal, type QueryPoolsRequest as QueryPoolsRequestOriginal, type QueryPoolsResponse as QueryPoolsResponseOriginal, type RateLimitedPolicy as RateLimitedPolicyOriginal, type RateLimitedPolicyPeriodOneOf as RateLimitedPolicyPeriodOneOfOriginal, RateLimitedPolicyType as RateLimitedPolicyTypeOriginal, type RateLimitedPolicyTypeWithLiterals as RateLimitedPolicyTypeWithLiteralsOriginal, type RedeemBenefitApplicationErrors as RedeemBenefitApplicationErrorsOriginal, type RedeemBenefitRequest as RedeemBenefitRequestOriginal, type RedeemBenefitResponse as RedeemBenefitResponseOriginal, type RedemptionDetails as RedemptionDetailsOriginal, type ReleaseBenefitReservationRequest as ReleaseBenefitReservationRequestOriginal, type ReleaseBenefitReservationResponse as ReleaseBenefitReservationResponseOriginal, type RenewPoolsForProgramRequest as RenewPoolsForProgramRequestOriginal, type RenewPoolsForProgramResponse as RenewPoolsForProgramResponseOriginal, type ReserveBenefitRequest as ReserveBenefitRequestOriginal, type ReserveBenefitResponse as ReserveBenefitResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type RolloverConfiguration as RolloverConfigurationOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type SyncResult as SyncResultOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, type UpdatePoolRequest as UpdatePoolRequestOriginal, type UpdatePoolResponse as UpdatePoolResponseOriginal, type UpdatePoolStatusRequest as UpdatePoolStatusRequestOriginal, type UpdatePoolStatusRequestPoolSelectorOneOf as UpdatePoolStatusRequestPoolSelectorOneOfOriginal, type UpdatePoolStatusResponse as UpdatePoolStatusResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeekDay as WeekDayOriginal, type WeekDayWithLiterals as WeekDayWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkCheckBenefitEligibility, bulkUpdatePools, checkBenefitEligibility, getEligibleBenefits, getPool, queryPools, redeemBenefit, updatePool };