@wix/auto_sdk_benefit-programs_pools 1.0.3 → 1.0.5

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

@@ -1,8 +1,8 @@
 import { RequestOptionsFactory } from '@wix/sdk-types';
-/** Retrieves a benefit pool. */
+/** Retrieves a pool. */
 export declare function getPool(payload: object): RequestOptionsFactory<any>;
 /**
- * Updates a benefit pool.
+ * Updates a pool.
  *
  * Each time the pool is updated,
  * `revision` increments by 1.
@@ -14,38 +14,41 @@ export declare function updatePool(payload: object): RequestOptionsFactory<any>;
 /**
  * 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 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()`](/pools/pools-query-builder/find) function.
+ * 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 `queryPools()` returns.
+ * 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.
  *
- * 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`.
+ * 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`.
  */
 export declare function queryPools(payload: object): RequestOptionsFactory<any>;
 /**
- * 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.
+ * Redeems a specified benefit.
  *
- * Upon redemption, a new transaction is created, maintaining balance history for the benefit pool.
+ * 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.
  */
 export declare function redeemBenefit(payload: object): RequestOptionsFactory<any>;
 /**
- * Checks if a benefit can be redeemed based on the current credit status of the benefit pool.
+ * Checks if a benefit can currently be redeemed.
  *
- * Manually verify if their is a sufficient credit balance, and that all policy requirements are met prior to redeeming the benefit.
+ * In order to be a redeemed, a benefit's pool must be active and the associated balance must greater than the cost of the benefit.
  */
 export declare function checkBenefitEligibility(payload: object): RequestOptionsFactory<any>;
 /**
- * Checks if multiple benefits can be redeemed based on the current credit balance of the benefit pool.
+ * Checks if benefits can currently be redeemed.
  *
- * Used to manually check if their is a sufficient credit balance, and that all policy requirements are met prior to redeeming the benefits.
+ * In order to be a redeemed, a benefit's pool must be active and the associated balance must greater than the cost of the benefit. Each benefit is checked independently.
  */
 export declare function bulkCheckBenefitEligibility(payload: object): RequestOptionsFactory<any>;
-/** Retrieve available benefits that can be redeemed based on the current credit balance of the benefit pool. */
+/**
+ * Retrieves benefits that can be redeemed for a specific item.
+ *
+ * Each item can only be linked to 1 benefit in 1 pool definition. However, each pool created from that pool definition contains a benefit with this item.
+ * This method checks each pool containing a benefit with this item, and returns the benefits that can be redeemed.
+ */
 export declare function getEligibleBenefits(payload: object): RequestOptionsFactory<any>;
-/** Updates multiple benefit pools. */
+/** Updates pools. */
 export declare function bulkUpdatePools(payload: object): RequestOptionsFactory<any>;

package/build/cjs/src/benefit-programs-v1-pool-pools.http.js

@@ -175,7 +175,7 @@ function resolveWixBenefitProgramsV1PoolPoolServiceUrl(opts) {
     return (0, rest_modules_2.resolveUrl)(Object.assign(opts, { domainToMappings }));
 }
 const PACKAGE_NAME = '@wix/auto_sdk_benefit-programs_pools';
-/** Retrieves a benefit pool. */
+/** Retrieves a pool. */
 function getPool(payload) {
     function __getPool({ host }) {
         const metadata = {
@@ -202,7 +202,7 @@ function getPool(payload) {
 }
 exports.getPool = getPool;
 /**
- * Updates a benefit pool.
+ * Updates a pool.
  *
  * Each time the pool is updated,
  * `revision` increments by 1.
@@ -248,13 +248,15 @@ exports.updatePool = updatePool;
 /**
  * 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 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()`](/pools/pools-query-builder/find) function.
+ * 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 `queryPools()` returns.
+ * 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.
  *
- * 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`.
+ * 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`.
  */
 function queryPools(payload) {
     function __queryPools({ host }) {
@@ -285,13 +287,9 @@ function queryPools(payload) {
 }
 exports.queryPools = queryPools;
 /**
- * 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.
+ * Redeems a specified benefit.
  *
- * Upon redemption, a new transaction is created, maintaining balance history for the benefit pool.
+ * 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.
  */
 function redeemBenefit(payload) {
     function __redeemBenefit({ host }) {
@@ -319,9 +317,9 @@ function redeemBenefit(payload) {
 }
 exports.redeemBenefit = redeemBenefit;
 /**
- * Checks if a benefit can be redeemed based on the current credit status of the benefit pool.
+ * Checks if a benefit can currently be redeemed.
  *
- * Manually verify if their is a sufficient credit balance, and that all policy requirements are met prior to redeeming the benefit.
+ * In order to be a redeemed, a benefit's pool must be active and the associated balance must greater than the cost of the benefit.
  */
 function checkBenefitEligibility(payload) {
     function __checkBenefitEligibility({ host }) {
@@ -349,9 +347,9 @@ function checkBenefitEligibility(payload) {
 }
 exports.checkBenefitEligibility = checkBenefitEligibility;
 /**
- * Checks if multiple benefits can be redeemed based on the current credit balance of the benefit pool.
+ * Checks if benefits can currently be redeemed.
  *
- * Used to manually check if their is a sufficient credit balance, and that all policy requirements are met prior to redeeming the benefits.
+ * In order to be a redeemed, a benefit's pool must be active and the associated balance must greater than the cost of the benefit. Each benefit is checked independently.
  */
 function bulkCheckBenefitEligibility(payload) {
     function __bulkCheckBenefitEligibility({ host }) {
@@ -384,7 +382,12 @@ function bulkCheckBenefitEligibility(payload) {
     return __bulkCheckBenefitEligibility;
 }
 exports.bulkCheckBenefitEligibility = bulkCheckBenefitEligibility;
-/** Retrieve available benefits that can be redeemed based on the current credit balance of the benefit pool. */
+/**
+ * Retrieves benefits that can be redeemed for a specific item.
+ *
+ * Each item can only be linked to 1 benefit in 1 pool definition. However, each pool created from that pool definition contains a benefit with this item.
+ * This method checks each pool containing a benefit with this item, and returns the benefits that can be redeemed.
+ */
 function getEligibleBenefits(payload) {
     function __getEligibleBenefits({ host }) {
         const serializedData = (0, transform_paths_1.transformPaths)(payload, [
@@ -410,7 +413,7 @@ function getEligibleBenefits(payload) {
     return __getEligibleBenefits;
 }
 exports.getEligibleBenefits = getEligibleBenefits;
-/** Updates multiple benefit pools. */
+/** Updates pools. */
 function bulkUpdatePools(payload) {
     function __bulkUpdatePools({ host }) {
         const serializedData = (0, transform_paths_1.transformPaths)(payload, [

package/build/cjs/src/benefit-programs-v1-pool-pools.http.js.map

@@ -1 +1 @@
-{"version":3,"file":"benefit-programs-v1-pool-pools.http.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-pool-pools.http.ts"],"names":[],"mappings":";;;AAAA,gEAAkE;AAClE,0EAAkG;AAClG,0EAAkG;AAClG,4EAAmG;AACnG,sFAAkF;AAClF,gEAA2D;AAI3D,SAAS,6CAA6C,CACpD,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,QAAQ;gBACjB,QAAQ,EAAE,EAAE;aACb;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,yCAAyC;gBAClD,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,sCAAsC;gBAC/C,QAAQ,EAAE,gBAAgB;aAC3B;YACD;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,WAAW;aACtB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,yCAAyC;gBAClD,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,sCAAsC;gBAC/C,QAAQ,EAAE,gBAAgB;aAC3B;YACD;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,WAAW;aACtB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,yCAAyC;gBAClD,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,sCAAsC;gBAC/C,QAAQ,EAAE,gBAAgB;aAC3B;YACD;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,WAAW;aACtB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,yCAAyC;gBAClD,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,sCAAsC;gBAC/C,QAAQ,EAAE,gBAAgB;aAC3B;YACD;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,WAAW;aACtB;SACF;QACD,gBAAgB,EAAE;YAChB;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,yCAAyC;gBAClD,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,sCAAsC;gBAC/C,QAAQ,EAAE,gBAAgB;aAC3B;YACD;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,WAAW;aACtB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,yCAAyC;gBAClD,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,sCAAsC;gBAC/C,QAAQ,EAAE,gBAAgB;aAC3B;YACD;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,WAAW;aACtB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,yCAAyC;gBAClD,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,sCAAsC;gBAC/C,QAAQ,EAAE,gBAAgB;aAC3B;YACD;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,WAAW;aACtB;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,yBAAyB;gBAClC,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,yCAAyC;gBAClD,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,sCAAsC;gBAC/C,QAAQ,EAAE,gBAAgB;aAC3B;YACD;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,WAAW;aACtB;SACF;KACF,CAAC;IAEF,OAAO,IAAA,yBAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,YAAY,GAAG,sCAAsC,CAAC;AAE5D,gCAAgC;AAChC,SAAgB,OAAO,CAAC,OAAe;IACrC,SAAS,SAAS,CAAC,EAAE,IAAI,EAAO;QAC9B,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,8BAA8B;YAC1C,MAAM,EAAE,KAAY;YACpB,SAAS,EAAE,kDAAkD;YAC7D,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,6CAA6C,CAAC;gBACjD,SAAS,EAAE,oBAAoB;gBAC/B,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;YAClC,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,EAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC;iBACpE;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AA1BD,0BA0BC;AAED;;;;;;;;GAQG;AACH,SAAgB,UAAU,CAAC,OAAe;IACxC,SAAS,YAAY,CAAC,EAAE,IAAI,EAAO;QACjC,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,iDAAoC;gBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;aAC/B;YACD;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,EAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC;aACpE;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,8BAA8B;YAC1C,MAAM,EAAE,OAAc;YACtB,SAAS,EAAE,qDAAqD;YAChE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,6CAA6C,CAAC;gBACjD,SAAS,EAAE,qBAAqB;gBAChC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,EAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC;iBACpE;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AApCD,gCAoCC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,UAAU,CAAC,OAAe;IACxC,SAAS,YAAY,CAAC,EAAE,IAAI,EAAO;QACjC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,8BAA8B;YAC1C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,qDAAqD;YAChE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,6CAA6C,CAAC;gBACjD,SAAS,EAAE,iBAAiB;gBAC5B,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;YACb,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,mBAAmB,EAAE;wBAC7B,EAAE,IAAI,EAAE,mBAAmB,EAAE;qBAC9B;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AA7BD,gCA6BC;AAED;;;;;;;;GAQG;AACH,SAAgB,aAAa,CAAC,OAAe;IAC3C,SAAS,eAAe,CAAC,EAAE,IAAI,EAAO;QACpC,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;aAChC;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,8BAA8B;YAC1C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,wDAAwD;YACnE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,6CAA6C,CAAC;gBACjD,SAAS,EAAE,qBAAqB;gBAChC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;SACrB,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AAzBD,sCAyBC;AAED;;;;GAIG;AACH,SAAgB,uBAAuB,CACrC,OAAe;IAEf,SAAS,yBAAyB,CAAC,EAAE,IAAI,EAAO;QAC9C,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;aAChC;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,8BAA8B;YAC1C,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,kEAAkE;YACpE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,6CAA6C,CAAC;gBACjD,SAAS,EAAE,6BAA6B;gBACxC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;SACrB,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,yBAAyB,CAAC;AACnC,CAAC;AA5BD,0DA4BC;AAED;;;;GAIG;AACH,SAAgB,2BAA2B,CACzC,OAAe;IAEf,SAAS,6BAA6B,CAAC,EAAE,IAAI,EAAO;QAClD,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,6BAA6B,EAAE,CAAC;aACjD;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,8BAA8B;YAC1C,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,sEAAsE;YACxE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,6CAA6C,CAAC;gBACjD,SAAS,EAAE,qCAAqC;gBAChD,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,oCAAoC,EAAE,CAAC;iBACxD;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,6BAA6B,CAAC;AACvC,CAAC;AAnCD,kEAmCC;AAED,gHAAgH;AAChH,SAAgB,mBAAmB,CACjC,OAAe;IAEf,SAAS,qBAAqB,CAAC,EAAE,IAAI,EAAO;QAC1C,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;aAChC;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,8BAA8B;YAC1C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,8DAA8D;YACzE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,6CAA6C,CAAC;gBACjD,SAAS,EAAE,0BAA0B;gBACrC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;SACrB,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AA3BD,kDA2BC;AAED,sCAAsC;AACtC,SAAgB,eAAe,CAAC,OAAe;IAC7C,SAAS,iBAAiB,CAAC,EAAE,IAAI,EAAO;QACtC,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,iDAAoC;gBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC;aACrC;YACD;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE;oBACL,EAAE,IAAI,EAAE,wBAAwB,EAAE;oBAClC,EAAE,IAAI,EAAE,wBAAwB,EAAE;iBACnC;aACF;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,8BAA8B;YAC1C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,0DAA0D;YACrE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,6CAA6C,CAAC;gBACjD,SAAS,EAAE,gBAAgB;gBAC3B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,0BAA0B,EAAE;wBACpC,EAAE,IAAI,EAAE,0BAA0B,EAAE;qBACrC;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AA1CD,0CA0CC"}
+{"version":3,"file":"benefit-programs-v1-pool-pools.http.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-pool-pools.http.ts"],"names":[],"mappings":";;;AAAA,gEAAkE;AAClE,0EAAkG;AAClG,0EAAkG;AAClG,4EAAmG;AACnG,sFAAkF;AAClF,gEAA2D;AAI3D,SAAS,6CAA6C,CACpD,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,QAAQ;gBACjB,QAAQ,EAAE,EAAE;aACb;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,yCAAyC;gBAClD,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,sCAAsC;gBAC/C,QAAQ,EAAE,gBAAgB;aAC3B;YACD;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,WAAW;aACtB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,yCAAyC;gBAClD,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,sCAAsC;gBAC/C,QAAQ,EAAE,gBAAgB;aAC3B;YACD;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,WAAW;aACtB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,yCAAyC;gBAClD,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,sCAAsC;gBAC/C,QAAQ,EAAE,gBAAgB;aAC3B;YACD;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,WAAW;aACtB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,yCAAyC;gBAClD,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,sCAAsC;gBAC/C,QAAQ,EAAE,gBAAgB;aAC3B;YACD;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,WAAW;aACtB;SACF;QACD,gBAAgB,EAAE;YAChB;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,yCAAyC;gBAClD,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,sCAAsC;gBAC/C,QAAQ,EAAE,gBAAgB;aAC3B;YACD;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,WAAW;aACtB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,yCAAyC;gBAClD,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,sCAAsC;gBAC/C,QAAQ,EAAE,gBAAgB;aAC3B;YACD;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,WAAW;aACtB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,yCAAyC;gBAClD,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,sCAAsC;gBAC/C,QAAQ,EAAE,gBAAgB;aAC3B;YACD;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,WAAW;aACtB;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,yBAAyB;gBAClC,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,yCAAyC;gBAClD,QAAQ,EAAE,mBAAmB;aAC9B;YACD;gBACE,OAAO,EAAE,sCAAsC;gBAC/C,QAAQ,EAAE,gBAAgB;aAC3B;YACD;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,WAAW;aACtB;SACF;KACF,CAAC;IAEF,OAAO,IAAA,yBAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,YAAY,GAAG,sCAAsC,CAAC;AAE5D,wBAAwB;AACxB,SAAgB,OAAO,CAAC,OAAe;IACrC,SAAS,SAAS,CAAC,EAAE,IAAI,EAAO;QAC9B,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,8BAA8B;YAC1C,MAAM,EAAE,KAAY;YACpB,SAAS,EAAE,kDAAkD;YAC7D,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,6CAA6C,CAAC;gBACjD,SAAS,EAAE,oBAAoB;gBAC/B,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;YAClC,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,EAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC;iBACpE;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AA1BD,0BA0BC;AAED;;;;;;;;GAQG;AACH,SAAgB,UAAU,CAAC,OAAe;IACxC,SAAS,YAAY,CAAC,EAAE,IAAI,EAAO;QACjC,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,iDAAoC;gBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;aAC/B;YACD;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,EAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC;aACpE;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,8BAA8B;YAC1C,MAAM,EAAE,OAAc;YACtB,SAAS,EAAE,qDAAqD;YAChE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,6CAA6C,CAAC;gBACjD,SAAS,EAAE,qBAAqB;gBAChC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,EAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC;iBACpE;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AApCD,gCAoCC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,UAAU,CAAC,OAAe;IACxC,SAAS,YAAY,CAAC,EAAE,IAAI,EAAO;QACjC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,8BAA8B;YAC1C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,qDAAqD;YAChE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,6CAA6C,CAAC;gBACjD,SAAS,EAAE,iBAAiB;gBAC5B,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;YACb,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,mBAAmB,EAAE;wBAC7B,EAAE,IAAI,EAAE,mBAAmB,EAAE;qBAC9B;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AA7BD,gCA6BC;AAED;;;;GAIG;AACH,SAAgB,aAAa,CAAC,OAAe;IAC3C,SAAS,eAAe,CAAC,EAAE,IAAI,EAAO;QACpC,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;aAChC;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,8BAA8B;YAC1C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,wDAAwD;YACnE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,6CAA6C,CAAC;gBACjD,SAAS,EAAE,qBAAqB;gBAChC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;SACrB,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AAzBD,sCAyBC;AAED;;;;GAIG;AACH,SAAgB,uBAAuB,CACrC,OAAe;IAEf,SAAS,yBAAyB,CAAC,EAAE,IAAI,EAAO;QAC9C,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;aAChC;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,8BAA8B;YAC1C,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,kEAAkE;YACpE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,6CAA6C,CAAC;gBACjD,SAAS,EAAE,6BAA6B;gBACxC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;SACrB,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,yBAAyB,CAAC;AACnC,CAAC;AA5BD,0DA4BC;AAED;;;;GAIG;AACH,SAAgB,2BAA2B,CACzC,OAAe;IAEf,SAAS,6BAA6B,CAAC,EAAE,IAAI,EAAO;QAClD,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,6BAA6B,EAAE,CAAC;aACjD;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,8BAA8B;YAC1C,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,sEAAsE;YACxE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,6CAA6C,CAAC;gBACjD,SAAS,EAAE,qCAAqC;gBAChD,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,oCAAoC,EAAE,CAAC;iBACxD;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,6BAA6B,CAAC;AACvC,CAAC;AAnCD,kEAmCC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CACjC,OAAe;IAEf,SAAS,qBAAqB,CAAC,EAAE,IAAI,EAAO;QAC1C,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;aAChC;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,8BAA8B;YAC1C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,8DAA8D;YACzE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,6CAA6C,CAAC;gBACjD,SAAS,EAAE,0BAA0B;gBACrC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;SACrB,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AA3BD,kDA2BC;AAED,qBAAqB;AACrB,SAAgB,eAAe,CAAC,OAAe;IAC7C,SAAS,iBAAiB,CAAC,EAAE,IAAI,EAAO;QACtC,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,iDAAoC;gBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC;aACrC;YACD;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE;oBACL,EAAE,IAAI,EAAE,wBAAwB,EAAE;oBAClC,EAAE,IAAI,EAAE,wBAAwB,EAAE;iBACnC;aACF;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,8BAA8B;YAC1C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,0DAA0D;YACrE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,6CAA6C,CAAC;gBACjD,SAAS,EAAE,gBAAgB;gBAC3B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,0BAA0B,EAAE;wBACpC,EAAE,IAAI,EAAE,0BAA0B,EAAE;qBACrC;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AA1CD,0CA0CC"}

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

@@ -6,7 +6,7 @@ export declare const __metadata: {
 export declare function getPool(httpClient: HttpClient): GetPoolSignature;
 interface GetPoolSignature {
     /**
-     * Retrieves a benefit pool.
+     * Retrieves a pool.
      * @param - ID of the pool to retrieve.
      * @returns Retrieved pool.
      */
@@ -15,7 +15,7 @@ interface GetPoolSignature {
 export declare function updatePool(httpClient: HttpClient): UpdatePoolSignature;
 interface UpdatePoolSignature {
     /**
-     * Updates a benefit pool.
+     * Updates a pool.
      *
      * Each time the pool is updated,
      * `revision` increments by 1.
@@ -32,61 +32,62 @@ 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 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()`](/pools/pools-query-builder/find) function.
+     * 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 `queryPools()` returns.
+     * 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.
      *
-     * 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`.
+     * 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;
 }
 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.
+     * Redeems a specified benefit.
      *
-     * 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.
+     * 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 benefit to redeem belongs to.
      */
     (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.
+     * Checks if a benefit can currently be redeemed.
      *
-     * 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.
+     * In order to be a redeemed, a benefit's pool must be active and the associated balance must 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 & 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.
+     * Checks if benefits can currently be redeemed.
      *
-     * Used to manually check if their is a sufficient credit balance, and that all policy requirements are met prior to redeeming the benefits.
+     * In order to be a redeemed, a benefit's pool must be active and the associated balance must greater than the cost of the benefit. Each benefit is checked independently.
      */
     (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.
+     * Retrieves benefits that can be redeemed for a specific item.
+     *
+     * Each item can only be linked to 1 benefit in 1 pool definition. However, each pool created from that pool definition contains a benefit with this item.
+     * This method checks each pool containing a benefit with this item, and returns the benefits that can be redeemed.
+     * @param - Item reference.
      */
     (itemReference: ItemReference, options?: GetEligibleBenefitsOptions | undefined): Promise<GetEligibleBenefitsResponse & GetEligibleBenefitsResponseNonNullableFields>;
 }
 export declare function bulkUpdatePools(httpClient: HttpClient): BulkUpdatePoolsSignature;
 interface BulkUpdatePoolsSignature {
     /**
-     * Updates multiple benefit pools.
+     * Updates pools.
      */
     (options?: BulkUpdatePoolsOptions | undefined): Promise<BulkUpdatePoolsResponse & BulkUpdatePoolsResponseNonNullableFields>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"benefit-programs-v1-pool-pools.public.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-pool-pools.public.ts"],"names":[],"mappings":";;;AACA,+GA6BuD;AAE1C,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,uBAAuB,EAAE,CAAC;AAEpE,SAAgB,OAAO,CAAC,UAAsB;IAC5C,OAAO,CAAC,MAAc,EAAE,EAAE,CACxB,IAAA,qDAAgB,EACd,MAAM;IACN,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,0BAOC;AAWD,SAAgB,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,GAAkB,EAAE,IAAgB,EAAE,EAAE,CAC9C,IAAA,wDAAmB,EACjB,GAAG,EACH,IAAI;IACJ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,gCAQC;AAiBD,SAAgB,UAAU,CAAC,UAAsB;IAC/C,OAAO,GAAG,EAAE,CACV,IAAA,wDAAmB;IACjB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAND,gCAMC;AAiBD,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,CAAC,MAAc,EAAE,OAA8B,EAAE,EAAE,CACxD,IAAA,2DAAsB,EACpB,MAAM,EACN,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,sCAQC;AAkBD,SAAgB,uBAAuB,CACrC,UAAsB;IAEtB,OAAO,CAAC,MAAc,EAAE,OAAwC,EAAE,EAAE,CAClE,IAAA,qEAAgC,EAC9B,MAAM,EACN,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAVD,0DAUC;AAkBD,SAAgB,2BAA2B,CACzC,UAAsB;IAEtB,OAAO,CAAC,OAA4C,EAAE,EAAE,CACtD,IAAA,yEAAoC,EAClC,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,kEASC;AAcD,SAAgB,mBAAmB,CACjC,UAAsB;IAEtB,OAAO,CAAC,aAA4B,EAAE,OAAoC,EAAE,EAAE,CAC5E,IAAA,iEAA4B,EAC1B,aAAa,EACb,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAVD,kDAUC;AAeD,SAAgB,eAAe,CAC7B,UAAsB;IAEtB,OAAO,CAAC,OAAgC,EAAE,EAAE,CAC1C,IAAA,6DAAwB,EACtB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,0CASC;AAWD,6GAwJuD;AAnGrD,yJAAA,0BAA0B,OAAA;AAoB1B,2IAAA,YAAY,OAAA;AAKZ,mJAAA,oBAAoB,OAAA;AAYpB,mJAAA,oBAAoB,OAAA;AAUpB,yIAAA,UAAU,OAAA;AAOV,+IAAA,gBAAgB,OAAA;AAChB,yIAAA,UAAU,OAAA;AAWV,mKAAA,oCAAoC,OAAA;AAMpC,oJAAA,qBAAqB,OAAA;AAcrB,wIAAA,SAAS,OAAA;AAGT,mIAAA,IAAI,OAAA;AAQJ,kJAAA,mBAAmB,OAAA;AACnB,sIAAA,OAAO,OAAA"}
+{"version":3,"file":"benefit-programs-v1-pool-pools.public.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-pool-pools.public.ts"],"names":[],"mappings":";;;AACA,+GA6BuD;AAE1C,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,uBAAuB,EAAE,CAAC;AAEpE,SAAgB,OAAO,CAAC,UAAsB;IAC5C,OAAO,CAAC,MAAc,EAAE,EAAE,CACxB,IAAA,qDAAgB,EACd,MAAM;IACN,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,0BAOC;AAWD,SAAgB,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,GAAkB,EAAE,IAAgB,EAAE,EAAE,CAC9C,IAAA,wDAAmB,EACjB,GAAG,EACH,IAAI;IACJ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,gCAQC;AAiBD,SAAgB,UAAU,CAAC,UAAsB;IAC/C,OAAO,GAAG,EAAE,CACV,IAAA,wDAAmB;IACjB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAND,gCAMC;AAmBD,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,CAAC,MAAc,EAAE,OAA8B,EAAE,EAAE,CACxD,IAAA,2DAAsB,EACpB,MAAM,EACN,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,sCAQC;AAcD,SAAgB,uBAAuB,CACrC,UAAsB;IAEtB,OAAO,CAAC,MAAc,EAAE,OAAwC,EAAE,EAAE,CAClE,IAAA,qEAAgC,EAC9B,MAAM,EACN,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAVD,0DAUC;AAkBD,SAAgB,2BAA2B,CACzC,UAAsB;IAEtB,OAAO,CAAC,OAA4C,EAAE,EAAE,CACtD,IAAA,yEAAoC,EAClC,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,kEASC;AAcD,SAAgB,mBAAmB,CACjC,UAAsB;IAEtB,OAAO,CAAC,aAA4B,EAAE,OAAoC,EAAE,EAAE,CAC5E,IAAA,iEAA4B,EAC1B,aAAa,EACb,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAVD,kDAUC;AAkBD,SAAgB,eAAe,CAC7B,UAAsB;IAEtB,OAAO,CAAC,OAAgC,EAAE,EAAE,CAC1C,IAAA,6DAAwB,EACtB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,0CASC;AAWD,6GAwJuD;AAnGrD,yJAAA,0BAA0B,OAAA;AAoB1B,2IAAA,YAAY,OAAA;AAKZ,mJAAA,oBAAoB,OAAA;AAYpB,mJAAA,oBAAoB,OAAA;AAUpB,yIAAA,UAAU,OAAA;AAOV,+IAAA,gBAAgB,OAAA;AAChB,yIAAA,UAAU,OAAA;AAWV,mKAAA,oCAAoC,OAAA;AAMpC,oJAAA,qBAAqB,OAAA;AAcrB,wIAAA,SAAS,OAAA;AAGT,mIAAA,IAAI,OAAA;AAQJ,kJAAA,mBAAmB,OAAA;AACnB,sIAAA,OAAO,OAAA"}