@wix/auto_sdk_benefit-programs_pool-definitions 1.0.66 → 1.0.67

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

@@ -66,6 +66,12 @@ interface PoolDefinition {
      * @maxLength 450
      */
     description?: string | null;
+    /**
+     * Monotonic counter incremented on every change, including system/materialization updates that do not bump revision.
+     * @internal
+     * @readonly
+     */
+    changesCounter?: string | null;
 }
 interface Details {
     /**
@@ -79,6 +85,19 @@ interface Details {
      * If this object is empty, you can't set a price for the benefit.
      */
     creditConfiguration?: CreditConfiguration;
+    /**
+     * Defines when benefits can be redeemed.
+     *
+     * Benefit redemption can be limited by:
+     * - **Fixed intervals**: Benefits can be redeemed during specific times of the day or week.
+     * - **Rate limited**: Up to a maximum amount of benefits can be redeemed in a specified time period.
+     *
+     * Expressions can be combined using the *not*, *and*, and *or* operators.
+     *
+     * Each benefit can override this policy.
+     * @internal
+     */
+    policyExpression?: PolicyExpression;
     /** Additional information relating to this object. */
     additionalData?: Record<string, any> | null;
 }
@@ -102,6 +121,11 @@ interface Benefit {
      * @decimalValue options { gte:0, maxScale:4 }
      */
     price?: string | null;
+    /**
+     * Overrides the default policy expression in `benefit.details`.
+     * @internal
+     */
+    policyExpression?: PolicyExpression;
     /** Additional information for this benefit. */
     additionalData?: Record<string, any> | null;
     /**
@@ -513,6 +537,11 @@ interface BulkActionMetadata {
 interface UpdatePoolDefinitionRequest {
     /** Pool definition to update. */
     poolDefinition: PoolDefinition;
+    /**
+     * Explicit list of fields to update.
+     * @internal
+     */
+    fieldMask?: string[];
     /** *Required.** Determines when the changes to this pool definition and program definitions containing it will be applied to associated programs and pools. */
     cascade?: CascadeWithLiterals;
 }
@@ -598,6 +627,19 @@ interface GetPoolDefinitionResponse {
 interface QueryPoolDefinitionsRequest {
     /** Filter, sort, and paging to apply to the query. */
     query?: CursorQuery;
+    /**
+     * If true, the response will reflect a consistent snapshot of the data as of the time the request was received.
+     * @internal
+     */
+    consistent?: boolean | null;
+    /**
+     * HACK FIXME PPNP-4611. Supersedes the page limit provided in the CursorQuery. Provides a way for trusted clients to query large
+     * amounts of data because necessary index crashes mysql cluster so the only option is to perform filtering in memory
+     * https://wix.slack.com/archives/C0E3MBAGH/p1765097287055939
+     * @internal
+     * @max 10000
+     */
+    overrideLimit?: number | null;
 }
 interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
@@ -631,6 +673,20 @@ interface Sorting {
      * Default: `ASC`
      */
     order?: SortOrderWithLiterals;
+    /**
+     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+     *
+     * If multiple filters are provided, they are combined with AND operator.
+     *
+     * Example:
+     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+     * @internal
+     * @maxSize 10
+     */
+    selectItemsBy?: Record<string, any>[] | null;
 }
 declare enum SortOrder {
     /** Ascending sort order. */
@@ -1068,6 +1124,12 @@ interface UpdatePoolDefinition {
      * @maxLength 450
      */
     description?: string | null;
+    /**
+     * Monotonic counter incremented on every change, including system/materialization updates that do not bump revision.
+     * @internal
+     * @readonly
+     */
+    changesCounter?: string | null;
 }
 interface UpdatePoolDefinitionOptions {
     /** Required.** Determines when the changes to this pool definition and program definitions containing it will be applied to associated programs and pools. */
@@ -1158,6 +1220,19 @@ declare function getPoolDefinition(poolDefinitionId: string): Promise<NonNullabl
  */
 declare function queryPoolDefinitions(options?: QueryPoolDefinitionsOptions): PoolDefinitionsQueryBuilder;
 interface QueryPoolDefinitionsOptions {
+    /**
+     * If true, the response will reflect a consistent snapshot of the data as of the time the request was received.
+     * @internal
+     */
+    consistent?: boolean | null | undefined;
+    /**
+     * HACK FIXME PPNP-4611. Supersedes the page limit provided in the CursorQuery. Provides a way for trusted clients to query large
+     * amounts of data because necessary index crashes mysql cluster so the only option is to perform filtering in memory
+     * https://wix.slack.com/archives/C0E3MBAGH/p1765097287055939
+     * @internal
+     * @max 10000
+     */
+    overrideLimit?: number | null | undefined;
 }
 interface QueryCursorResult {
     cursors: Cursors;
@@ -1176,11 +1251,11 @@ interface PoolDefinitionsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      */
-    eq: (propertyName: '_id' | '_createdDate' | 'programDefinitionIds' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace', value: any) => PoolDefinitionsQueryBuilder;
+    eq: (propertyName: '_id' | '_createdDate' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace', value: any) => PoolDefinitionsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      */
-    ne: (propertyName: '_id' | '_createdDate' | 'programDefinitionIds' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace', value: any) => PoolDefinitionsQueryBuilder;
+    ne: (propertyName: '_id' | '_createdDate' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace', value: any) => PoolDefinitionsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      */
@@ -1204,12 +1279,12 @@ interface PoolDefinitionsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `values`.
      * @param values - List of values to compare against.
      */
-    hasSome: (propertyName: '_id' | '_createdDate' | 'programDefinitionIds' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace', value: any[]) => PoolDefinitionsQueryBuilder;
+    hasSome: (propertyName: 'programDefinitionIds', value: any[]) => PoolDefinitionsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `values`.
      * @param values - List of values to compare against.
      */
     hasAll: (propertyName: 'programDefinitionIds', value: any[]) => PoolDefinitionsQueryBuilder;
-    in: (propertyName: '_id' | '_createdDate' | 'programDefinitionIds' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace', value: any) => PoolDefinitionsQueryBuilder;
+    in: (propertyName: '_id' | '_createdDate' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace', value: any) => PoolDefinitionsQueryBuilder;
     exists: (propertyName: '_id' | '_createdDate' | 'programDefinitionIds' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace', value: boolean) => PoolDefinitionsQueryBuilder;
     /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
     ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'programDefinitionIds' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace'>) => PoolDefinitionsQueryBuilder;
@@ -1288,14 +1363,24 @@ type PoolDefinitionQuery = {
       Default: `ASC`
       */
         order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+        /**
+      When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+      a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+    
+      If multiple filters are provided, they are combined with AND operator.
+    
+      Example:
+      Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+      and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+      { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+      @internal: undefined,
+      @maxSize: 10
+      */
+        selectItemsBy?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['selectItemsBy'] | null;
     }[];
 };
 declare const utils: {
-    query: {
-        QueryBuilder: () => _wix_sdk_types.QueryBuilder<PoolDefinition, PoolDefinitionQuerySpec, PoolDefinitionQuery>;
-        Filter: _wix_sdk_types.FilterFactory<PoolDefinition, PoolDefinitionQuerySpec>;
-        Sort: _wix_sdk_types.SortFactory<PoolDefinitionQuerySpec>;
-    };
+    query: _wix_sdk_types.QueryHelpers<PoolDefinition, PoolDefinitionQuerySpec, PoolDefinitionQuery>;
 };
 /**
  * Adds a pool definition to a program definition.

package/build/internal/cjs/index.typings.js

@@ -889,9 +889,7 @@ async function typedQueryPoolDefinitions(query, options) {
   }
 }
 var utils = {
-  query: {
-    ...(0, import_query_builder_utils.createQueryUtils)()
-  }
+  query: /* @__PURE__ */ (0, import_query_builder_utils.createQueryUtils)()
 };
 async function addPoolDefinitionToProgramDefinition2(poolDefinitionId, options) {
   const { httpClient, sideEffects } = arguments[2];