@wix/auto_sdk_benefit-programs_pools 1.0.69 → 1.0.70

package/build/internal/cjs/schemas.d.ts

@@ -870,5 +870,154 @@ declare const BulkUpdatePoolsResponse: z.ZodObject<{
         undetailedFailures: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
+declare const CheckBenefitEligibilityByFilterRequest: z.ZodObject<{
+    options: z.ZodObject<{
+        poolFilter: z.ZodOptional<z.ZodObject<{
+            filter: z.ZodNullable<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+            sort: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                fieldName: z.ZodOptional<z.ZodString>;
+                order: z.ZodOptional<z.ZodEnum<{
+                    ASC: "ASC";
+                    DESC: "DESC";
+                }>>;
+            }, z.core.$strip>>>;
+        }, z.core.$strip>>;
+        namespace: z.ZodString;
+        itemReference: z.ZodObject<{
+            externalId: z.ZodString;
+            category: z.ZodOptional<z.ZodString>;
+            providerAppId: z.ZodString;
+        }, z.core.$strip>;
+        count: z.ZodNumber;
+        targetDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
+        beneficiary: z.ZodOptional<z.ZodIntersection<z.ZodObject<{}, z.core.$strip>, z.ZodXor<readonly [z.ZodObject<{
+            anonymousVisitorId: z.ZodOptional<z.ZodNever>;
+            memberId: z.ZodOptional<z.ZodNever>;
+            wixUserId: z.ZodOptional<z.ZodNever>;
+        }, z.core.$strip>, z.ZodObject<{
+            memberId: z.ZodOptional<z.ZodNever>;
+            wixUserId: z.ZodOptional<z.ZodNever>;
+            anonymousVisitorId: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            anonymousVisitorId: z.ZodOptional<z.ZodNever>;
+            wixUserId: z.ZodOptional<z.ZodNever>;
+            memberId: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            anonymousVisitorId: z.ZodOptional<z.ZodNever>;
+            memberId: z.ZodOptional<z.ZodNever>;
+            wixUserId: z.ZodString;
+        }, z.core.$strip>]>>>;
+        additionalData: z.ZodNullable<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+declare const CheckBenefitEligibilityByFilterResponse: z.ZodObject<{
+    results: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        benefitResults: z.ZodOptional<z.ZodArray<z.ZodIntersection<z.ZodObject<{
+            type: z.ZodOptional<z.ZodEnum<{
+                ELIGIBLE_BENEFIT: "ELIGIBLE_BENEFIT";
+                NOT_ENOUGH_BALANCE: "NOT_ENOUGH_BALANCE";
+                POOL_NOT_ACTIVE: "POOL_NOT_ACTIVE";
+                BENEFIT_NOT_FOUND: "BENEFIT_NOT_FOUND";
+                POOL_NOT_FOUND: "POOL_NOT_FOUND";
+            }>>;
+        }, z.core.$strip>, z.ZodXor<readonly [z.ZodObject<{
+            eligibleBenefitOptions: z.ZodOptional<z.ZodNever>;
+            notEnoughBalanceOptions: z.ZodOptional<z.ZodNever>;
+            policyExpressionEvaluatedToFalseOptions: z.ZodOptional<z.ZodNever>;
+            poolNotActiveOptions: z.ZodOptional<z.ZodNever>;
+            benefitNotFoundOptions: z.ZodOptional<z.ZodNever>;
+            poolNotFoundOptions: z.ZodOptional<z.ZodNever>;
+        }, z.core.$strip>, z.ZodObject<{
+            notEnoughBalanceOptions: z.ZodOptional<z.ZodNever>;
+            policyExpressionEvaluatedToFalseOptions: z.ZodOptional<z.ZodNever>;
+            poolNotActiveOptions: z.ZodOptional<z.ZodNever>;
+            benefitNotFoundOptions: z.ZodOptional<z.ZodNever>;
+            poolNotFoundOptions: z.ZodOptional<z.ZodNever>;
+            eligibleBenefitOptions: z.ZodObject<{
+                poolId: z.ZodOptional<z.ZodString>;
+                benefitKey: z.ZodOptional<z.ZodString>;
+                itemReference: z.ZodOptional<z.ZodObject<{
+                    externalId: z.ZodOptional<z.ZodString>;
+                    category: z.ZodOptional<z.ZodString>;
+                    providerAppId: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+                price: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
+            eligibleBenefitOptions: z.ZodOptional<z.ZodNever>;
+            policyExpressionEvaluatedToFalseOptions: z.ZodOptional<z.ZodNever>;
+            poolNotActiveOptions: z.ZodOptional<z.ZodNever>;
+            benefitNotFoundOptions: z.ZodOptional<z.ZodNever>;
+            poolNotFoundOptions: z.ZodOptional<z.ZodNever>;
+            notEnoughBalanceOptions: z.ZodObject<{
+                poolId: z.ZodOptional<z.ZodString>;
+                itemReference: z.ZodOptional<z.ZodObject<{
+                    externalId: z.ZodOptional<z.ZodString>;
+                    category: z.ZodOptional<z.ZodString>;
+                    providerAppId: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+                availableBalance: z.ZodOptional<z.ZodString>;
+                requestedBalance: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
+            eligibleBenefitOptions: z.ZodOptional<z.ZodNever>;
+            notEnoughBalanceOptions: z.ZodOptional<z.ZodNever>;
+            poolNotActiveOptions: z.ZodOptional<z.ZodNever>;
+            benefitNotFoundOptions: z.ZodOptional<z.ZodNever>;
+            poolNotFoundOptions: z.ZodOptional<z.ZodNever>;
+            policyExpressionEvaluatedToFalseOptions: z.ZodObject<{
+                poolId: z.ZodOptional<z.ZodString>;
+                itemReference: z.ZodOptional<z.ZodObject<{
+                    externalId: z.ZodOptional<z.ZodString>;
+                    category: z.ZodOptional<z.ZodString>;
+                    providerAppId: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+                failureDetails: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    code: z.ZodOptional<z.ZodString>;
+                    message: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                    policyId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                    appId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                    errorData: z.ZodNullable<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+                }, z.core.$strip>>>;
+            }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
+            eligibleBenefitOptions: z.ZodOptional<z.ZodNever>;
+            notEnoughBalanceOptions: z.ZodOptional<z.ZodNever>;
+            policyExpressionEvaluatedToFalseOptions: z.ZodOptional<z.ZodNever>;
+            benefitNotFoundOptions: z.ZodOptional<z.ZodNever>;
+            poolNotFoundOptions: z.ZodOptional<z.ZodNever>;
+            poolNotActiveOptions: z.ZodObject<{
+                poolId: z.ZodOptional<z.ZodString>;
+                poolStatus: z.ZodOptional<z.ZodEnum<{
+                    ACTIVE: "ACTIVE";
+                    PAUSED: "PAUSED";
+                    ENDED: "ENDED";
+                    PROVISIONING: "PROVISIONING";
+                    RENEWING: "RENEWING";
+                    PENDING: "PENDING";
+                }>>;
+            }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
+            eligibleBenefitOptions: z.ZodOptional<z.ZodNever>;
+            notEnoughBalanceOptions: z.ZodOptional<z.ZodNever>;
+            policyExpressionEvaluatedToFalseOptions: z.ZodOptional<z.ZodNever>;
+            poolNotActiveOptions: z.ZodOptional<z.ZodNever>;
+            poolNotFoundOptions: z.ZodOptional<z.ZodNever>;
+            benefitNotFoundOptions: z.ZodObject<{
+                poolId: z.ZodOptional<z.ZodString>;
+                benefitKey: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
+            eligibleBenefitOptions: z.ZodOptional<z.ZodNever>;
+            notEnoughBalanceOptions: z.ZodOptional<z.ZodNever>;
+            policyExpressionEvaluatedToFalseOptions: z.ZodOptional<z.ZodNever>;
+            poolNotActiveOptions: z.ZodOptional<z.ZodNever>;
+            benefitNotFoundOptions: z.ZodOptional<z.ZodNever>;
+            poolNotFoundOptions: z.ZodObject<{
+                poolId: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>;
+        }, z.core.$strip>]>>>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
 
-export { BulkCheckBenefitEligibilityRequest, BulkCheckBenefitEligibilityResponse, BulkUpdatePoolsRequest, BulkUpdatePoolsResponse, CheckBenefitEligibilityRequest, CheckBenefitEligibilityResponse, GetEligibleBenefitsRequest, GetEligibleBenefitsResponse, GetPoolRequest, GetPoolResponse, QueryPoolsRequest, QueryPoolsResponse, RedeemBenefitRequest, RedeemBenefitResponse, UpdatePoolRequest, UpdatePoolResponse };
+export { BulkCheckBenefitEligibilityRequest, BulkCheckBenefitEligibilityResponse, BulkUpdatePoolsRequest, BulkUpdatePoolsResponse, CheckBenefitEligibilityByFilterRequest, CheckBenefitEligibilityByFilterResponse, CheckBenefitEligibilityRequest, CheckBenefitEligibilityResponse, GetEligibleBenefitsRequest, GetEligibleBenefitsResponse, GetPoolRequest, GetPoolResponse, QueryPoolsRequest, QueryPoolsResponse, RedeemBenefitRequest, RedeemBenefitResponse, UpdatePoolRequest, UpdatePoolResponse };

package/build/internal/cjs/schemas.js

@@ -34,6 +34,8 @@ __export(schemas_exports, {
   BulkCheckBenefitEligibilityResponse: () => BulkCheckBenefitEligibilityResponse,
   BulkUpdatePoolsRequest: () => BulkUpdatePoolsRequest,
   BulkUpdatePoolsResponse: () => BulkUpdatePoolsResponse,
+  CheckBenefitEligibilityByFilterRequest: () => CheckBenefitEligibilityByFilterRequest,
+  CheckBenefitEligibilityByFilterResponse: () => CheckBenefitEligibilityByFilterResponse,
   CheckBenefitEligibilityRequest: () => CheckBenefitEligibilityRequest,
   CheckBenefitEligibilityResponse: () => CheckBenefitEligibilityResponse,
   GetEligibleBenefitsRequest: () => GetEligibleBenefitsRequest,
@@ -1699,12 +1701,266 @@ var BulkUpdatePoolsResponse = z.object({
     ).optional()
   }).describe("Bulk action metadata.").optional()
 });
+var CheckBenefitEligibilityByFilterRequest = z.object({
+  options: z.object({
+    poolFilter: z.object({
+      filter: z.record(z.string(), z.any()).describe(
+        "Filter object. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more information.\n\nFor supported filterable and sortable fields, see [Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/pools/filtering-and-sorting)."
+      ).optional().nullable(),
+      sort: z.array(
+        z.object({
+          fieldName: z.string().describe("Field to sort by.").max(512).optional(),
+          order: z.enum(["ASC", "DESC"]).optional()
+        })
+      ).max(5).optional()
+    }).describe(
+      "Defines filtering and sorting criteria used to select pools when checking eligibility.\n\nThe 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).\n\nWhen 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."
+    ).optional(),
+    namespace: z.string().describe(
+      "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."
+    ).min(1).max(20),
+    itemReference: z.object({
+      externalId: z.string().describe("External ID of the item.").regex(
+        /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+        "Must be a valid GUID"
+      ),
+      category: z.string().describe("Item category.").max(20).optional(),
+      providerAppId: z.string().describe("ID of the app providing the item.").regex(
+        /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+        "Must be a valid GUID"
+      )
+    }).describe("Information about the item to check."),
+    count: z.number().int().describe(
+      "Number of items to check.\n\nEnsures the balance is high enough to redeem this many items."
+    ).min(1),
+    targetDate: z.date().describe(
+      "Date that the item will be provided to the beneficiary.\n\nThis parameter should be used to manage the potential logistics of providing the item."
+    ).optional().nullable(),
+    beneficiary: z.intersection(
+      z.object({}),
+      z.xor([
+        z.object({
+          anonymousVisitorId: z.never().optional(),
+          memberId: z.never().optional(),
+          wixUserId: z.never().optional()
+        }),
+        z.object({
+          memberId: z.never().optional(),
+          wixUserId: z.never().optional(),
+          anonymousVisitorId: z.string().describe(
+            "ID of a site visitor that hasn't logged in to the site."
+          ).regex(
+            /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+            "Must be a valid GUID"
+          )
+        }),
+        z.object({
+          anonymousVisitorId: z.never().optional(),
+          wixUserId: z.never().optional(),
+          memberId: z.string().describe("ID of a site member.").regex(
+            /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+            "Must be a valid GUID"
+          )
+        }),
+        z.object({
+          anonymousVisitorId: z.never().optional(),
+          memberId: z.never().optional(),
+          wixUserId: z.string().describe("ID of a Wix user.").regex(
+            /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+            "Must be a valid GUID"
+          )
+        })
+      ])
+    ).describe(
+      "Pool beneficiary. When provided, only the beneficiary's pools that also match `pool_filter` are checked."
+    ).optional(),
+    additionalData: z.record(z.string(), z.any()).describe("Additional information.").optional().nullable()
+  })
+});
+var CheckBenefitEligibilityByFilterResponse = z.object({
+  results: z.array(
+    z.object({
+      benefitResults: z.array(
+        z.intersection(
+          z.object({
+            type: z.enum([
+              "ELIGIBLE_BENEFIT",
+              "NOT_ENOUGH_BALANCE",
+              "POOL_NOT_ACTIVE",
+              "BENEFIT_NOT_FOUND",
+              "POOL_NOT_FOUND"
+            ]).describe("Eligibility status.").optional()
+          }),
+          z.xor([
+            z.object({
+              eligibleBenefitOptions: z.never().optional(),
+              notEnoughBalanceOptions: z.never().optional(),
+              policyExpressionEvaluatedToFalseOptions: z.never().optional(),
+              poolNotActiveOptions: z.never().optional(),
+              benefitNotFoundOptions: z.never().optional(),
+              poolNotFoundOptions: z.never().optional()
+            }),
+            z.object({
+              notEnoughBalanceOptions: z.never().optional(),
+              policyExpressionEvaluatedToFalseOptions: z.never().optional(),
+              poolNotActiveOptions: z.never().optional(),
+              benefitNotFoundOptions: z.never().optional(),
+              poolNotFoundOptions: z.never().optional(),
+              eligibleBenefitOptions: z.object({
+                poolId: z.string().describe("Pool ID.").regex(
+                  /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+                  "Must be a valid GUID"
+                ).optional(),
+                benefitKey: z.string().describe("Benefit key.").max(64).optional(),
+                itemReference: z.object({
+                  externalId: z.string().describe("External ID of the item.").regex(
+                    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+                    "Must be a valid GUID"
+                  ).optional(),
+                  category: z.string().describe("Item category.").max(20).optional(),
+                  providerAppId: z.string().describe("ID of the app providing the item.").regex(
+                    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+                    "Must be a valid GUID"
+                  ).optional()
+                }).describe("Item reference.").optional(),
+                price: z.string().describe("Price of the benefit in credits.").optional().nullable()
+              }).describe("Returned when item is eligible to be redeemed.")
+            }),
+            z.object({
+              eligibleBenefitOptions: z.never().optional(),
+              policyExpressionEvaluatedToFalseOptions: z.never().optional(),
+              poolNotActiveOptions: z.never().optional(),
+              benefitNotFoundOptions: z.never().optional(),
+              poolNotFoundOptions: z.never().optional(),
+              notEnoughBalanceOptions: z.object({
+                poolId: z.string().describe("Pool ID.").regex(
+                  /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+                  "Must be a valid GUID"
+                ).optional(),
+                itemReference: z.object({
+                  externalId: z.string().describe("External ID of the item.").regex(
+                    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+                    "Must be a valid GUID"
+                  ).optional(),
+                  category: z.string().describe("Item category.").max(20).optional(),
+                  providerAppId: z.string().describe("ID of the app providing the item.").regex(
+                    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+                    "Must be a valid GUID"
+                  ).optional()
+                }).describe("Item reference.").optional(),
+                availableBalance: z.string().describe(
+                  "Pool's associated balance amount in credits."
+                ).optional(),
+                requestedBalance: z.string().describe("Price of the item in credits.").optional()
+              }).describe(
+                "Returned when the pool's associated balance is lower than the cost of redeeming the items."
+              )
+            }),
+            z.object({
+              eligibleBenefitOptions: z.never().optional(),
+              notEnoughBalanceOptions: z.never().optional(),
+              poolNotActiveOptions: z.never().optional(),
+              benefitNotFoundOptions: z.never().optional(),
+              poolNotFoundOptions: z.never().optional(),
+              policyExpressionEvaluatedToFalseOptions: z.object({
+                poolId: z.string().describe("Pool ID.").regex(
+                  /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+                  "Must be a valid GUID"
+                ).optional(),
+                itemReference: z.object({
+                  externalId: z.string().describe("External ID of the item.").regex(
+                    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+                    "Must be a valid GUID"
+                  ).optional(),
+                  category: z.string().describe("Item category.").max(20).optional(),
+                  providerAppId: z.string().describe("ID of the app providing the item.").regex(
+                    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+                    "Must be a valid GUID"
+                  ).optional()
+                }).describe("Item reference.").optional(),
+                failureDetails: z.array(
+                  z.object({
+                    code: z.string().describe("Failure code").min(1).max(64).optional(),
+                    message: z.string().describe("Failure message").max(256).optional().nullable(),
+                    policyId: z.string().describe("Policy id").regex(
+                      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+                      "Must be a valid GUID"
+                    ).optional().nullable(),
+                    appId: z.string().describe("App that owns the policy").regex(
+                      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+                      "Must be a valid GUID"
+                    ).optional().nullable(),
+                    errorData: z.record(z.string(), z.any()).describe("Information provided by the policy").optional().nullable()
+                  })
+                ).max(10).optional()
+              }).describe("Returned when the policy is false.")
+            }),
+            z.object({
+              eligibleBenefitOptions: z.never().optional(),
+              notEnoughBalanceOptions: z.never().optional(),
+              policyExpressionEvaluatedToFalseOptions: z.never().optional(),
+              benefitNotFoundOptions: z.never().optional(),
+              poolNotFoundOptions: z.never().optional(),
+              poolNotActiveOptions: z.object({
+                poolId: z.string().describe("Pool ID.").regex(
+                  /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+                  "Must be a valid GUID"
+                ).optional(),
+                poolStatus: z.enum([
+                  "ACTIVE",
+                  "PAUSED",
+                  "ENDED",
+                  "PROVISIONING",
+                  "RENEWING",
+                  "PENDING"
+                ]).describe("Pool status.").optional()
+              }).describe("Returned when the pool isn't active.")
+            }),
+            z.object({
+              eligibleBenefitOptions: z.never().optional(),
+              notEnoughBalanceOptions: z.never().optional(),
+              policyExpressionEvaluatedToFalseOptions: z.never().optional(),
+              poolNotActiveOptions: z.never().optional(),
+              poolNotFoundOptions: z.never().optional(),
+              benefitNotFoundOptions: z.object({
+                poolId: z.string().describe("Pool ID.").regex(
+                  /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+                  "Must be a valid GUID"
+                ).optional(),
+                benefitKey: z.string().describe("Specified benefit key.").max(64).optional().nullable()
+              }).describe(
+                "Returned when invalid benefit details are provided."
+              )
+            }),
+            z.object({
+              eligibleBenefitOptions: z.never().optional(),
+              notEnoughBalanceOptions: z.never().optional(),
+              policyExpressionEvaluatedToFalseOptions: z.never().optional(),
+              poolNotActiveOptions: z.never().optional(),
+              benefitNotFoundOptions: z.never().optional(),
+              poolNotFoundOptions: z.object({
+                poolId: z.string().describe("Pool ID.").regex(
+                  /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+                  "Must be a valid GUID"
+                ).optional()
+              }).describe(
+                "Returned when invalid pool details are provided."
+              )
+            })
+          ])
+        )
+      ).max(10).optional()
+    })
+  ).max(100).optional()
+});
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   BulkCheckBenefitEligibilityRequest,
   BulkCheckBenefitEligibilityResponse,
   BulkUpdatePoolsRequest,
   BulkUpdatePoolsResponse,
+  CheckBenefitEligibilityByFilterRequest,
+  CheckBenefitEligibilityByFilterResponse,
   CheckBenefitEligibilityRequest,
   CheckBenefitEligibilityResponse,
   GetEligibleBenefitsRequest,