@wix/auto_sdk_benefit-programs_pools 1.0.36 → 1.0.37

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

@@ -1739,7 +1739,6 @@ type GetEligibleBenefitsApplicationErrors = {
  * Retrieves a pool.
  * @param poolId - ID of the pool to retrieve.
  * @public
- * @documentationMaturity preview
  * @requiredField poolId
  * @permissionId BENEFIT_PROGRAMS.POOL_READ
  * @applicableIdentity APP
@@ -1757,7 +1756,6 @@ declare function getPool(poolId: string): Promise<NonNullablePaths<Pool, `status
  * and prevents unintended overwrites.
  * @param _id - Pool ID.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @requiredField pool
  * @requiredField pool.revision
@@ -1882,7 +1880,6 @@ interface UpdatePool {
  *
  *  For a full description of the item object, see the object returned for the `items` property in `PoolsQueryResult`.
  * @public
- * @documentationMaturity preview
  * @permissionId BENEFIT_PROGRAMS.POOL_READ
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool.PoolService.QueryPools
@@ -1904,65 +1901,46 @@ interface PoolsQueryResult extends QueryCursorResult {
 interface PoolsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     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;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     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;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     ge: (propertyName: '_id' | '_createdDate' | 'poolDefinitionId' | 'programDefinitionId' | 'programId' | '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.
-     * @documentationMaturity preview
      */
     gt: (propertyName: '_id' | '_createdDate' | 'poolDefinitionId' | 'programDefinitionId' | 'programId' | '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.
-     * @documentationMaturity preview
      */
     le: (propertyName: '_id' | '_createdDate' | 'poolDefinitionId' | 'programDefinitionId' | 'programId' | '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.
-     * @documentationMaturity preview
      */
     lt: (propertyName: '_id' | '_createdDate' | 'poolDefinitionId' | 'programDefinitionId' | 'programId' | '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 `string`.
      * @param string - String to compare against. Case-insensitive.
-     * @documentationMaturity preview
      */
     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.
-     * @documentationMaturity preview
      */
     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;
-    /** @documentationMaturity preview */
     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;
-    /** @documentationMaturity preview */
     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.
-     * @documentationMaturity preview
-     */
+    /** @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;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
     descending: (...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;
-    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
-     * @documentationMaturity preview
-     */
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
     limit: (limit: number) => PoolsQueryBuilder;
-    /** @param cursor - A pointer to specific record
-     * @documentationMaturity preview
-     */
+    /** @param cursor - A pointer to specific record */
     skipTo: (cursor: string) => PoolsQueryBuilder;
-    /** @documentationMaturity preview */
     find: () => Promise<PoolsQueryResult>;
 }
 /**
@@ -1971,7 +1949,6 @@ interface PoolsQueryBuilder {
  * Calling this method records redemption of the benefit and adjusts the pool's associated balance. You still need to handle providing the beneficiary with the item.
  * @param poolId - ID of the pool that contains the benefit to redeem.
  * @public
- * @documentationMaturity preview
  * @requiredField options.benefitKey
  * @requiredField options.idempotencyKey
  * @requiredField options.itemReference
@@ -2028,7 +2005,6 @@ interface RedeemBenefitOptions {
  * To be redeemed, a benefit's pool must be active and the associated balance must be greater than the cost of the benefit.
  * @param poolId - ID of the pool that the benefit to check belongs to.
  * @public
- * @documentationMaturity preview
  * @requiredField options.itemReference
  * @requiredField options.itemReference.externalId
  * @requiredField options.itemReference.providerAppId
@@ -2078,7 +2054,6 @@ interface CheckBenefitEligibilityOptions {
  *
  * 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.benefitSelectors.itemReference
  * @requiredField options.benefitSelectors.itemReference.externalId
  * @requiredField options.benefitSelectors.itemReference.providerAppId
@@ -2112,7 +2087,6 @@ interface BulkCheckBenefitEligibilityOptions {
  * This method checks each pool containing a benefit with this benefit item, and returns the benefits that can be redeemed.
  * @param itemReference - Item reference.
  * @public
- * @documentationMaturity preview
  * @requiredField itemReference
  * @requiredField itemReference.externalId
  * @requiredField itemReference.providerAppId
@@ -2150,7 +2124,6 @@ interface GetEligibleBenefitsOptions {
 /**
  * Updates pools.
  * @public
- * @documentationMaturity preview
  * @requiredField options.pools.pool
  * @requiredField options.pools.pool._id
  * @requiredField options.pools.pool.revision