@wix/auto_sdk_benefit-programs_pools 1.0.15 → 1.0.17

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

@@ -0,0 +1,1579 @@
+export interface Pool {
+    /**
+     * Pool ID.
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the pool is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the pool.
+     *
+     * Ignored when creating a pool.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the pool was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the pool was updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * ID of the associated pool definition.
+     * @format GUID
+     * @readonly
+     * @immutable
+     */
+    poolDefinitionId?: string | null;
+    /**
+     * ID of the associated program definition.
+     * @format GUID
+     * @readonly
+     * @immutable
+     */
+    programDefinitionId?: string | null;
+    /**
+     * ID of the program that contains this pool.
+     * @format GUID
+     * @readonly
+     * @immutable
+     */
+    programId?: string | null;
+    /**
+     * Pool status.
+     * @readonly
+     */
+    status?: PoolStatus;
+    /**
+     * Pool beneficiary.
+     * @readonly
+     * @immutable
+     */
+    beneficiary?: CommonIdentificationData;
+    /** Pool benefits and settings. */
+    details?: Details;
+    /**
+     * Pool name.
+     *
+     * You may want to use the same name that's used in the associated pool definition.
+     * @maxLength 64
+     */
+    displayName?: string;
+    /**
+     * 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.
+     * @readonly
+     * @immutable
+     * @minLength 1
+     * @maxLength 50
+     */
+    namespace?: string | null;
+    /**
+     * Custom field data for the pool object.
+     *
+     * [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;
+    /**
+     * Associated program definition information.
+     * @readonly
+     */
+    programDefinition?: ProgramDefinitionInfo;
+    /**
+     * Information about the program containing the pool.
+     * @readonly
+     */
+    program?: PoolProgramInfo;
+    /**
+     * Version of the pool definition that this pool was created from.
+     * @readonly
+     */
+    poolDefinitionRevision?: string | null;
+    /**
+     * Number of times this pool has been renewed.
+     * @readonly
+     */
+    renewalCount?: number | null;
+}
+export declare enum PoolStatus {
+    /** Undefined pool status. */
+    UNDEFINED = "UNDEFINED",
+    /** Pool is active. */
+    ACTIVE = "ACTIVE",
+    /** Pool is paused. It can be resumed. */
+    PAUSED = "PAUSED",
+    /** Pool is ended. It can't be resumed. */
+    ENDED = "ENDED",
+    /** Pool provisioning is in progress. This status exists for a short time during processing. */
+    PROVISIONING = "PROVISIONING",
+    /** Pool renewing is in progress. This status exists for a short time during processing. */
+    RENEWING = "RENEWING"
+}
+export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that hasn't logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site member.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user.
+     * @format GUID
+     */
+    wixUserId?: string;
+}
+/** @oneof */
+export interface CommonIdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that hasn't logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site member.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user.
+     * @format GUID
+     */
+    wixUserId?: string;
+}
+export 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"
+}
+export interface Details {
+    /**
+     * List of benefits.
+     * @maxSize 10
+     */
+    benefits?: Benefit[];
+    /**
+     * Credit settings.
+     *
+     * If this object is empty, you can't set a price for the benefit.
+     */
+    creditConfiguration?: CreditConfiguration;
+    /** Additional information relating to this object. */
+    additionalData?: Record<string, any> | null;
+}
+export interface Benefit {
+    /**
+     * Unique identifier for this benefit.
+     *
+     * This key is consistent across the pool definition and all associated pools that contain this benefit.
+     * @maxLength 64
+     */
+    benefitKey?: string;
+    /**
+     * ID that is used to associated items with this benefit.
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    itemSetId?: string | null;
+    /**
+     * 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;
+    /** Additional information for this benefit. */
+    additionalData?: Record<string, any> | null;
+    /**
+     * ID of the app providing the benefit items.
+     * @format GUID
+     * @immutable
+     */
+    providerAppId?: string | null;
+    /**
+     * Benefit name.
+     * @maxLength 40
+     */
+    displayName?: string | null;
+    /**
+     * Benefit description.
+     * @maxLength 255
+     */
+    description?: string | null;
+}
+export interface PolicyExpression extends PolicyExpressionExpressionOneOf {
+    /** Benefits can be redeemed if the expression in this object is not fulfilled. */
+    operatorNotOptions?: PolicyExpressionNot;
+    /** Benefits can be redeemed if all the expression in this object's array are fulfilled. */
+    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?: PolicyExpressionType;
+}
+/** @oneof */
+export interface PolicyExpressionExpressionOneOf {
+    /** Benefits can be redeemed if the expression in this object is not fulfilled. */
+    operatorNotOptions?: PolicyExpressionNot;
+    /** Benefits can be redeemed if all the expression in this object's array are fulfilled. */
+    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;
+}
+export 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"
+}
+export interface PolicyExpressionNot {
+    /** Policy expression. If this expression is not fulfilled, benefits can be redeemed. */
+    expression?: PolicyExpression;
+}
+export interface PolicyExpressionAnd {
+    /**
+     * Array of policy expressions. If all expressions are fulfilled, benefits can be redeemed.
+     * @minSize 2
+     * @maxSize 10
+     */
+    expressions?: PolicyExpression[];
+}
+export interface PolicyExpressionOr {
+    /**
+     * 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 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?: Type;
+}
+/** @oneof */
+export 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;
+}
+export 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"
+}
+export interface FixedIntervalPolicy {
+    /** Weekday that this interval starts from. If this field is defined, then `toWeekDay` is required. */
+    fromWeekDay?: WeekDay;
+    /** Weekday that this interval ends at. If this field is defined, then `fromWeekDay` is required. */
+    toWeekDay?: WeekDay;
+    /**
+     * 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;
+}
+export declare enum WeekDay {
+    /** Unknown weekday. */
+    UNKNOWN = "UNKNOWN",
+    /** Monday. */
+    MONDAY = "MONDAY",
+    /** Tuesday. */
+    TUESDAY = "TUESDAY",
+    /** Wednesday. */
+    WEDNESDAY = "WEDNESDAY",
+    /** Thursday. */
+    THURSDAY = "THURSDAY",
+    /** Friday. */
+    FRIDAY = "FRIDAY",
+    /** Saturday. */
+    SATURDAY = "SATURDAY",
+    /** Sunday. */
+    SUNDAY = "SUNDAY"
+}
+export interface RateLimitedPolicy extends RateLimitedPolicyPeriodOneOf {
+    /** 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?: RateLimitedPolicyType;
+}
+/** @oneof */
+export interface RateLimitedPolicyPeriodOneOf {
+    /** Fixed interval used to limit benefit redemption. */
+    fixedIntervalOptions?: FixedIntervalPolicy;
+}
+export 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"
+}
+/** Custom policy as implemented by the Entitlement Policy Provider */
+export 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;
+}
+export interface CreditConfiguration {
+    /**
+     * Initial available amount for associated balances.
+     * @decimalValue options { gte:0, maxScale:4 }
+     */
+    amount?: string;
+    /** Rollover settings. */
+    rolloverConfiguration?: RolloverConfiguration;
+    /**
+     * Credit unit display name.
+     * @maxLength 32
+     */
+    unitDisplayName?: string | null;
+}
+export interface RolloverConfiguration {
+    /** Whether unused credits roll over to a new cycle when a program renews. */
+    enabled?: boolean | null;
+    /**
+     * Maximum number of credits that can roll over to the next cycle when a program renews.
+     * @decimalValue options { gte:0, maxScale:4 }
+     */
+    balanceCap?: string | null;
+}
+export interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+export interface ProgramDefinitionInfo {
+    /**
+     * Program definition ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string;
+    /**
+     * Program definition external ID.
+     * @format GUID
+     * @readonly
+     */
+    externalId?: string | null;
+}
+export interface PoolProgramInfo {
+    /**
+     * Program ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string;
+    /**
+     * Program external ID.
+     * @format GUID
+     * @readonly
+     */
+    externalId?: string | null;
+}
+export 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"
+}
+export interface PoolProvisioned {
+    /** Pool which has been provisioned */
+    pool?: Pool;
+}
+export interface PoolRenewed {
+    /** Pool which has been granted */
+    pool?: Pool;
+}
+export interface BenefitRedeemed {
+    /** Pool which has been redeemed */
+    pool?: Pool;
+    /** Details of the redemption */
+    redemptionDetails?: RedemptionDetails;
+}
+export 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;
+}
+export interface ItemReference {
+    /**
+     * External ID of the item.
+     * @format GUID
+     */
+    externalId?: string;
+    /**
+     * Item category.
+     * @maxLength 20
+     */
+    category?: string;
+    /**
+     * ID of the app providing the item.
+     * @format GUID
+     */
+    providerAppId?: string;
+}
+export interface PoolPaused {
+    /** Pool which has been paused */
+    pool?: Pool;
+}
+export interface PoolResumed {
+    /** Pool which has been resumed */
+    pool?: Pool;
+}
+export interface PoolEnded {
+    /** Pool which has been ended */
+    pool?: Pool;
+}
+export interface BenefitReserved {
+    /** Pool which was used to perform this transaction */
+    pool?: Pool;
+    /** Details of the redemption */
+    redemptionDetails?: RedemptionDetails;
+}
+export interface BenefitReservationCanceled {
+    /** Pool which was used to perform this transaction */
+    pool?: Pool;
+    /**
+     * Id of the canceled reservation transaction
+     * @format GUID
+     */
+    transactionId?: string;
+}
+export interface BenefitReservationReleased {
+    /** Pool which was used to perform this transaction */
+    pool?: Pool;
+    /**
+     * Id of the released reservation transaction
+     * @format GUID
+     */
+    transactionId?: string;
+}
+export interface PoolProvisionJobFinished {
+    /**
+     * Program id
+     * @format GUID
+     */
+    programId?: string;
+    /** Processed item count */
+    processedItemCount?: number;
+    /** Origin of the pool */
+    origin?: PoolOrigin;
+}
+export 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?: PoolStatus;
+    /** The total number of items that were processed */
+    processedItemCount?: number;
+}
+/** @oneof */
+export 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;
+}
+export 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;
+}
+export 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;
+}
+export interface CreatePoolRequest {
+    /** Pool to be created. */
+    pool?: Pool;
+}
+export interface CreatePoolResponse {
+    /** Created pool. */
+    pool?: Pool;
+}
+export interface GetPoolRequest {
+    /**
+     * ID of the pool to retrieve.
+     * @format GUID
+     */
+    poolId: string;
+}
+export interface GetPoolResponse {
+    /** Retrieved pool. */
+    pool?: Pool;
+}
+export interface UpdatePoolRequest {
+    /** Pool to update. */
+    pool: Pool;
+}
+export interface UpdatePoolResponse {
+    /** Updated pool. */
+    pool?: Pool;
+}
+export interface DeletePoolRequest {
+    /**
+     * ID of the pool to delete.
+     * @format GUID
+     */
+    poolId?: string;
+}
+export interface DeletePoolResponse {
+}
+export interface QueryPoolsRequest {
+    /** Filter, sort, and paging to apply to the query. */
+    query: CursorQuery;
+}
+export interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
+     * for more information.
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * List of sort objects.
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+export interface CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+export interface Sorting {
+    /**
+     * Field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /**
+     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `ASC`
+     */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    /** Ascending sort order. */
+    ASC = "ASC",
+    /** Descending sort order. */
+    DESC = "DESC"
+}
+export interface CursorPaging {
+    /**
+     * Maximum number of items to return.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+export interface QueryPoolsResponse {
+    /** List of retrieved pools. */
+    pools?: Pool[];
+    /** Metadata for the paginated results. */
+    metadata?: CursorPagingMetadata;
+}
+export interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+export interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+export interface RedeemBenefitRequest {
+    /**
+     * ID of the pool that contains the benefit to redeem.
+     * @format GUID
+     */
+    poolId: string;
+    /** Information about the item to redeem. */
+    itemReference: ItemReference;
+    /**
+     * Key of the benefit to redeem.
+     * @maxLength 64
+     */
+    benefitKey: string;
+    /**
+     * Amount of items to redeem.
+     * @min 1
+     */
+    count?: number;
+    /**
+     * Date that the item will be provided to the beneficiary.
+     *
+     * The pool's associated balance will update immediately. This parameter should be used to manage the logistics of providing the item.
+     */
+    targetDate?: Date | null;
+    /**
+     * Unique identifier, generated by the client.
+     * Used to recognize repeated attempts to make the same request.
+     * @maxLength 200
+     */
+    idempotencyKey: string;
+    /** Additional information. */
+    additionalData?: Record<string, any> | null;
+    /** Beneficiary of the pool containing the benefit to redeem. */
+    beneficiary?: CommonIdentificationData;
+    /**
+     * 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
+     * @maxLength 50
+     */
+    namespace: string;
+}
+export interface RedeemBenefitResponse {
+    /**
+     * ID of the transaction recording the associated change in balance.
+     * @format GUID
+     */
+    transactionId?: string;
+}
+export interface NotEnoughBalance {
+    /**
+     * Pool ID.
+     * @format GUID
+     */
+    poolId?: string;
+    /** Item reference. */
+    itemReference?: ItemReference;
+    /**
+     * Pool's associated balance amount in credits.
+     * @decimalValue options { maxScale:4 }
+     */
+    availableBalance?: string;
+    /**
+     * Price of the item in credits.
+     * @decimalValue options { maxScale:4 }
+     */
+    requestedBalance?: string;
+}
+export interface PolicyExpressionEvaluatedToFalse {
+    /**
+     * Pool ID.
+     * @format GUID
+     */
+    poolId?: string;
+    /** Item reference. */
+    itemReference?: ItemReference;
+    /**
+     * Failure details.
+     * @maxSize 10
+     */
+    failureDetails?: FailureDetails[];
+}
+export 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;
+}
+export interface PoolNotActive {
+    /**
+     * Pool ID.
+     * @format GUID
+     */
+    poolId?: string;
+    /** Pool status. */
+    poolStatus?: PoolStatus;
+}
+export interface PoolNotFound {
+    /**
+     * Pool ID.
+     * @format GUID
+     */
+    poolId?: string;
+}
+export interface BenefitAlreadyRedeemed {
+    /**
+     * Pool ID
+     * @format GUID
+     */
+    poolId?: string;
+    /**
+     * Idempotency key of the request that failed
+     * @maxLength 200
+     */
+    idempotencyKey?: string;
+}
+export interface BenefitNotFound {
+    /**
+     * Pool ID.
+     * @format GUID
+     */
+    poolId?: string;
+    /**
+     * Specified benefit key.
+     * @format GUID
+     */
+    benefitKey?: string | null;
+}
+export 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 50
+     */
+    namespace?: string;
+}
+export interface ReserveBenefitResponse {
+    /**
+     * Id of the transaction that was created as a result of this request
+     * @format GUID
+     */
+    transactionId?: string;
+}
+export interface CancelBenefitReservationRequest {
+    /**
+     * Id of the transaction that was created as a result of this request
+     * @format GUID
+     */
+    transactionId?: string;
+}
+export interface CancelBenefitReservationResponse {
+    /**
+     * Id of the transaction that was created as a result of this request
+     * @format GUID
+     */
+    transactionId?: string;
+}
+export interface ReleaseBenefitReservationRequest {
+    /**
+     * Id of the transaction that was created as a result of this request
+     * @format GUID
+     */
+    transactionId?: string;
+}
+export interface ReleaseBenefitReservationResponse {
+    /**
+     * Id of the transaction that was created as a result of this request
+     * @format GUID
+     */
+    transactionId?: string;
+}
+export interface CheckBenefitEligibilityRequest {
+    /**
+     * ID of the pool that the benefit to check belongs to.
+     * @format GUID
+     */
+    poolId: string;
+    /**
+     * Key of the benefit to check.
+     * @maxLength 64
+     */
+    benefitKey?: string | null;
+    /** Information about the item to check. */
+    itemReference: ItemReference;
+    /**
+     * Amount of items to check.
+     *
+     * Ensures the balance is high enough to redeem this many items.
+     * @min 1
+     */
+    count?: number;
+    /**
+     * Date that the item will be provided to the beneficiary.
+     *
+     * This parameter should be used to manage the potential logistics of providing the item.
+     */
+    targetDate?: Date | null;
+    /** Additional information. */
+    additionalData?: Record<string, any> | null;
+    /** Beneficiary of the pool containing the benefit to check. */
+    beneficiary?: CommonIdentificationData;
+    /**
+     * 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
+     * @maxLength 50
+     */
+    namespace: string;
+}
+export interface CheckBenefitEligibilityResponse {
+    /** Result of the eligibility check. */
+    result?: EligibilityCheckResult;
+}
+export interface EligibilityCheckResult extends EligibilityCheckResultResultOneOf {
+    /** Returned when item is eligible to be redeemed. */
+    eligibleOptions?: Eligible;
+    /** Returned when the pool's associated balance is lower than the cost of redeeming the items. */
+    notEnoughBalanceOptions?: NotEnoughBalance;
+    /** Returned when the pool isn't active. */
+    poolNotActiveOptions?: PoolNotActive;
+    /** Returned when invalid benefit details are provided. */
+    benefitNotFoundOptions?: BenefitNotFound;
+    /** Returned when invalid pool details are provided. */
+    poolNotFoundOptions?: PoolNotFound;
+    /** Eligibility status. */
+    type?: EligibilityCheckResultType;
+}
+/** @oneof */
+export interface EligibilityCheckResultResultOneOf {
+    /** Returned when item is eligible to be redeemed. */
+    eligibleOptions?: Eligible;
+    /** Returned when the pool's associated balance is lower than the cost of redeeming the items. */
+    notEnoughBalanceOptions?: NotEnoughBalance;
+    /** Returned when the pool isn't active. */
+    poolNotActiveOptions?: PoolNotActive;
+    /** Returned when invalid benefit details are provided. */
+    benefitNotFoundOptions?: BenefitNotFound;
+    /** Returned when invalid pool details are provided. */
+    poolNotFoundOptions?: PoolNotFound;
+}
+export interface EligibleBenefit {
+    /**
+     * Pool ID.
+     * @format GUID
+     * @readonly
+     */
+    poolId?: string;
+    /**
+     * Benefit key.
+     * @maxLength 64
+     */
+    benefitKey?: string;
+    /** Item reference. */
+    itemReference?: ItemReference;
+    /**
+     * Price of the benefit in credits.
+     * @decimalValue options { gte:0, maxScale:4 }
+     */
+    price?: string | null;
+}
+export declare enum EligibilityCheckResultType {
+    /** Unknown eligibility. */
+    UNKNOWN = "UNKNOWN",
+    /** Item is eligible to be redeemed. */
+    ELIGIBLE = "ELIGIBLE",
+    /** Balance is lower than the cost of redeeming the items. */
+    NOT_ENOUGH_BALANCE = "NOT_ENOUGH_BALANCE",
+    /** Pool isn't active. */
+    POOL_NOT_ACTIVE = "POOL_NOT_ACTIVE",
+    /** Invalid benefit details provided. */
+    BENEFIT_NOT_FOUND = "BENEFIT_NOT_FOUND",
+    /** Invalid pool details provided. */
+    POOL_NOT_FOUND = "POOL_NOT_FOUND"
+}
+export interface Eligible {
+    /**
+     * Benefits that are eligible to be redeemed.
+     * @maxSize 100
+     */
+    eligibleBenefits?: EligibleBenefit[];
+}
+export interface BulkCheckBenefitEligibilityRequest {
+    /**
+     * List of benefits to check.
+     * @minSize 1
+     * @maxSize 100
+     */
+    benefitSelectors?: BenefitSelector[];
+    /**
+     * 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
+     * @maxLength 50
+     */
+    namespace: string;
+    /** Pool beneficiary. */
+    beneficiary?: CommonIdentificationData;
+}
+export interface BenefitSelector {
+    /**
+     * ID of the pool that the benefit to check belongs to.
+     * @format GUID
+     */
+    poolId?: string;
+    /**
+     * Key of the benefit to check.
+     * @maxLength 64
+     */
+    benefitKey?: string | null;
+    /** Information about the item to check. */
+    itemReference?: ItemReference;
+    /**
+     * Amount of items to check.
+     *
+     * Ensures the balance is high enough to redeem this many it
+     * @min 1
+     */
+    count?: number;
+    /**
+     * Date that the item will be provided to the beneficiary.
+     *
+     * This parameter should be used to manage the potential logistics of providing the item.
+     */
+    targetDate?: Date | null;
+    /** Additional information. */
+    additionalData?: Record<string, any> | null;
+}
+export interface BulkCheckBenefitEligibilityResponse {
+    /**
+     * List of results checking each benefit.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkEligibilityCheckResult[];
+}
+export interface BulkEligibilityCheckResult {
+    /** Benefit information specified in API call. */
+    benefitSelector?: BenefitSelector;
+    /** Result of the eligibility check. */
+    result?: EligibilityCheckResult;
+}
+export interface GetEligibleBenefitsRequest {
+    /** Item reference. */
+    itemReference: ItemReference;
+    /**
+     * Amount of items to check. This ensures the balance is high enough to redeem this many items.
+     * @min 1
+     */
+    count?: number;
+    /**
+     * Date that the item will be provided to the beneficiary.
+     *
+     * This parameter should be used to manage the potential logistics of providing the item.
+     */
+    targetDate?: Date | null;
+    /** Additional information. */
+    additionalData?: Record<string, any> | null;
+    /** Filter request by beneficiary. */
+    beneficiary?: CommonIdentificationData;
+    /**
+     * 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
+     * @maxLength 50
+     */
+    namespace: string;
+}
+export interface GetEligibleBenefitsResponse {
+    /** Retrieved benefits that can be redeemed. */
+    eligibleBenefits?: EligibleBenefit[];
+}
+export interface ListPoolsRequest {
+    /** The filter */
+    filter?: Filter;
+    /** Cursor paging */
+    cursorPaging?: CursorPaging;
+}
+export declare enum ListPoolsRequestType {
+    UNKNOWN_FILTER = "UNKNOWN_FILTER",
+    BY_ITEM_REFERENCE = "BY_ITEM_REFERENCE"
+}
+export 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?: PoolStatus[];
+}
+export interface ByItemReferenceFilter {
+    /** Reference of the item */
+    itemReference?: ItemReference;
+}
+export interface Filter extends FilterFilterOneOf {
+    /** A list of filters by reference */
+    byItemReferenceOptions?: ByItemReference;
+    /** Type of the filter */
+    type?: ListPoolsRequestType;
+    /**
+     * 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.
+     * @maxLength 50
+     */
+    namespace?: string;
+}
+/** @oneof */
+export interface FilterFilterOneOf {
+    /** A list of filters by reference */
+    byItemReferenceOptions?: ByItemReference;
+}
+export interface ListPoolsResponse {
+    /**
+     * The retrieved pools
+     * @maxSize 100
+     */
+    pools?: PoolWithItems[];
+    /** Paging information */
+    metadata?: CursorPagingMetadata;
+}
+export interface PoolWithItems {
+    /** The pool */
+    pool?: Pool;
+    /**
+     * The items in the pool
+     * @maxSize 100
+     */
+    itemReference?: ItemReference[];
+}
+export interface BulkUpdatePoolsRequest {
+    /**
+     * Pools to update.
+     * @minSize 1
+     * @maxSize 100
+     */
+    pools?: MaskedPool[];
+    /**
+     * Whether to return the full pool definition entities.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+export interface MaskedPool {
+    /** Pool to update. */
+    pool?: Pool;
+    /** Explicit list of fields to update. */
+    fieldMask?: string[];
+}
+export interface BulkUpdatePoolsResponse {
+    /**
+     * List of updated pools and associated metadata.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkPoolResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkPoolResult {
+    /** Pool metadata. */
+    poolMetadata?: ItemMetadata;
+    /** Pool data. */
+    pool?: Pool;
+}
+export interface ItemMetadata {
+    /**
+     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+     * @format GUID
+     */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+export interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+export interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+export interface 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;
+}
+export interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
+    /**
+     * Pool definition ID.
+     * @format GUID
+     */
+    poolDefinitionId?: string;
+    /**
+     * Program definition ID.
+     * @format GUID
+     */
+    programDefinitionId?: string;
+}
+/** @oneof */
+export interface PoolDefinitionLookupIdIdOneOf {
+    /**
+     * Pool definition ID.
+     * @format GUID
+     */
+    poolDefinitionId?: string;
+    /**
+     * Program definition ID.
+     * @format GUID
+     */
+    programDefinitionId?: string;
+}
+export 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?: ProvisionPoolsForProgramResponseType;
+}
+/** @oneof */
+export interface ProvisionPoolsForProgramResponseResultOneOf {
+    /** Sync result */
+    syncOptions?: SyncResult;
+    /** Async result */
+    asyncOptions?: AsyncResult;
+}
+export declare enum ProvisionPoolsForProgramResponseType {
+    /** Unknown result type */
+    UNKNOWN = "UNKNOWN",
+    /** Sync result */
+    SYNC = "SYNC",
+    /** Async result */
+    ASYNC = "ASYNC"
+}
+export interface SyncResult {
+    /** Indicates if the operation was successful */
+    success?: boolean;
+}
+export 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;
+}
+export interface InvalidPoolDefinitionReference {
+    /** Reference of the template that didn't find any pool definitions */
+    poolDefinitionLookupId?: PoolDefinitionLookupId;
+}
+export interface RenewPoolsForProgramRequest {
+    /**
+     * Package of pools to grant. Package id should be the same that was used to provision programs.
+     * @format GUID
+     */
+    programId?: string;
+}
+export interface RenewPoolsForProgramResponse {
+    /**
+     * Job id of the renewal job
+     * @format GUID
+     */
+    jobId?: string;
+}
+export 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?: PoolStatus;
+    /** Pool selector type */
+    poolSelectorType?: PoolSelectorType;
+}
+/** @oneof */
+export interface UpdatePoolStatusRequestPoolSelectorOneOf {
+    /** Pool selector by pool definition id and program definition id */
+    byPoolDefinitionIdAndProgramDefinitionIdOptions?: ByPoolDefinitionIdAndProgramDefinitionIdOptions;
+    /** Pool selector by program id */
+    byProgramIdOptions?: ByProgramIdOptions;
+}
+export 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"
+}
+export interface ByPoolDefinitionIdAndProgramDefinitionIdOptions {
+    /**
+     * Pool definition id
+     * @format GUID
+     */
+    poolDefinitionId?: string;
+    /**
+     * Program definition id
+     * @format GUID
+     */
+    programDefinitionId?: string | null;
+}
+export 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;
+}
+export 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;
+}
+export interface CountNumberOfPoolsInProvisioningStatusRequest {
+    /**
+     * Program id
+     * @format GUID
+     */
+    programId?: string;
+}
+export interface CountNumberOfPoolsInProvisioningStatusResponse {
+    /** Number of pools in provisioning status */
+    count?: number;
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntityAsJson?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+export 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;
+}
+export 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?: WebhookIdentityType;
+}
+/** @oneof */
+export 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;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}