@wix/auto_sdk_benefit-programs_pools 1.0.67 → 1.0.68

package/build/es/index.typings.d.mts

@@ -1621,10 +1621,14 @@ interface CheckEligibilityByFilterRequest {
     additionalData?: Record<string, any> | null;
 }
 interface PoolFilter {
-    /** Filter options. To learn more, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
+    /**
+     * Filter object. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more information.
+     *
+     * For supported filterable and sortable fields, see [Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/pools/filtering-and-sorting).
+     */
     filter?: Record<string, any> | null;
     /**
-     * List of sort objects.
+     * Sorting to apply to the matched pools. Determines the order of the returned results, and which results are kept when more than 100 are produced.
      * @maxSize 5
      */
     sort?: Sorting[];
@@ -1637,6 +1641,50 @@ interface CheckEligibilityByFilterResponse {
      */
     result?: EligibilityCheckResult[];
 }
+interface CheckBenefitEligibilityByFilterRequest {
+    /**
+     * Defines filtering and sorting criteria used to select pools when checking eligibility.
+     *
+     * The filter selects pools using the same fields supported by Query Pools. For field support, see [Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/pools/filtering-and-sorting).
+     *
+     * When omitted, eligibility is checked across all pools in the namespace that match the provided `beneficiary`. Combined with `beneficiary` and `namespace`, the filter further narrows which pools are checked.
+     */
+    poolFilter?: PoolFilter;
+    /**
+     * 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 20
+     */
+    namespace: string;
+    /** Information about the item to check. */
+    itemReference: ItemReference;
+    /**
+     * Number 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;
+    /** Pool beneficiary. When provided, only the beneficiary's pools that also match `pool_filter` are checked. */
+    beneficiary?: CommonIdentificationData;
+    /** Additional information. */
+    additionalData?: Record<string, any> | null;
+}
+interface CheckBenefitEligibilityByFilterResponse {
+    /**
+     * Results of the eligibility check for the benefits in the pools that matched the filter. A pool that contains multiple benefits for the requested item produces one result per benefit.
+     *
+     * Empty when no pools match the filter. Capped at 100 results. When more than 100 results are produced, only the first 100, in the order specified by `poolFilter.sort`, are returned.
+     * @maxSize 100
+     */
+    results?: EligibilityCheckResult[];
+}
 interface HealPoolRequest {
     /**
      * ID of the pool whose enrichments should be re-materialized.
@@ -1646,9 +1694,9 @@ interface HealPoolRequest {
 }
 interface HealPoolResponse {
 }
-interface HealPoolsTenantRequest {
+interface HealPoolTenantRequest {
 }
-interface HealPoolsTenantResponse {
+interface HealPoolTenantResponse {
 }
 interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
@@ -1835,6 +1883,12 @@ type GetEligibleBenefitsApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
+type CheckBenefitEligibilityByFilterApplicationErrors = {
+    code?: 'INVALID_ITEM_REFERENCE';
+    description?: string;
+    data?: Record<string, any>;
+};
 /**
  * Retrieves a pool.
  * @param poolId - ID of the pool to retrieve.
@@ -2360,5 +2414,61 @@ interface CheckEligibilityByFilterOptions {
     /** Additional information. */
     additionalData?: Record<string, any> | null;
 }
+/**
+ * Checks benefit eligibility across the pools that match the filter.
+ *
+ * The filter selects pools (not individual benefits), using the same fields supported by Query Pools. For field support, see [Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/pools/filtering-and-sorting).
+ *
+ * To be redeemed, a benefit's pool must be active and the associated balance must be greater 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.count
+ * @requiredField options.itemReference
+ * @requiredField options.itemReference.externalId
+ * @requiredField options.itemReference.providerAppId
+ * @requiredField options.namespace
+ * @permissionId benefit_programs:v1:pool:check_benefit_eligibility_by_filter
+ * @fqn wix.benefit_programs.v1.pool.PoolService.CheckBenefitEligibilityByFilter
+ */
+declare function checkBenefitEligibilityByFilter(options?: NonNullablePaths<CheckBenefitEligibilityByFilterOptions, `count` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 3>): Promise<NonNullablePaths<CheckBenefitEligibilityByFilterResponse, `results`, 2> & {
+    __applicationErrorsType?: CheckBenefitEligibilityByFilterApplicationErrors;
+}>;
+interface CheckBenefitEligibilityByFilterOptions {
+    /**
+     * Defines filtering and sorting criteria used to select pools when checking eligibility.
+     *
+     * The filter selects pools using the same fields supported by Query Pools. For field support, see [Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/pools/filtering-and-sorting).
+     *
+     * When omitted, eligibility is checked across all pools in the namespace that match the provided `beneficiary`. Combined with `beneficiary` and `namespace`, the filter further narrows which pools are checked.
+     */
+    poolFilter?: PoolFilter;
+    /**
+     * 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 20
+     */
+    namespace: string;
+    /** Information about the item to check. */
+    itemReference: ItemReference;
+    /**
+     * Number 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;
+    /** Pool beneficiary. When provided, only the beneficiary's pools that also match `pool_filter` are checked. */
+    beneficiary?: CommonIdentificationData;
+    /** Additional information. */
+    additionalData?: Record<string, any> | null;
+}
 
-export { type AccountInfo, type ActionEvent, type ApplicationError, type AsyncResult, type BalanceAmount, type Benefit, type BenefitAlreadyRedeemed, type BenefitInfo, type BenefitNotFound, type BenefitRedeemed, type BenefitReservationCanceled, type BenefitReservationReleased, type BenefitReserved, type BenefitResult, type BenefitResultResultOneOf, BenefitResultType, type BenefitResultTypeWithLiterals, 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 CheckEligibilityByFilterOptions, type CheckEligibilityByFilterRequest, type CheckEligibilityByFilterResponse, type CommonIdentificationData, type CommonIdentificationDataIdOneOf, type CommonQueryWithEntityContext, 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 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 HealPoolRequest, type HealPoolResponse, type HealPoolsTenantRequest, type HealPoolsTenantResponse, 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 PoolFilter, type PoolInfo, type PoolNotActive, type PoolNotFound, PoolOrigin, type PoolOriginWithLiterals, type PoolPaused, type PoolProgramInfo, type PoolProvisionJobFinished, type PoolProvisioned, type PoolQuery, type PoolQuerySpec, type PoolRenewalAction, type PoolRenewalActionActionOneOf, PoolRenewalActionType, type PoolRenewalActionTypeWithLiterals, type PoolRenewed, type PoolResumed, PoolSelectorType, type PoolSelectorTypeWithLiterals, PoolStatus, type PoolStatusUpdateJobFinished, type PoolStatusUpdateJobFinishedContextOneOf, type PoolStatusUpdateParamsPoolInfo, type PoolStatusWithLiterals, type PoolWithItems, type PoolsQueryBuilder, type PoolsQueryResult, type ProgramDefinitionInfo, type ProgramInfo, type ProvisionPoolsForProgramRequest, type ProvisionPoolsForProgramResponse, type ProvisionPoolsForProgramResponseResultOneOf, ProvisionPoolsForProgramResponseType, type ProvisionPoolsForProgramResponseTypeWithLiterals, type QueryPoolsOptions, type QueryPoolsRequest, type QueryPoolsResponse, type RateLimitedPolicy, 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, TimePeriod, type TimePeriodWithLiterals, Type, type TypeWithLiterals, type Update, 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, typedQueryPools, updatePool, utils };
+export { type AccountInfo, type ActionEvent, type ApplicationError, type AsyncResult, type BalanceAmount, type Benefit, type BenefitAlreadyRedeemed, type BenefitInfo, type BenefitNotFound, type BenefitRedeemed, type BenefitReservationCanceled, type BenefitReservationReleased, type BenefitReserved, type BenefitResult, type BenefitResultResultOneOf, BenefitResultType, type BenefitResultTypeWithLiterals, 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 CheckBenefitEligibilityByFilterApplicationErrors, type CheckBenefitEligibilityByFilterOptions, type CheckBenefitEligibilityByFilterRequest, type CheckBenefitEligibilityByFilterResponse, type CheckBenefitEligibilityOptions, type CheckBenefitEligibilityRequest, type CheckBenefitEligibilityResponse, type CheckEligibilityByFilterOptions, type CheckEligibilityByFilterRequest, type CheckEligibilityByFilterResponse, type CommonIdentificationData, type CommonIdentificationDataIdOneOf, type CommonQueryWithEntityContext, 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 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 HealPoolRequest, type HealPoolResponse, type HealPoolTenantRequest, type HealPoolTenantResponse, 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 PoolFilter, type PoolInfo, type PoolNotActive, type PoolNotFound, PoolOrigin, type PoolOriginWithLiterals, type PoolPaused, type PoolProgramInfo, type PoolProvisionJobFinished, type PoolProvisioned, type PoolQuery, type PoolQuerySpec, type PoolRenewalAction, type PoolRenewalActionActionOneOf, PoolRenewalActionType, type PoolRenewalActionTypeWithLiterals, type PoolRenewed, type PoolResumed, PoolSelectorType, type PoolSelectorTypeWithLiterals, PoolStatus, type PoolStatusUpdateJobFinished, type PoolStatusUpdateJobFinishedContextOneOf, type PoolStatusUpdateParamsPoolInfo, type PoolStatusWithLiterals, type PoolWithItems, type PoolsQueryBuilder, type PoolsQueryResult, type ProgramDefinitionInfo, type ProgramInfo, type ProvisionPoolsForProgramRequest, type ProvisionPoolsForProgramResponse, type ProvisionPoolsForProgramResponseResultOneOf, ProvisionPoolsForProgramResponseType, type ProvisionPoolsForProgramResponseTypeWithLiterals, type QueryPoolsOptions, type QueryPoolsRequest, type QueryPoolsResponse, type RateLimitedPolicy, 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, TimePeriod, type TimePeriodWithLiterals, Type, type TypeWithLiterals, type Update, type UpdatePool, type UpdatePoolRequest, type UpdatePoolResponse, type UpdatePoolStatusRequest, type UpdatePoolStatusRequestPoolSelectorOneOf, type UpdatePoolStatusResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeekDay, type WeekDayWithLiterals, bulkCheckBenefitEligibility, bulkUpdatePools, checkBenefitEligibility, checkBenefitEligibilityByFilter, getEligibleBenefits, getPool, queryPools, redeemBenefit, typedQueryPools, updatePool, utils };

package/build/es/index.typings.mjs

@@ -493,6 +493,33 @@ function checkEligibilityByFilter(payload) {
   }
   return __checkEligibilityByFilter;
 }
+function checkBenefitEligibilityByFilter(payload) {
+  function __checkBenefitEligibilityByFilter({ host }) {
+    const serializedData = transformPaths(payload, [
+      {
+        transformFn: transformSDKTimestampToRESTTimestamp,
+        paths: [{ path: "targetDate" }]
+      }
+    ]);
+    const metadata = {
+      entityFqdn: "wix.benefit_programs.v1.pool",
+      method: "POST",
+      methodFqn: "wix.benefit_programs.v1.pool.PoolService.CheckBenefitEligibilityByFilter",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixBenefitProgramsV1PoolPoolServiceUrl({
+        protoPath: "/v1/pools/check-benefit-eligibility-by-filter",
+        data: serializedData,
+        host
+      }),
+      data: serializedData
+    };
+    return metadata;
+  }
+  return __checkBenefitEligibilityByFilter;
+}
 
 // src/benefit-programs-v1-pool-pools.universal.ts
 import { transformPaths as transformPaths2 } from "@wix/sdk-runtime/transformations/transform-paths";
@@ -932,6 +959,45 @@ async function checkEligibilityByFilter2(options) {
     throw transformedError;
   }
 }
+async function checkBenefitEligibilityByFilter2(options) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = renameKeysFromSDKRequestToRESTRequest({
+    poolFilter: options?.poolFilter,
+    namespace: options?.namespace,
+    itemReference: options?.itemReference,
+    count: options?.count,
+    targetDate: options?.targetDate,
+    beneficiary: options?.beneficiary,
+    additionalData: options?.additionalData
+  });
+  const reqOpts = checkBenefitEligibilityByFilter(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return renameKeysFromRESTResponseToSDKResponse(result.data);
+  } catch (err) {
+    const transformedError = sdkTransformError(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {
+          poolFilter: "$[0].poolFilter",
+          namespace: "$[0].namespace",
+          itemReference: "$[0].itemReference",
+          count: "$[0].count",
+          targetDate: "$[0].targetDate",
+          beneficiary: "$[0].beneficiary",
+          additionalData: "$[0].additionalData"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 export {
   BenefitResultType,
   IdentityType,
@@ -950,6 +1016,7 @@ export {
   bulkCheckBenefitEligibility2 as bulkCheckBenefitEligibility,
   bulkUpdatePools2 as bulkUpdatePools,
   checkBenefitEligibility2 as checkBenefitEligibility,
+  checkBenefitEligibilityByFilter2 as checkBenefitEligibilityByFilter,
   checkEligibilityByFilter2 as checkEligibilityByFilter,
   getEligibleBenefits2 as getEligibleBenefits,
   getPool2 as getPool,