@wix/auto_sdk_benefit-programs_pools 1.0.0

package/build/es/src/benefit-programs-v1-pool-pools.public.d.ts

@@ -0,0 +1,93 @@
+import { HttpClient } from '@wix/sdk-types';
+import { BulkCheckBenefitEligibilityOptions, BulkCheckBenefitEligibilityResponse, BulkCheckBenefitEligibilityResponseNonNullableFields, BulkUpdatePoolsOptions, BulkUpdatePoolsResponse, BulkUpdatePoolsResponseNonNullableFields, CheckBenefitEligibilityOptions, CheckBenefitEligibilityResponse, CheckBenefitEligibilityResponseNonNullableFields, GetEligibleBenefitsOptions, GetEligibleBenefitsResponse, GetEligibleBenefitsResponseNonNullableFields, ItemReference, Pool, PoolNonNullableFields, PoolsQueryBuilder, RedeemBenefitOptions, RedeemBenefitResponse, RedeemBenefitResponseNonNullableFields, UpdatePool } from './benefit-programs-v1-pool-pools.universal.js';
+export declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+export declare function getPool(httpClient: HttpClient): GetPoolSignature;
+interface GetPoolSignature {
+    /**
+     * Retrieves a benefit pool.
+     * @param - ID of the pool to retrieve.
+     * @returns Retrieved pool.
+     */
+    (poolId: string): Promise<Pool & PoolNonNullableFields>;
+}
+export declare function updatePool(httpClient: HttpClient): UpdatePoolSignature;
+interface UpdatePoolSignature {
+    /**
+     * Updates a benefit 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 | null, pool: UpdatePool): Promise<Pool & PoolNonNullableFields>;
+}
+export declare function queryPools(httpClient: HttpClient): QueryPoolsSignature;
+interface QueryPoolsSignature {
+    /**
+     * Creates a query to retrieve a list of pools.
+     *
+     * The `queryPools()` 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()`](/pools/pools-query-builder/find) function.
+     *
+     * You can refine the query by chaining `PoolsQueryBuilder` methods onto the query. `PoolsQueryBuilder` methods enable you to filter, sort, and control the results that `queryPools()` returns.
+     *
+     * The following `PoolsQueryBuilder` functions are supported for `queryPools()`. For a full description of the pool object, see the object returned for the [`items`](/pools/pools-query-result/items) property in `PoolsQueryResult`.
+     */
+    (): PoolsQueryBuilder;
+}
+export declare function redeemBenefit(httpClient: HttpClient): RedeemBenefitSignature;
+interface RedeemBenefitSignature {
+    /**
+     * Redeems a benefit by the pool owner in exchange for available credits from the benefit pool.
+     *
+     * The mechanism of purchasing specified benefit items.
+     *
+     * Benefit redemption adjusts the available credits in the pool's balance to reflect the new balance after the transaction.
+     *
+     * Upon redemption, a new transaction is created, maintaining balance history for the benefit pool.
+     * @param - ID of the benefit pool being redeemed.
+     */
+    (poolId: string, options?: RedeemBenefitOptions | undefined): Promise<RedeemBenefitResponse & RedeemBenefitResponseNonNullableFields>;
+}
+export declare function checkBenefitEligibility(httpClient: HttpClient): CheckBenefitEligibilitySignature;
+interface CheckBenefitEligibilitySignature {
+    /**
+     * Checks if a benefit can be redeemed based on the current credit status of the benefit pool.
+     *
+     * Manually verify if their is a sufficient credit balance, and that all policy requirements are met prior to redeeming the benefit.
+     * @param - ID of the benefit pool to check eligibility against.
+     */
+    (poolId: string, options?: CheckBenefitEligibilityOptions | undefined): Promise<CheckBenefitEligibilityResponse & CheckBenefitEligibilityResponseNonNullableFields>;
+}
+export declare function bulkCheckBenefitEligibility(httpClient: HttpClient): BulkCheckBenefitEligibilitySignature;
+interface BulkCheckBenefitEligibilitySignature {
+    /**
+     * Checks if multiple benefits can be redeemed based on the current credit balance of the benefit pool.
+     *
+     * Used to manually check if their is a sufficient credit balance, and that all policy requirements are met prior to redeeming the benefits.
+     */
+    (options?: BulkCheckBenefitEligibilityOptions | undefined): Promise<BulkCheckBenefitEligibilityResponse & BulkCheckBenefitEligibilityResponseNonNullableFields>;
+}
+export declare function getEligibleBenefits(httpClient: HttpClient): GetEligibleBenefitsSignature;
+interface GetEligibleBenefitsSignature {
+    /**
+     * Retrieve available benefits that can be redeemed based on the current credit balance of the benefit pool.
+     * @param - Reference of the item for which all eligible pools will be returned.
+     */
+    (itemReference: ItemReference, options?: GetEligibleBenefitsOptions | undefined): Promise<GetEligibleBenefitsResponse & GetEligibleBenefitsResponseNonNullableFields>;
+}
+export declare function bulkUpdatePools(httpClient: HttpClient): BulkUpdatePoolsSignature;
+interface BulkUpdatePoolsSignature {
+    /**
+     * Updates multiple benefit pools.
+     */
+    (options?: BulkUpdatePoolsOptions | undefined): Promise<BulkUpdatePoolsResponse & BulkUpdatePoolsResponseNonNullableFields>;
+}
+export { ActionEvent, ApplicationError, AsyncResult, Benefit, BenefitAlreadyRedeemed, BenefitNotFound, BenefitRedeemed, BenefitReservationCanceled, BenefitReservationReleased, BenefitReserved, BenefitSelector, BulkActionMetadata, BulkCheckBenefitEligibilityOptions, BulkCheckBenefitEligibilityRequest, BulkCheckBenefitEligibilityResponse, BulkCheckBenefitEligibilityResponseNonNullableFields, BulkEligibilityCheckResult, BulkPoolResult, BulkUpdatePoolsOptions, BulkUpdatePoolsRequest, BulkUpdatePoolsResponse, BulkUpdatePoolsResponseNonNullableFields, ByItemReference, ByItemReferenceFilter, ByPoolDefinitionIdAndProgramDefinitionIdOptions, ByProgramIdOptions, CancelBenefitReservationRequest, CancelBenefitReservationResponse, CheckBenefitEligibilityOptions, CheckBenefitEligibilityRequest, CheckBenefitEligibilityResponse, CheckBenefitEligibilityResponseNonNullableFields, CommonIdentificationData, CommonIdentificationDataIdOneOf, CountNumberOfPoolsInProvisioningStatusRequest, CountNumberOfPoolsInProvisioningStatusResponse, CreatePoolRequest, CreatePoolResponse, CreditConfiguration, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, CustomPolicy, DeletePoolRequest, DeletePoolResponse, Details, DomainEvent, DomainEventBodyOneOf, EligibilityCheckResult, EligibilityCheckResultResultOneOf, EligibilityCheckResultType, Eligible, EligibleBenefit, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, ExtendedFields, FailureDetails, Filter, FilterFilterOneOf, FixedIntervalPolicy, GetEligibleBenefitsOptions, GetEligibleBenefitsRequest, GetEligibleBenefitsResponse, GetEligibleBenefitsResponseNonNullableFields, GetPoolRequest, GetPoolResponse, GetPoolResponseNonNullableFields, IdentificationData, IdentificationDataIdOneOf, IdentityType, InvalidPoolDefinitionReference, ItemMetadata, ItemReference, ListPoolsRequest, ListPoolsRequestType, ListPoolsResponse, MaskedPool, MessageEnvelope, NotEnoughBalance, Policy, PolicyExpression, PolicyExpressionAnd, PolicyExpressionEvaluatedToFalse, PolicyExpressionExpressionOneOf, PolicyExpressionNot, PolicyExpressionOr, PolicyExpressionType, PolicyPolicyOneOf, Pool, PoolDefinitionLookupId, PoolDefinitionLookupIdIdOneOf, PoolEnded, PoolNonNullableFields, PoolNotActive, PoolNotFound, PoolOrigin, PoolPaused, PoolProvisioned, PoolRenewed, PoolResumed, PoolSelectorType, PoolStatus, PoolWithItems, PoolsQueryBuilder, PoolsQueryResult, ProgramDefinitionInfo, ProgramInfo, ProvisionPoolsForProgramRequest, ProvisionPoolsForProgramResponse, ProvisionPoolsForProgramResponseResultOneOf, ProvisionPoolsForProgramResponseType, QueryPoolsRequest, QueryPoolsResponse, QueryPoolsResponseNonNullableFields, RateLimitedPolicy, RateLimitedPolicyPeriodOneOf, RateLimitedPolicyType, RedeemBenefitOptions, RedeemBenefitRequest, RedeemBenefitResponse, RedeemBenefitResponseNonNullableFields, RedemptionDetails, ReleaseBenefitReservationRequest, ReleaseBenefitReservationResponse, RenewPoolsForProgramRequest, RenewPoolsForProgramResponse, ReserveBenefitRequest, ReserveBenefitResponse, RestoreInfo, RolloverConfiguration, SortOrder, Sorting, SyncResult, Type, UpdatePool, UpdatePoolRequest, UpdatePoolResponse, UpdatePoolResponseNonNullableFields, UpdatePoolStatusRequest, UpdatePoolStatusRequestPoolSelectorOneOf, UpdatePoolStatusResponse, WebhookIdentityType, WeekDay, } from './benefit-programs-v1-pool-pools.universal.js';

package/build/es/src/benefit-programs-v1-pool-pools.public.js

@@ -0,0 +1,44 @@
+import { bulkCheckBenefitEligibility as universalBulkCheckBenefitEligibility, bulkUpdatePools as universalBulkUpdatePools, checkBenefitEligibility as universalCheckBenefitEligibility, getEligibleBenefits as universalGetEligibleBenefits, getPool as universalGetPool, queryPools as universalQueryPools, redeemBenefit as universalRedeemBenefit, updatePool as universalUpdatePool, } from './benefit-programs-v1-pool-pools.universal.js';
+export const __metadata = { PACKAGE_NAME: '@wix/benefit-programs' };
+export function getPool(httpClient) {
+    return (poolId) => universalGetPool(poolId, 
+    // @ts-ignore
+    { httpClient });
+}
+export function updatePool(httpClient) {
+    return (_id, pool) => universalUpdatePool(_id, pool, 
+    // @ts-ignore
+    { httpClient });
+}
+export function queryPools(httpClient) {
+    return () => universalQueryPools(
+    // @ts-ignore
+    { httpClient });
+}
+export function redeemBenefit(httpClient) {
+    return (poolId, options) => universalRedeemBenefit(poolId, options, 
+    // @ts-ignore
+    { httpClient });
+}
+export function checkBenefitEligibility(httpClient) {
+    return (poolId, options) => universalCheckBenefitEligibility(poolId, options, 
+    // @ts-ignore
+    { httpClient });
+}
+export function bulkCheckBenefitEligibility(httpClient) {
+    return (options) => universalBulkCheckBenefitEligibility(options, 
+    // @ts-ignore
+    { httpClient });
+}
+export function getEligibleBenefits(httpClient) {
+    return (itemReference, options) => universalGetEligibleBenefits(itemReference, options, 
+    // @ts-ignore
+    { httpClient });
+}
+export function bulkUpdatePools(httpClient) {
+    return (options) => universalBulkUpdatePools(options, 
+    // @ts-ignore
+    { httpClient });
+}
+export { EligibilityCheckResultType, IdentityType, ListPoolsRequestType, PolicyExpressionType, PoolOrigin, PoolSelectorType, PoolStatus, ProvisionPoolsForProgramResponseType, RateLimitedPolicyType, SortOrder, Type, WebhookIdentityType, WeekDay, } from './benefit-programs-v1-pool-pools.universal.js';
+//# sourceMappingURL=benefit-programs-v1-pool-pools.public.js.map

package/build/es/src/benefit-programs-v1-pool-pools.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"benefit-programs-v1-pool-pools.public.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-pool-pools.public.ts"],"names":[],"mappings":"AACA,OAAO,EAqBL,2BAA2B,IAAI,oCAAoC,EACnE,eAAe,IAAI,wBAAwB,EAC3C,uBAAuB,IAAI,gCAAgC,EAC3D,mBAAmB,IAAI,4BAA4B,EACnD,OAAO,IAAI,gBAAgB,EAC3B,UAAU,IAAI,mBAAmB,EACjC,aAAa,IAAI,sBAAsB,EACvC,UAAU,IAAI,mBAAmB,GAClC,MAAM,+CAA+C,CAAC;AAEvD,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,uBAAuB,EAAE,CAAC;AAEpE,MAAM,UAAU,OAAO,CAAC,UAAsB;IAC5C,OAAO,CAAC,MAAc,EAAE,EAAE,CACxB,gBAAgB,CACd,MAAM;IACN,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAWD,MAAM,UAAU,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,GAAkB,EAAE,IAAgB,EAAE,EAAE,CAC9C,mBAAmB,CACjB,GAAG,EACH,IAAI;IACJ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAiBD,MAAM,UAAU,UAAU,CAAC,UAAsB;IAC/C,OAAO,GAAG,EAAE,CACV,mBAAmB;IACjB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAiBD,MAAM,UAAU,aAAa,CAAC,UAAsB;IAClD,OAAO,CAAC,MAAc,EAAE,OAA8B,EAAE,EAAE,CACxD,sBAAsB,CACpB,MAAM,EACN,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAkBD,MAAM,UAAU,uBAAuB,CACrC,UAAsB;IAEtB,OAAO,CAAC,MAAc,EAAE,OAAwC,EAAE,EAAE,CAClE,gCAAgC,CAC9B,MAAM,EACN,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAkBD,MAAM,UAAU,2BAA2B,CACzC,UAAsB;IAEtB,OAAO,CAAC,OAA4C,EAAE,EAAE,CACtD,oCAAoC,CAClC,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAcD,MAAM,UAAU,mBAAmB,CACjC,UAAsB;IAEtB,OAAO,CAAC,aAA4B,EAAE,OAAoC,EAAE,EAAE,CAC5E,4BAA4B,CAC1B,aAAa,EACb,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAeD,MAAM,UAAU,eAAe,CAC7B,UAAsB;IAEtB,OAAO,CAAC,OAAgC,EAAE,EAAE,CAC1C,wBAAwB,CACtB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAWD,OAAO,EAqDL,0BAA0B,EAoB1B,YAAY,EAKZ,oBAAoB,EAYpB,oBAAoB,EASpB,UAAU,EAKV,gBAAgB,EAChB,UAAU,EASV,oCAAoC,EAMpC,qBAAqB,EAcrB,SAAS,EAGT,IAAI,EAQJ,mBAAmB,EACnB,OAAO,GACR,MAAM,+CAA+C,CAAC"}