@wix/auto_sdk_benefit-programs_pools 1.0.25 → 1.0.27

package/build/cjs/{benefit-programs-v1-pool-pools.universal-cRyidFWD.d.ts → index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface Pool {
     /**
      * Pool ID.
@@ -161,6 +163,8 @@ declare enum IdentityType {
     /** 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.
@@ -1592,6 +1596,70 @@ declare enum WebhookIdentityType {
 }
 /** @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>;
+};
+/**
+ * Retrieves a pool.
+ * @param poolId - ID of the pool to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField poolId
+ * @permissionId BENEFIT_PROGRAMS.POOL_READ
+ * @applicableIdentity APP
+ * @returns Retrieved pool.
+ * @fqn wix.benefit_programs.v1.pool.PoolService.GetPool
+ */
+declare function getPool(poolId: string): Promise<NonNullablePaths<Pool, `status` | `beneficiary.anonymousVisitorId` | `beneficiary.memberId` | `beneficiary.wixUserId` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.creditConfiguration.amount` | `displayName` | `programDefinition._id` | `program._id`, 5>>;
+/**
+ * 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 _id - Pool ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField pool
+ * @requiredField pool.revision
+ * @permissionId BENEFIT_PROGRAMS.POOL_UPDATE
+ * @applicableIdentity APP
+ * @returns Updated pool.
+ * @fqn wix.benefit_programs.v1.pool.PoolService.UpdatePool
+ */
+declare function updatePool(_id: string, pool: NonNullablePaths<UpdatePool, `revision`, 2>): Promise<NonNullablePaths<Pool, `status` | `beneficiary.anonymousVisitorId` | `beneficiary.memberId` | `beneficiary.wixUserId` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.creditConfiguration.amount` | `displayName` | `programDefinition._id` | `program._id`, 5>>;
 interface UpdatePool {
     /**
      * Pool ID.
@@ -1694,6 +1762,25 @@ interface UpdatePool {
      */
     renewalCount?: number | null;
 }
+/**
+ * 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`.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId BENEFIT_PROGRAMS.POOL_READ
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.pool.PoolService.QueryPools
+ */
+declare function queryPools(): PoolsQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -1771,6 +1858,27 @@ interface PoolsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<PoolsQueryResult>;
 }
+/**
+ * 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 poolId - ID of the pool that contains the benefit to redeem.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.benefitKey
+ * @requiredField options.idempotencyKey
+ * @requiredField options.itemReference
+ * @requiredField options.itemReference.externalId
+ * @requiredField options.itemReference.providerAppId
+ * @requiredField options.namespace
+ * @requiredField poolId
+ * @permissionId BENEFIT_PROGRAMS.POOL_REDEEM
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.pool.PoolService.RedeemBenefit
+ */
+declare function redeemBenefit(poolId: string, options?: NonNullablePaths<RedeemBenefitOptions, `benefitKey` | `idempotencyKey` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 3>): Promise<NonNullablePaths<RedeemBenefitResponse, `transactionId`, 2> & {
+    __applicationErrorsType?: RedeemBenefitApplicationErrors;
+}>;
 interface RedeemBenefitOptions {
     /** Information about the item to redeem. */
     itemReference: ItemReference;
@@ -1807,6 +1915,23 @@ interface RedeemBenefitOptions {
      */
     namespace: string;
 }
+/**
+ * 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 poolId - ID of the pool that the benefit to check belongs to.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.itemReference
+ * @requiredField options.itemReference.externalId
+ * @requiredField options.itemReference.providerAppId
+ * @requiredField options.namespace
+ * @requiredField poolId
+ * @permissionId BENEFIT_PROGRAMS.POOL_REDEEM
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.pool.PoolService.CheckBenefitEligibility
+ */
+declare function checkBenefitEligibility(poolId: string, options?: NonNullablePaths<CheckBenefitEligibilityOptions, `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 3>): Promise<NonNullablePaths<CheckBenefitEligibilityResponse, `result.eligibleOptions.eligibleBenefits` | `result.eligibleOptions.eligibleBenefits.${number}.poolId` | `result.eligibleOptions.eligibleBenefits.${number}.benefitKey` | `result.eligibleOptions.eligibleBenefits.${number}.itemReference.externalId` | `result.eligibleOptions.eligibleBenefits.${number}.itemReference.category` | `result.eligibleOptions.eligibleBenefits.${number}.itemReference.providerAppId` | `result.notEnoughBalanceOptions.poolId` | `result.notEnoughBalanceOptions.availableBalance` | `result.notEnoughBalanceOptions.requestedBalance` | `result.poolNotActiveOptions.poolId` | `result.poolNotActiveOptions.poolStatus` | `result.benefitNotFoundOptions.poolId` | `result.poolNotFoundOptions.poolId` | `result.type`, 7>>;
 interface CheckBenefitEligibilityOptions {
     /**
      * Key of the benefit to check.
@@ -1839,6 +1964,24 @@ interface CheckBenefitEligibilityOptions {
      */
     namespace: string;
 }
+/**
+ * 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.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.benefitSelectors.itemReference
+ * @requiredField options.benefitSelectors.itemReference.externalId
+ * @requiredField options.benefitSelectors.itemReference.providerAppId
+ * @requiredField options.benefitSelectors.poolId
+ * @requiredField options.namespace
+ * @permissionId BENEFIT_PROGRAMS.POOL_REDEEM
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.pool.PoolService.BulkCheckBenefitEligibility
+ */
+declare function bulkCheckBenefitEligibility(options?: NonNullablePaths<BulkCheckBenefitEligibilityOptions, `benefitSelectors.${number}.itemReference` | `benefitSelectors.${number}.itemReference.externalId` | `benefitSelectors.${number}.itemReference.providerAppId` | `benefitSelectors.${number}.poolId` | `namespace`, 5>): Promise<NonNullablePaths<BulkCheckBenefitEligibilityResponse, `results` | `results.${number}.benefitSelector.poolId` | `results.${number}.benefitSelector.itemReference.externalId` | `results.${number}.benefitSelector.itemReference.category` | `results.${number}.benefitSelector.itemReference.providerAppId` | `results.${number}.benefitSelector.count` | `results.${number}.result.notEnoughBalanceOptions.poolId` | `results.${number}.result.notEnoughBalanceOptions.availableBalance` | `results.${number}.result.notEnoughBalanceOptions.requestedBalance` | `results.${number}.result.poolNotActiveOptions.poolId` | `results.${number}.result.poolNotActiveOptions.poolStatus` | `results.${number}.result.benefitNotFoundOptions.poolId` | `results.${number}.result.poolNotFoundOptions.poolId` | `results.${number}.result.type`, 6>>;
 interface BulkCheckBenefitEligibilityOptions {
     /**
      * List of benefits to check.
@@ -1855,6 +1998,25 @@ interface BulkCheckBenefitEligibilityOptions {
     /** Pool beneficiary. */
     beneficiary?: CommonIdentificationData;
 }
+/**
+ * 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 itemReference - Item reference.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField itemReference
+ * @requiredField itemReference.externalId
+ * @requiredField itemReference.providerAppId
+ * @requiredField options.namespace
+ * @permissionId BENEFIT_PROGRAMS.POOL_READ
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.pool.PoolService.GetEligibleBenefits
+ */
+declare function getEligibleBenefits(itemReference: NonNullablePaths<ItemReference, `externalId` | `providerAppId`, 2>, options?: NonNullablePaths<GetEligibleBenefitsOptions, `namespace`, 2>): Promise<NonNullablePaths<GetEligibleBenefitsResponse, `eligibleBenefits` | `eligibleBenefits.${number}.poolId` | `eligibleBenefits.${number}.benefitKey` | `eligibleBenefits.${number}.itemReference.externalId` | `eligibleBenefits.${number}.itemReference.category` | `eligibleBenefits.${number}.itemReference.providerAppId`, 5> & {
+    __applicationErrorsType?: GetEligibleBenefitsApplicationErrors;
+}>;
 interface GetEligibleBenefitsOptions {
     /**
      * Amount of items to check. This ensures the balance is high enough to redeem this many items.
@@ -1878,6 +2040,18 @@ interface GetEligibleBenefitsOptions {
      */
     namespace: string;
 }
+/**
+ * Updates pools.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.pools.pool
+ * @requiredField options.pools.pool._id
+ * @requiredField options.pools.pool.revision
+ * @permissionId BENEFIT_PROGRAMS.POOL_UPDATE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.pool.PoolService.BulkUpdatePools
+ */
+declare function bulkUpdatePools(options?: NonNullablePaths<BulkUpdatePoolsOptions, `pools.${number}.pool` | `pools.${number}.pool._id` | `pools.${number}.pool.revision`, 5>): Promise<NonNullablePaths<BulkUpdatePoolsResponse, `results` | `results.${number}.poolMetadata.originalIndex` | `results.${number}.poolMetadata.success` | `results.${number}.poolMetadata.error.code` | `results.${number}.poolMetadata.error.description` | `results.${number}.pool.status` | `results.${number}.pool.beneficiary.anonymousVisitorId` | `results.${number}.pool.beneficiary.memberId` | `results.${number}.pool.beneficiary.wixUserId` | `results.${number}.pool.displayName` | `results.${number}.pool.programDefinition._id` | `results.${number}.pool.program._id` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
 interface BulkUpdatePoolsOptions {
     /**
      * Pools to update.
@@ -1893,4 +2067,4 @@ interface BulkUpdatePoolsOptions {
     returnEntity?: boolean;
 }
 
-export { type PoolEnded as $, type RateLimitedPolicyPeriodOneOf as A, type BulkCheckBenefitEligibilityOptions as B, type CheckBenefitEligibilityOptions as C, type Details as D, EligibilityCheckResultType as E, type FixedIntervalPolicy as F, type GetEligibleBenefitsOptions as G, type CustomPolicy as H, type ItemReference as I, type CreditConfiguration as J, type RolloverConfiguration as K, ListPoolsRequestType as L, type ExtendedFields as M, type ProgramDefinitionInfo as N, type PoolProgramInfo as O, type Pool as P, type PoolProvisioned as Q, type RedeemBenefitOptions as R, SortOrder as S, Type as T, type UpdatePool as U, type PoolRenewed as V, WeekDay as W, type BenefitRedeemed as X, type RedemptionDetails as Y, type PoolPaused as Z, type PoolResumed as _, type PoolsQueryBuilder as a, type ProvisionPoolsForProgramResponse as a$, type BenefitReserved as a0, type BenefitReservationCanceled as a1, type BenefitReservationReleased as a2, type PoolProvisionJobFinished as a3, type PoolStatusUpdateJobFinished as a4, type PoolStatusUpdateJobFinishedContextOneOf as a5, type PoolDefinitionAndProgramDefinition as a6, type ProgramInfo as a7, type CreatePoolRequest as a8, type CreatePoolResponse as a9, type ReleaseBenefitReservationRequest as aA, type ReleaseBenefitReservationResponse as aB, type CheckBenefitEligibilityRequest as aC, type EligibilityCheckResult as aD, type EligibilityCheckResultResultOneOf as aE, type EligibleBenefit as aF, type Eligible as aG, type BulkCheckBenefitEligibilityRequest as aH, type BenefitSelector as aI, type BulkEligibilityCheckResult as aJ, type GetEligibleBenefitsRequest as aK, type ListPoolsRequest as aL, type ByItemReference as aM, type ByItemReferenceFilter as aN, type Filter as aO, type FilterFilterOneOf as aP, type ListPoolsResponse as aQ, type PoolWithItems as aR, type BulkUpdatePoolsRequest as aS, type MaskedPool as aT, type BulkPoolResult as aU, type ItemMetadata as aV, type ApplicationError as aW, type BulkActionMetadata as aX, type ProvisionPoolsForProgramRequest as aY, type PoolDefinitionLookupId as aZ, type PoolDefinitionLookupIdIdOneOf as a_, type GetPoolRequest as aa, type GetPoolResponse as ab, type UpdatePoolRequest as ac, type UpdatePoolResponse as ad, type DeletePoolRequest as ae, type DeletePoolResponse as af, type QueryPoolsRequest as ag, type CursorQuery as ah, type CursorQueryPagingMethodOneOf as ai, type Sorting as aj, type CursorPaging as ak, type QueryPoolsResponse as al, type CursorPagingMetadata as am, type Cursors as an, type RedeemBenefitRequest as ao, type NotEnoughBalance as ap, type PolicyExpressionEvaluatedToFalse as aq, type FailureDetails as ar, type PoolNotActive as as, type PoolNotFound as at, type BenefitAlreadyRedeemed as au, type BenefitNotFound as av, type ReserveBenefitRequest as aw, type ReserveBenefitResponse as ax, type CancelBenefitReservationRequest as ay, type CancelBenefitReservationResponse as az, type RedeemBenefitResponse as b, type ProvisionPoolsForProgramResponseResultOneOf as b0, type SyncResult as b1, type AsyncResult as b2, type InvalidPoolDefinitionReference as b3, type RenewPoolsForProgramRequest as b4, type RenewPoolsForProgramResponse as b5, type UpdatePoolStatusRequest as b6, type UpdatePoolStatusRequestPoolSelectorOneOf as b7, type ByPoolDefinitionIdAndProgramDefinitionIdOptions as b8, type ByProgramIdOptions as b9, type UpdatePoolStatusResponse as ba, type CountNumberOfPoolsInProvisioningStatusRequest as bb, type CountNumberOfPoolsInProvisioningStatusResponse as bc, type DomainEvent as bd, type DomainEventBodyOneOf as be, type EntityCreatedEvent as bf, type RestoreInfo as bg, type EntityUpdatedEvent as bh, type EntityDeletedEvent as bi, type ActionEvent as bj, type MessageEnvelope as bk, type IdentificationData as bl, type IdentificationDataIdOneOf as bm, type PoolsQueryResult as bn, type CheckBenefitEligibilityResponse as c, type BulkCheckBenefitEligibilityResponse as d, type GetEligibleBenefitsResponse as e, type BulkUpdatePoolsOptions as f, type BulkUpdatePoolsResponse as g, PoolStatus as h, IdentityType as i, PolicyExpressionType as j, RateLimitedPolicyType as k, PoolOrigin as l, ProvisionPoolsForProgramResponseType as m, PoolSelectorType as n, WebhookIdentityType as o, type CommonIdentificationData as p, type CommonIdentificationDataIdOneOf as q, type Benefit as r, type PolicyExpression as s, type PolicyExpressionExpressionOneOf as t, type PolicyExpressionNot as u, type PolicyExpressionAnd as v, type PolicyExpressionOr as w, type Policy as x, type PolicyPolicyOneOf as y, type RateLimitedPolicy as z };
+export { type ActionEvent, type ApplicationError, type AsyncResult, type Benefit, type BenefitAlreadyRedeemed, type BenefitNotFound, type BenefitRedeemed, type BenefitReservationCanceled, type BenefitReservationReleased, type BenefitReserved, type BenefitSelector, type BulkActionMetadata, type BulkCheckBenefitEligibilityOptions, type BulkCheckBenefitEligibilityRequest, type BulkCheckBenefitEligibilityResponse, type BulkEligibilityCheckResult, type BulkPoolResult, type BulkUpdatePoolsOptions, type BulkUpdatePoolsRequest, type BulkUpdatePoolsResponse, type ByItemReference, type ByItemReferenceFilter, type ByPoolDefinitionIdAndProgramDefinitionIdOptions, type ByProgramIdOptions, type CancelBenefitReservationRequest, type CancelBenefitReservationResponse, type CheckBenefitEligibilityOptions, type CheckBenefitEligibilityRequest, type CheckBenefitEligibilityResponse, type CommonIdentificationData, type CommonIdentificationDataIdOneOf, type CountNumberOfPoolsInProvisioningStatusRequest, type CountNumberOfPoolsInProvisioningStatusResponse, type CreatePoolRequest, type CreatePoolResponse, type CreditConfiguration, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomPolicy, type DeletePoolRequest, type DeletePoolResponse, type Details, type DomainEvent, type DomainEventBodyOneOf, type EligibilityCheckResult, type EligibilityCheckResultResultOneOf, EligibilityCheckResultType, type EligibilityCheckResultTypeWithLiterals, type Eligible, type EligibleBenefit, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type FailureDetails, type Filter, type FilterFilterOneOf, type FixedIntervalPolicy, type GetEligibleBenefitsApplicationErrors, type GetEligibleBenefitsOptions, type GetEligibleBenefitsRequest, type GetEligibleBenefitsResponse, type GetPoolRequest, type GetPoolResponse, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type IdentityTypeWithLiterals, type InvalidPoolDefinitionReference, type ItemMetadata, type ItemReference, type ListPoolsRequest, ListPoolsRequestType, type ListPoolsRequestTypeWithLiterals, type ListPoolsResponse, type MaskedPool, type MessageEnvelope, type NotEnoughBalance, type Policy, type PolicyExpression, type PolicyExpressionAnd, type PolicyExpressionEvaluatedToFalse, type PolicyExpressionExpressionOneOf, type PolicyExpressionNot, type PolicyExpressionOr, PolicyExpressionType, type PolicyExpressionTypeWithLiterals, type PolicyPolicyOneOf, type Pool, type PoolDefinitionAndProgramDefinition, type PoolDefinitionLookupId, type PoolDefinitionLookupIdIdOneOf, type PoolEnded, type PoolNotActive, type PoolNotFound, PoolOrigin, type PoolOriginWithLiterals, type PoolPaused, type PoolProgramInfo, type PoolProvisionJobFinished, type PoolProvisioned, type PoolRenewed, type PoolResumed, PoolSelectorType, type PoolSelectorTypeWithLiterals, PoolStatus, type PoolStatusUpdateJobFinished, type PoolStatusUpdateJobFinishedContextOneOf, type PoolStatusWithLiterals, type PoolWithItems, type PoolsQueryBuilder, type PoolsQueryResult, type ProgramDefinitionInfo, type ProgramInfo, type ProvisionPoolsForProgramRequest, type ProvisionPoolsForProgramResponse, type ProvisionPoolsForProgramResponseResultOneOf, ProvisionPoolsForProgramResponseType, type ProvisionPoolsForProgramResponseTypeWithLiterals, type QueryPoolsRequest, type QueryPoolsResponse, type RateLimitedPolicy, type RateLimitedPolicyPeriodOneOf, RateLimitedPolicyType, type RateLimitedPolicyTypeWithLiterals, type RedeemBenefitApplicationErrors, type RedeemBenefitOptions, type RedeemBenefitRequest, type RedeemBenefitResponse, type RedemptionDetails, type ReleaseBenefitReservationRequest, type ReleaseBenefitReservationResponse, type RenewPoolsForProgramRequest, type RenewPoolsForProgramResponse, type ReserveBenefitRequest, type ReserveBenefitResponse, type RestoreInfo, type RolloverConfiguration, SortOrder, type SortOrderWithLiterals, type Sorting, type SyncResult, Type, type TypeWithLiterals, type UpdatePool, type UpdatePoolRequest, type UpdatePoolResponse, type UpdatePoolStatusRequest, type UpdatePoolStatusRequestPoolSelectorOneOf, type UpdatePoolStatusResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeekDay, type WeekDayWithLiterals, bulkCheckBenefitEligibility, bulkUpdatePools, checkBenefitEligibility, getEligibleBenefits, getPool, queryPools, redeemBenefit, updatePool };