@wix/auto_sdk_benefit-programs_pools 1.0.76 → 1.0.77

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

@@ -102,6 +102,37 @@ interface Pool {
      * @readonly
      */
     renewalCount?: number | null;
+    /**
+     * Previous status of the benefit pool.
+     * @internal
+     * @readonly
+     */
+    previousStatus?: PoolStatusWithLiterals;
+    /**
+     * Origin of the benefit pool.
+     * @internal
+     * @readonly
+     * @immutable
+     */
+    origin?: PoolOriginWithLiterals;
+    /**
+     * Action to be performed on pool renewal
+     * @internal
+     * @readonly
+     */
+    renewalAction?: PoolRenewalAction;
+    /**
+     * Pool description.
+     * @internal
+     * @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;
 }
 declare enum PoolStatus {
     /** Pool is active. */
@@ -135,6 +166,12 @@ interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
      * @format GUID
      */
     wixUserId?: string;
+    /**
+     * Identity type.
+     * @internal
+     * @readonly
+     */
+    identityType?: IdentityTypeWithLiterals;
 }
 /** @oneof */
 interface CommonIdentificationDataIdOneOf {
@@ -178,6 +215,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;
 }
@@ -201,6 +251,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;
     /**
@@ -719,6 +774,11 @@ interface GetPoolResponse {
 interface UpdatePoolRequest {
     /** Pool to update. */
     pool: Pool;
+    /**
+     * Explicit list of fields to update.
+     * @internal
+     */
+    fieldMask?: string[];
 }
 interface UpdatePoolResponse {
     /** Updated pool. */
@@ -736,6 +796,11 @@ interface DeletePoolResponse {
 interface QueryPoolsRequest {
     /** 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;
 }
 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`. */
@@ -769,6 +834,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. */
@@ -1250,6 +1329,11 @@ declare enum BenefitResultType {
     ELIGIBLE_BENEFIT = "ELIGIBLE_BENEFIT",
     /** Balance is lower than the cost of redeeming the items. */
     NOT_ENOUGH_BALANCE = "NOT_ENOUGH_BALANCE",
+    /**
+     * Policy is false.
+     * @internal
+     */
+    POLICY_EXPRESSION_EVALUATED_TO_FALSE = "POLICY_EXPRESSION_EVALUATED_TO_FALSE",
     /** Pool isn't active. */
     POOL_NOT_ACTIVE = "POOL_NOT_ACTIVE",
     /** Invalid benefit details provided. */
@@ -2063,6 +2147,37 @@ interface UpdatePool {
      * @readonly
      */
     renewalCount?: number | null;
+    /**
+     * Previous status of the benefit pool.
+     * @internal
+     * @readonly
+     */
+    previousStatus?: PoolStatusWithLiterals;
+    /**
+     * Origin of the benefit pool.
+     * @internal
+     * @readonly
+     * @immutable
+     */
+    origin?: PoolOriginWithLiterals;
+    /**
+     * Action to be performed on pool renewal
+     * @internal
+     * @readonly
+     */
+    renewalAction?: PoolRenewalAction;
+    /**
+     * Pool description.
+     * @internal
+     * @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;
 }
 /**
  * Creates a query to retrieve a list of pools.
@@ -2083,6 +2198,11 @@ interface UpdatePool {
  */
 declare function queryPools(options?: QueryPoolsOptions): PoolsQueryBuilder;
 interface QueryPoolsOptions {
+    /**
+     * 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;
 }
 interface QueryCursorResult {
     cursors: Cursors;
@@ -2101,11 +2221,11 @@ interface PoolsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      */
-    eq: (propertyName: '_id' | '_createdDate' | 'poolDefinitionId' | 'programDefinitionId' | 'programId' | 'status' | 'beneficiary' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace' | 'programDefinition.id' | 'program.id', value: any) => PoolsQueryBuilder;
+    eq: (propertyName: '_id' | '_createdDate' | 'poolDefinitionId' | 'programDefinitionId' | 'programId' | 'status' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace' | 'programDefinition.id' | 'program.id', value: any) => PoolsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      */
-    ne: (propertyName: '_id' | '_createdDate' | 'poolDefinitionId' | 'programDefinitionId' | 'programId' | 'status' | 'beneficiary' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace' | 'programDefinition.id' | 'program.id', value: any) => PoolsQueryBuilder;
+    ne: (propertyName: '_id' | '_createdDate' | 'poolDefinitionId' | 'programDefinitionId' | 'programId' | 'status' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace' | 'programDefinition.id' | 'program.id', value: any) => PoolsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      */
@@ -2126,11 +2246,7 @@ interface PoolsQueryBuilder {
      * @param string - String to compare against. Case-insensitive.
      */
     startsWith: (propertyName: '_id' | 'poolDefinitionId' | 'programDefinitionId' | 'programId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace' | 'programDefinition.id' | 'program.id', value: string) => PoolsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `values`.
-     * @param values - List of values to compare against.
-     */
-    hasSome: (propertyName: '_id' | '_createdDate' | 'poolDefinitionId' | 'programDefinitionId' | 'programId' | 'status' | 'beneficiary' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace' | 'programDefinition.id' | 'program.id', value: any[]) => PoolsQueryBuilder;
-    in: (propertyName: '_id' | '_createdDate' | 'poolDefinitionId' | 'programDefinitionId' | 'programId' | 'status' | 'beneficiary' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace' | 'programDefinition.id' | 'program.id', value: any) => PoolsQueryBuilder;
+    in: (propertyName: '_id' | '_createdDate' | 'poolDefinitionId' | 'programDefinitionId' | 'programId' | 'status' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace' | 'programDefinition.id' | 'program.id', value: any) => PoolsQueryBuilder;
     exists: (propertyName: '_id' | '_createdDate' | 'poolDefinitionId' | 'programDefinitionId' | 'programId' | 'status' | 'beneficiary' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace' | 'programDefinition.id' | 'program.id', value: boolean) => PoolsQueryBuilder;
     /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
     ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'poolDefinitionId' | 'programDefinitionId' | 'programId' | 'status' | 'beneficiary' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace' | 'programDefinition.id' | 'program.id'>) => PoolsQueryBuilder;
@@ -2216,14 +2332,24 @@ type PoolQuery = {
       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<Pool, PoolQuerySpec, PoolQuery>;
-        Filter: _wix_sdk_types.FilterFactory<Pool, PoolQuerySpec>;
-        Sort: _wix_sdk_types.SortFactory<PoolQuerySpec>;
-    };
+    query: _wix_sdk_types.QueryHelpers<Pool, PoolQuerySpec, PoolQuery>;
 };
 /**
  * Redeems a specified benefit.

package/build/internal/es/index.typings.mjs

@@ -560,6 +560,7 @@ var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
 var BenefitResultType = /* @__PURE__ */ ((BenefitResultType2) => {
   BenefitResultType2["ELIGIBLE_BENEFIT"] = "ELIGIBLE_BENEFIT";
   BenefitResultType2["NOT_ENOUGH_BALANCE"] = "NOT_ENOUGH_BALANCE";
+  BenefitResultType2["POLICY_EXPRESSION_EVALUATED_TO_FALSE"] = "POLICY_EXPRESSION_EVALUATED_TO_FALSE";
   BenefitResultType2["POOL_NOT_ACTIVE"] = "POOL_NOT_ACTIVE";
   BenefitResultType2["BENEFIT_NOT_FOUND"] = "BENEFIT_NOT_FOUND";
   BenefitResultType2["POOL_NOT_FOUND"] = "POOL_NOT_FOUND";
@@ -704,9 +705,7 @@ async function typedQueryPools(query, options) {
   }
 }
 var utils = {
-  query: {
-    ...createQueryUtils()
-  }
+  query: /* @__PURE__ */ createQueryUtils()
 };
 async function redeemBenefit2(poolId, options) {
   const { httpClient, sideEffects } = arguments[2];