@wix/auto_sdk_benefit-programs_pools 1.0.40 → 1.0.42

package/build/cjs/index.typings.d.ts

@@ -447,6 +447,18 @@ interface ProgramDefinitionInfo {
      * @readonly
      */
     externalId?: string | null;
+    /**
+     * Program external ID.
+     * @readonly
+     * @maxLength 128
+     */
+    displayName?: string | null;
+    /**
+     * Description of the program definition.
+     * @readonly
+     * @maxLength 450
+     */
+    description?: string | null;
 }
 interface PoolProgramInfo {
     /**
@@ -461,6 +473,12 @@ interface PoolProgramInfo {
      * @readonly
      */
     externalId?: string | null;
+    /**
+     * Program external ID.
+     * @readonly
+     * @maxLength 64
+     */
+    displayName?: string | null;
 }
 declare enum PoolOrigin {
     /** Unknown pool origin. */
@@ -1569,6 +1587,52 @@ interface CountNumberOfPoolsInProvisioningStatusResponse {
     /** Number of pools in provisioning status */
     count?: number;
 }
+interface CheckEligibilityByFilterRequest {
+    /** Defines filtering and sorting criteria used to select pools when checking eligibility. */
+    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;
+    /**
+     * Amount of items to check.
+     *
+     * Ensures the balance is high enough to redeem this many it
+     * @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. */
+    beneficiary: CommonIdentificationData;
+    /** Additional information. */
+    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?: Record<string, any> | null;
+    /**
+     * List of sort objects.
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+interface CheckEligibilityByFilterResponse {
+    /**
+     * Result of the eligibility check.
+     * @minSize 1
+     * @maxSize 100
+     */
+    result?: EligibilityCheckResult[];
+}
 interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
@@ -2152,5 +2216,34 @@ interface BulkUpdatePoolsOptions {
      */
     returnEntity?: boolean;
 }
+interface CheckEligibilityByFilterOptions {
+    /** Defines filtering and sorting criteria used to select pools when checking eligibility. */
+    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;
+    /**
+     * Amount of items to check.
+     *
+     * Ensures the balance is high enough to redeem this many it
+     * @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. */
+    beneficiary: CommonIdentificationData;
+    /** Additional information. */
+    additionalData?: Record<string, any> | null;
+}
 
-export { 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 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 PoolInfo, type PoolNotActive, type PoolNotFound, PoolOrigin, type PoolOriginWithLiterals, type PoolPaused, type PoolProgramInfo, type PoolProvisionJobFinished, type PoolProvisioned, 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 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 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 };
+export { 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 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 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 PoolFilter, type PoolInfo, type PoolNotActive, type PoolNotFound, PoolOrigin, type PoolOriginWithLiterals, type PoolPaused, type PoolProgramInfo, type PoolProvisionJobFinished, type PoolProvisioned, 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 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 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 };

package/build/cjs/index.typings.js

@@ -37,6 +37,7 @@ __export(index_typings_exports, {
   bulkCheckBenefitEligibility: () => bulkCheckBenefitEligibility2,
   bulkUpdatePools: () => bulkUpdatePools2,
   checkBenefitEligibility: () => checkBenefitEligibility2,
+  checkEligibilityByFilter: () => checkEligibilityByFilter2,
   getEligibleBenefits: () => getEligibleBenefits2,
   getPool: () => getPool2,
   queryPools: () => queryPools2,
@@ -511,6 +512,33 @@ function bulkUpdatePools(payload) {
   }
   return __bulkUpdatePools;
 }
+function checkEligibilityByFilter(payload) {
+  function __checkEligibilityByFilter({ host }) {
+    const serializedData = (0, import_transform_paths.transformPaths)(payload, [
+      {
+        transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
+        paths: [{ path: "targetDate" }]
+      }
+    ]);
+    const metadata = {
+      entityFqdn: "wix.benefit_programs.v1.pool",
+      method: "POST",
+      methodFqn: "wix.benefit_programs.v1.pool.PoolService.CheckEligibilityByFilter",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixBenefitProgramsV1PoolPoolServiceUrl({
+        protoPath: "/v1/pools/check-eligibility-by-filter",
+        data: serializedData,
+        host
+      }),
+      data: serializedData
+    };
+    return metadata;
+  }
+  return __checkEligibilityByFilter;
+}
 
 // src/benefit-programs-v1-pool-pools.universal.ts
 var import_transform_paths2 = require("@wix/sdk-runtime/transformations/transform-paths");
@@ -909,6 +937,45 @@ async function bulkUpdatePools2(options) {
     throw transformedError;
   }
 }
+async function checkEligibilityByFilter2(options) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    poolFilter: options?.poolFilter,
+    namespace: options?.namespace,
+    itemReference: options?.itemReference,
+    count: options?.count,
+    targetDate: options?.targetDate,
+    beneficiary: options?.beneficiary,
+    additionalData: options?.additionalData
+  });
+  const reqOpts = checkEligibilityByFilter(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      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;
+  }
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   EligibilityCheckResultType,
@@ -928,6 +995,7 @@ async function bulkUpdatePools2(options) {
   bulkCheckBenefitEligibility,
   bulkUpdatePools,
   checkBenefitEligibility,
+  checkEligibilityByFilter,
   getEligibleBenefits,
   getPool,
   queryPools,