@wix/auto_sdk_benefit-programs_pools 1.0.22 → 1.0.24

package/build/index.d.mts

@@ -0,0 +1,105 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { P as Pool, U as UpdatePool, a as PoolsQueryBuilder, R as RedeemBenefitOptions, b as RedeemBenefitResponse, C as CheckBenefitEligibilityOptions, c as CheckBenefitEligibilityResponse, B as BulkCheckBenefitEligibilityOptions, d as BulkCheckBenefitEligibilityResponse, I as ItemReference, G as GetEligibleBenefitsOptions, e as GetEligibleBenefitsResponse, f as BulkUpdatePoolsOptions, g as BulkUpdatePoolsResponse } from './benefit-programs-v1-pool-pools.universal-cRyidFWD.mjs';
+export { bj as ActionEvent, aW as ApplicationError, b2 as AsyncResult, r as Benefit, au as BenefitAlreadyRedeemed, av as BenefitNotFound, X as BenefitRedeemed, a1 as BenefitReservationCanceled, a2 as BenefitReservationReleased, a0 as BenefitReserved, aI as BenefitSelector, aX as BulkActionMetadata, aH as BulkCheckBenefitEligibilityRequest, aJ as BulkEligibilityCheckResult, aU as BulkPoolResult, aS as BulkUpdatePoolsRequest, aM as ByItemReference, aN as ByItemReferenceFilter, b8 as ByPoolDefinitionIdAndProgramDefinitionIdOptions, b9 as ByProgramIdOptions, ay as CancelBenefitReservationRequest, az as CancelBenefitReservationResponse, aC as CheckBenefitEligibilityRequest, p as CommonIdentificationData, q as CommonIdentificationDataIdOneOf, bb as CountNumberOfPoolsInProvisioningStatusRequest, bc as CountNumberOfPoolsInProvisioningStatusResponse, a8 as CreatePoolRequest, a9 as CreatePoolResponse, J as CreditConfiguration, ak as CursorPaging, am as CursorPagingMetadata, ah as CursorQuery, ai as CursorQueryPagingMethodOneOf, an as Cursors, H as CustomPolicy, ae as DeletePoolRequest, af as DeletePoolResponse, D as Details, bd as DomainEvent, be as DomainEventBodyOneOf, aD as EligibilityCheckResult, aE as EligibilityCheckResultResultOneOf, E as EligibilityCheckResultType, aG as Eligible, aF as EligibleBenefit, bf as EntityCreatedEvent, bi as EntityDeletedEvent, bh as EntityUpdatedEvent, M as ExtendedFields, ar as FailureDetails, aO as Filter, aP as FilterFilterOneOf, F as FixedIntervalPolicy, aK as GetEligibleBenefitsRequest, aa as GetPoolRequest, ab as GetPoolResponse, bl as IdentificationData, bm as IdentificationDataIdOneOf, i as IdentityType, b3 as InvalidPoolDefinitionReference, aV as ItemMetadata, aL as ListPoolsRequest, L as ListPoolsRequestType, aQ as ListPoolsResponse, aT as MaskedPool, bk as MessageEnvelope, ap as NotEnoughBalance, x as Policy, s as PolicyExpression, v as PolicyExpressionAnd, aq as PolicyExpressionEvaluatedToFalse, t as PolicyExpressionExpressionOneOf, u as PolicyExpressionNot, w as PolicyExpressionOr, j as PolicyExpressionType, y as PolicyPolicyOneOf, a6 as PoolDefinitionAndProgramDefinition, aZ as PoolDefinitionLookupId, a_ as PoolDefinitionLookupIdIdOneOf, $ as PoolEnded, as as PoolNotActive, at as PoolNotFound, l as PoolOrigin, Z as PoolPaused, O as PoolProgramInfo, a3 as PoolProvisionJobFinished, Q as PoolProvisioned, V as PoolRenewed, _ as PoolResumed, n as PoolSelectorType, h as PoolStatus, a4 as PoolStatusUpdateJobFinished, a5 as PoolStatusUpdateJobFinishedContextOneOf, aR as PoolWithItems, bn as PoolsQueryResult, N as ProgramDefinitionInfo, a7 as ProgramInfo, aY as ProvisionPoolsForProgramRequest, a$ as ProvisionPoolsForProgramResponse, b0 as ProvisionPoolsForProgramResponseResultOneOf, m as ProvisionPoolsForProgramResponseType, ag as QueryPoolsRequest, al as QueryPoolsResponse, z as RateLimitedPolicy, A as RateLimitedPolicyPeriodOneOf, k as RateLimitedPolicyType, ao as RedeemBenefitRequest, Y as RedemptionDetails, aA as ReleaseBenefitReservationRequest, aB as ReleaseBenefitReservationResponse, b4 as RenewPoolsForProgramRequest, b5 as RenewPoolsForProgramResponse, aw as ReserveBenefitRequest, ax as ReserveBenefitResponse, bg as RestoreInfo, K as RolloverConfiguration, S as SortOrder, aj as Sorting, b1 as SyncResult, T as Type, ac as UpdatePoolRequest, ad as UpdatePoolResponse, b6 as UpdatePoolStatusRequest, b7 as UpdatePoolStatusRequestPoolSelectorOneOf, ba as UpdatePoolStatusResponse, o as WebhookIdentityType, W as WeekDay } from './benefit-programs-v1-pool-pools.universal-cRyidFWD.mjs';
+
+declare function getPool$1(httpClient: HttpClient): GetPoolSignature;
+interface GetPoolSignature {
+    /**
+     * Retrieves a pool.
+     * @param - ID of the pool to retrieve.
+     * @returns Retrieved pool.
+     */
+    (poolId: string): Promise<Pool>;
+}
+declare function updatePool$1(httpClient: HttpClient): UpdatePoolSignature;
+interface UpdatePoolSignature {
+    /**
+     * Updates a pool.
+     *
+     * Each time the pool is updated,
+     * `revision` increments by 1.
+     * The current `revision` must be passed when updating the pool.
+     * This ensures you're working with the latest pool
+     * and prevents unintended overwrites.
+     * @param - Pool ID.
+     * @returns Updated pool.
+     */
+    (_id: string, pool: UpdatePool): Promise<Pool>;
+}
+declare function queryPools$1(httpClient: HttpClient): QueryPoolsSignature;
+interface QueryPoolsSignature {
+    /**
+     * Creates a query to retrieve a list of pools.
+     *
+     * The Query Pools method builds a query to retrieve a list of pools and returns a `PoolsQueryBuilder` object.
+     *
+     * The returned object contains the query definition, which is used to run the query using the `find()` method.
+     *
+     * You can refine the query by chaining `PoolsQueryBuilder` methods onto the query. `PoolsQueryBuilder` methods enable you to filter, sort, and control the results that Query Pools returns.
+     *
+     * Query Pools has a default paging limit of 50, which you can override.
+     *
+     *  For a full description of the item object, see the object returned for the `items` property in `PoolsQueryResult`.
+     */
+    (): PoolsQueryBuilder;
+}
+declare function redeemBenefit$1(httpClient: HttpClient): RedeemBenefitSignature;
+interface RedeemBenefitSignature {
+    /**
+     * Redeems a specified benefit.
+     *
+     * Calling this method records redemption of the benefit and adjusts the pool's associated balance. You still need to handle providing the beneficiary with the item.
+     * @param - ID of the pool that contains the benefit to redeem.
+     */
+    (poolId: string, options?: RedeemBenefitOptions | undefined): Promise<RedeemBenefitResponse>;
+}
+declare function checkBenefitEligibility$1(httpClient: HttpClient): CheckBenefitEligibilitySignature;
+interface CheckBenefitEligibilitySignature {
+    /**
+     * Checks if a benefit can currently be redeemed.
+     *
+     * To be redeemed, a benefit's pool must be active and the associated balance must be greater than the cost of the benefit.
+     * @param - ID of the pool that the benefit to check belongs to.
+     */
+    (poolId: string, options?: CheckBenefitEligibilityOptions | undefined): Promise<CheckBenefitEligibilityResponse>;
+}
+declare function bulkCheckBenefitEligibility$1(httpClient: HttpClient): BulkCheckBenefitEligibilitySignature;
+interface BulkCheckBenefitEligibilitySignature {
+    /**
+     * Checks if benefits can currently be redeemed.
+     *
+     * To be redeemed, a benefit's pool must be active and the associated balance must greater be than the cost of the benefit.
+     *
+     * Each benefit is checked independently. For example, if there is a benefit with a price of 3 credits and a benefit with a price of 4 credits, and there are 5 available credits, both benefits would be returned as eligible, but they can't both be redeemed.
+     */
+    (options?: BulkCheckBenefitEligibilityOptions | undefined): Promise<BulkCheckBenefitEligibilityResponse>;
+}
+declare function getEligibleBenefits$1(httpClient: HttpClient): GetEligibleBenefitsSignature;
+interface GetEligibleBenefitsSignature {
+    /**
+     * Retrieves benefits that can be redeemed for a specific benefit item.
+     *
+     * Each benefit item can only be linked to 1 benefit in 1 pool definition. However, each pool created from that pool definition contains the same benefits.
+     * This method checks each pool containing a benefit with this benefit item, and returns the benefits that can be redeemed.
+     * @param - Item reference.
+     */
+    (itemReference: ItemReference, options?: GetEligibleBenefitsOptions | undefined): Promise<GetEligibleBenefitsResponse>;
+}
+declare function bulkUpdatePools$1(httpClient: HttpClient): BulkUpdatePoolsSignature;
+interface BulkUpdatePoolsSignature {
+    /**
+     * Updates pools.
+     */
+    (options?: BulkUpdatePoolsOptions | undefined): Promise<BulkUpdatePoolsResponse>;
+}
+
+declare const getPool: MaybeContext<BuildRESTFunction<typeof getPool$1> & typeof getPool$1>;
+declare const updatePool: MaybeContext<BuildRESTFunction<typeof updatePool$1> & typeof updatePool$1>;
+declare const queryPools: MaybeContext<BuildRESTFunction<typeof queryPools$1> & typeof queryPools$1>;
+declare const redeemBenefit: MaybeContext<BuildRESTFunction<typeof redeemBenefit$1> & typeof redeemBenefit$1>;
+declare const checkBenefitEligibility: MaybeContext<BuildRESTFunction<typeof checkBenefitEligibility$1> & typeof checkBenefitEligibility$1>;
+declare const bulkCheckBenefitEligibility: MaybeContext<BuildRESTFunction<typeof bulkCheckBenefitEligibility$1> & typeof bulkCheckBenefitEligibility$1>;
+declare const getEligibleBenefits: MaybeContext<BuildRESTFunction<typeof getEligibleBenefits$1> & typeof getEligibleBenefits$1>;
+declare const bulkUpdatePools: MaybeContext<BuildRESTFunction<typeof bulkUpdatePools$1> & typeof bulkUpdatePools$1>;
+
+export { BulkCheckBenefitEligibilityOptions, BulkCheckBenefitEligibilityResponse, BulkUpdatePoolsOptions, BulkUpdatePoolsResponse, CheckBenefitEligibilityOptions, CheckBenefitEligibilityResponse, GetEligibleBenefitsOptions, GetEligibleBenefitsResponse, ItemReference, Pool, PoolsQueryBuilder, RedeemBenefitOptions, RedeemBenefitResponse, UpdatePool, bulkCheckBenefitEligibility, bulkUpdatePools, checkBenefitEligibility, getEligibleBenefits, getPool, queryPools, redeemBenefit, updatePool };

package/build/index.d.ts

@@ -0,0 +1,105 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { P as Pool, U as UpdatePool, a as PoolsQueryBuilder, R as RedeemBenefitOptions, b as RedeemBenefitResponse, C as CheckBenefitEligibilityOptions, c as CheckBenefitEligibilityResponse, B as BulkCheckBenefitEligibilityOptions, d as BulkCheckBenefitEligibilityResponse, I as ItemReference, G as GetEligibleBenefitsOptions, e as GetEligibleBenefitsResponse, f as BulkUpdatePoolsOptions, g as BulkUpdatePoolsResponse } from './benefit-programs-v1-pool-pools.universal-cRyidFWD.js';
+export { bj as ActionEvent, aW as ApplicationError, b2 as AsyncResult, r as Benefit, au as BenefitAlreadyRedeemed, av as BenefitNotFound, X as BenefitRedeemed, a1 as BenefitReservationCanceled, a2 as BenefitReservationReleased, a0 as BenefitReserved, aI as BenefitSelector, aX as BulkActionMetadata, aH as BulkCheckBenefitEligibilityRequest, aJ as BulkEligibilityCheckResult, aU as BulkPoolResult, aS as BulkUpdatePoolsRequest, aM as ByItemReference, aN as ByItemReferenceFilter, b8 as ByPoolDefinitionIdAndProgramDefinitionIdOptions, b9 as ByProgramIdOptions, ay as CancelBenefitReservationRequest, az as CancelBenefitReservationResponse, aC as CheckBenefitEligibilityRequest, p as CommonIdentificationData, q as CommonIdentificationDataIdOneOf, bb as CountNumberOfPoolsInProvisioningStatusRequest, bc as CountNumberOfPoolsInProvisioningStatusResponse, a8 as CreatePoolRequest, a9 as CreatePoolResponse, J as CreditConfiguration, ak as CursorPaging, am as CursorPagingMetadata, ah as CursorQuery, ai as CursorQueryPagingMethodOneOf, an as Cursors, H as CustomPolicy, ae as DeletePoolRequest, af as DeletePoolResponse, D as Details, bd as DomainEvent, be as DomainEventBodyOneOf, aD as EligibilityCheckResult, aE as EligibilityCheckResultResultOneOf, E as EligibilityCheckResultType, aG as Eligible, aF as EligibleBenefit, bf as EntityCreatedEvent, bi as EntityDeletedEvent, bh as EntityUpdatedEvent, M as ExtendedFields, ar as FailureDetails, aO as Filter, aP as FilterFilterOneOf, F as FixedIntervalPolicy, aK as GetEligibleBenefitsRequest, aa as GetPoolRequest, ab as GetPoolResponse, bl as IdentificationData, bm as IdentificationDataIdOneOf, i as IdentityType, b3 as InvalidPoolDefinitionReference, aV as ItemMetadata, aL as ListPoolsRequest, L as ListPoolsRequestType, aQ as ListPoolsResponse, aT as MaskedPool, bk as MessageEnvelope, ap as NotEnoughBalance, x as Policy, s as PolicyExpression, v as PolicyExpressionAnd, aq as PolicyExpressionEvaluatedToFalse, t as PolicyExpressionExpressionOneOf, u as PolicyExpressionNot, w as PolicyExpressionOr, j as PolicyExpressionType, y as PolicyPolicyOneOf, a6 as PoolDefinitionAndProgramDefinition, aZ as PoolDefinitionLookupId, a_ as PoolDefinitionLookupIdIdOneOf, $ as PoolEnded, as as PoolNotActive, at as PoolNotFound, l as PoolOrigin, Z as PoolPaused, O as PoolProgramInfo, a3 as PoolProvisionJobFinished, Q as PoolProvisioned, V as PoolRenewed, _ as PoolResumed, n as PoolSelectorType, h as PoolStatus, a4 as PoolStatusUpdateJobFinished, a5 as PoolStatusUpdateJobFinishedContextOneOf, aR as PoolWithItems, bn as PoolsQueryResult, N as ProgramDefinitionInfo, a7 as ProgramInfo, aY as ProvisionPoolsForProgramRequest, a$ as ProvisionPoolsForProgramResponse, b0 as ProvisionPoolsForProgramResponseResultOneOf, m as ProvisionPoolsForProgramResponseType, ag as QueryPoolsRequest, al as QueryPoolsResponse, z as RateLimitedPolicy, A as RateLimitedPolicyPeriodOneOf, k as RateLimitedPolicyType, ao as RedeemBenefitRequest, Y as RedemptionDetails, aA as ReleaseBenefitReservationRequest, aB as ReleaseBenefitReservationResponse, b4 as RenewPoolsForProgramRequest, b5 as RenewPoolsForProgramResponse, aw as ReserveBenefitRequest, ax as ReserveBenefitResponse, bg as RestoreInfo, K as RolloverConfiguration, S as SortOrder, aj as Sorting, b1 as SyncResult, T as Type, ac as UpdatePoolRequest, ad as UpdatePoolResponse, b6 as UpdatePoolStatusRequest, b7 as UpdatePoolStatusRequestPoolSelectorOneOf, ba as UpdatePoolStatusResponse, o as WebhookIdentityType, W as WeekDay } from './benefit-programs-v1-pool-pools.universal-cRyidFWD.js';
+
+declare function getPool$1(httpClient: HttpClient): GetPoolSignature;
+interface GetPoolSignature {
+    /**
+     * Retrieves a pool.
+     * @param - ID of the pool to retrieve.
+     * @returns Retrieved pool.
+     */
+    (poolId: string): Promise<Pool>;
+}
+declare function updatePool$1(httpClient: HttpClient): UpdatePoolSignature;
+interface UpdatePoolSignature {
+    /**
+     * Updates a pool.
+     *
+     * Each time the pool is updated,
+     * `revision` increments by 1.
+     * The current `revision` must be passed when updating the pool.
+     * This ensures you're working with the latest pool
+     * and prevents unintended overwrites.
+     * @param - Pool ID.
+     * @returns Updated pool.
+     */
+    (_id: string, pool: UpdatePool): Promise<Pool>;
+}
+declare function queryPools$1(httpClient: HttpClient): QueryPoolsSignature;
+interface QueryPoolsSignature {
+    /**
+     * Creates a query to retrieve a list of pools.
+     *
+     * The Query Pools method builds a query to retrieve a list of pools and returns a `PoolsQueryBuilder` object.
+     *
+     * The returned object contains the query definition, which is used to run the query using the `find()` method.
+     *
+     * You can refine the query by chaining `PoolsQueryBuilder` methods onto the query. `PoolsQueryBuilder` methods enable you to filter, sort, and control the results that Query Pools returns.
+     *
+     * Query Pools has a default paging limit of 50, which you can override.
+     *
+     *  For a full description of the item object, see the object returned for the `items` property in `PoolsQueryResult`.
+     */
+    (): PoolsQueryBuilder;
+}
+declare function redeemBenefit$1(httpClient: HttpClient): RedeemBenefitSignature;
+interface RedeemBenefitSignature {
+    /**
+     * Redeems a specified benefit.
+     *
+     * Calling this method records redemption of the benefit and adjusts the pool's associated balance. You still need to handle providing the beneficiary with the item.
+     * @param - ID of the pool that contains the benefit to redeem.
+     */
+    (poolId: string, options?: RedeemBenefitOptions | undefined): Promise<RedeemBenefitResponse>;
+}
+declare function checkBenefitEligibility$1(httpClient: HttpClient): CheckBenefitEligibilitySignature;
+interface CheckBenefitEligibilitySignature {
+    /**
+     * Checks if a benefit can currently be redeemed.
+     *
+     * To be redeemed, a benefit's pool must be active and the associated balance must be greater than the cost of the benefit.
+     * @param - ID of the pool that the benefit to check belongs to.
+     */
+    (poolId: string, options?: CheckBenefitEligibilityOptions | undefined): Promise<CheckBenefitEligibilityResponse>;
+}
+declare function bulkCheckBenefitEligibility$1(httpClient: HttpClient): BulkCheckBenefitEligibilitySignature;
+interface BulkCheckBenefitEligibilitySignature {
+    /**
+     * Checks if benefits can currently be redeemed.
+     *
+     * To be redeemed, a benefit's pool must be active and the associated balance must greater be than the cost of the benefit.
+     *
+     * Each benefit is checked independently. For example, if there is a benefit with a price of 3 credits and a benefit with a price of 4 credits, and there are 5 available credits, both benefits would be returned as eligible, but they can't both be redeemed.
+     */
+    (options?: BulkCheckBenefitEligibilityOptions | undefined): Promise<BulkCheckBenefitEligibilityResponse>;
+}
+declare function getEligibleBenefits$1(httpClient: HttpClient): GetEligibleBenefitsSignature;
+interface GetEligibleBenefitsSignature {
+    /**
+     * Retrieves benefits that can be redeemed for a specific benefit item.
+     *
+     * Each benefit item can only be linked to 1 benefit in 1 pool definition. However, each pool created from that pool definition contains the same benefits.
+     * This method checks each pool containing a benefit with this benefit item, and returns the benefits that can be redeemed.
+     * @param - Item reference.
+     */
+    (itemReference: ItemReference, options?: GetEligibleBenefitsOptions | undefined): Promise<GetEligibleBenefitsResponse>;
+}
+declare function bulkUpdatePools$1(httpClient: HttpClient): BulkUpdatePoolsSignature;
+interface BulkUpdatePoolsSignature {
+    /**
+     * Updates pools.
+     */
+    (options?: BulkUpdatePoolsOptions | undefined): Promise<BulkUpdatePoolsResponse>;
+}
+
+declare const getPool: MaybeContext<BuildRESTFunction<typeof getPool$1> & typeof getPool$1>;
+declare const updatePool: MaybeContext<BuildRESTFunction<typeof updatePool$1> & typeof updatePool$1>;
+declare const queryPools: MaybeContext<BuildRESTFunction<typeof queryPools$1> & typeof queryPools$1>;
+declare const redeemBenefit: MaybeContext<BuildRESTFunction<typeof redeemBenefit$1> & typeof redeemBenefit$1>;
+declare const checkBenefitEligibility: MaybeContext<BuildRESTFunction<typeof checkBenefitEligibility$1> & typeof checkBenefitEligibility$1>;
+declare const bulkCheckBenefitEligibility: MaybeContext<BuildRESTFunction<typeof bulkCheckBenefitEligibility$1> & typeof bulkCheckBenefitEligibility$1>;
+declare const getEligibleBenefits: MaybeContext<BuildRESTFunction<typeof getEligibleBenefits$1> & typeof getEligibleBenefits$1>;
+declare const bulkUpdatePools: MaybeContext<BuildRESTFunction<typeof bulkUpdatePools$1> & typeof bulkUpdatePools$1>;
+
+export { BulkCheckBenefitEligibilityOptions, BulkCheckBenefitEligibilityResponse, BulkUpdatePoolsOptions, BulkUpdatePoolsResponse, CheckBenefitEligibilityOptions, CheckBenefitEligibilityResponse, GetEligibleBenefitsOptions, GetEligibleBenefitsResponse, ItemReference, Pool, PoolsQueryBuilder, RedeemBenefitOptions, RedeemBenefitResponse, UpdatePool, bulkCheckBenefitEligibility, bulkUpdatePools, checkBenefitEligibility, getEligibleBenefits, getPool, queryPools, redeemBenefit, updatePool };