@wix/auto_sdk_benefit-programs_pool-definitions 1.0.31 → 1.0.33

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

@@ -857,7 +857,6 @@ type RemovePoolDefinitionFromProgramDefinitionValidationErrors = {
  * Creates a pool definition.
  * @param poolDefinition - Pool definition to create.
  * @public
- * @documentationMaturity preview
  * @requiredField poolDefinition
  * @requiredField poolDefinition.details
  * @requiredField poolDefinition.details.benefits
@@ -882,7 +881,6 @@ interface CreatePoolDefinitionOptions {
  * Creates pool definitions.
  * @param poolDefinitions - Pool definitions to create.
  * @public
- * @documentationMaturity preview
  * @requiredField poolDefinitions
  * @requiredField poolDefinitions.details
  * @requiredField poolDefinitions.details.benefits
@@ -918,7 +916,6 @@ interface BulkCreatePoolDefinitionsOptions {
  * and prevents unintended overwrites.
  * @param _id - Pool definition ID.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @requiredField poolDefinition
  * @requiredField poolDefinition.revision
@@ -997,7 +994,6 @@ interface UpdatePoolDefinitionOptions {
 /**
  * Updates pool definitions.
  * @public
- * @documentationMaturity preview
  * @requiredField options.poolDefinitions.poolDefinition
  * @requiredField options.poolDefinitions.poolDefinition._id
  * @requiredField options.poolDefinitions.poolDefinition.revision
@@ -1029,7 +1025,6 @@ interface BulkUpdatePoolDefinitionsOptions {
  * @param poolDefinitionId - ID of the pool definition to delete.
  * @param cascade - *Required**. Determines when the changes to this pool definition the program definitions containing it will be applied to associated programs and pools.
  * @public
- * @documentationMaturity preview
  * @requiredField cascade
  * @requiredField poolDefinitionId
  * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_DELETE
@@ -1041,7 +1036,6 @@ declare function deletePoolDefinition(poolDefinitionId: string, cascade: Cascade
  * Deletes pool definitions.
  * @param poolDefinitionIds - List of IDs of the pool definitions to delete.
  * @public
- * @documentationMaturity preview
  * @requiredField poolDefinitionIds
  * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_DELETE
  * @applicableIdentity APP
@@ -1056,7 +1050,6 @@ interface BulkDeletePoolDefinitionsOptions {
  * Retrieves a pool definition.
  * @param poolDefinitionId - ID of the pool definition to retrieve.
  * @public
- * @documentationMaturity preview
  * @requiredField poolDefinitionId
  * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_READ
  * @applicableIdentity APP
@@ -1077,7 +1070,6 @@ declare function getPoolDefinition(poolDefinitionId: string): Promise<NonNullabl
  *
  *  For a full description of the item object, see the object returned for the `items` property in `PoolDefinitionsQueryResult`.
  * @public
- * @documentationMaturity preview
  * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_READ
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.QueryPoolDefinitions
@@ -1099,79 +1091,64 @@ interface PoolDefinitionsQueryResult extends QueryCursorResult {
 interface PoolDefinitionsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     eq: (propertyName: '_id' | '_createdDate' | 'programDefinitionIds' | '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.
-     * @documentationMaturity preview
      */
     ne: (propertyName: '_id' | '_createdDate' | 'programDefinitionIds' | '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.
-     * @documentationMaturity preview
      */
     ge: (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.
-     * @documentationMaturity preview
      */
     gt: (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.
-     * @documentationMaturity preview
      */
     le: (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.
-     * @documentationMaturity preview
      */
     lt: (propertyName: '_id' | '_createdDate' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace', value: any) => PoolDefinitionsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `string`.
      * @param string - String to compare against. Case-insensitive.
-     * @documentationMaturity preview
      */
     startsWith: (propertyName: '_id' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace', value: string) => PoolDefinitionsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `values`.
      * @param values - List of values to compare against.
-     * @documentationMaturity preview
      */
     hasSome: (propertyName: '_id' | '_createdDate' | 'programDefinitionIds' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace', value: any[]) => PoolDefinitionsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `values`.
      * @param values - List of values to compare against.
-     * @documentationMaturity preview
      */
     hasAll: (propertyName: 'programDefinitionIds', value: any[]) => PoolDefinitionsQueryBuilder;
-    /** @documentationMaturity preview */
     in: (propertyName: '_id' | '_createdDate' | 'programDefinitionIds' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace', value: any) => PoolDefinitionsQueryBuilder;
-    /** @documentationMaturity preview */
     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.
-     * @documentationMaturity preview
-     */
+    /** @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;
-    /** @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' | 'programDefinitionIds' | 'details.benefits.itemSetId' | 'details.benefits.providerAppId' | 'namespace'>) => PoolDefinitionsQueryBuilder;
-    /** @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) => PoolDefinitionsQueryBuilder;
-    /** @param cursor - A pointer to specific record
-     * @documentationMaturity preview
-     */
+    /** @param cursor - A pointer to specific record */
     skipTo: (cursor: string) => PoolDefinitionsQueryBuilder;
-    /** @documentationMaturity preview */
     find: () => Promise<PoolDefinitionsQueryResult>;
 }
+/**
+ * @hidden
+ * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.QueryPoolDefinitions
+ * @requiredField query
+ */
+declare function typedQueryPoolDefinitions(query: CursorQuery): Promise<NonNullablePaths<QueryPoolDefinitionsResponse, `poolDefinitions` | `poolDefinitions.${number}.displayName` | `poolDefinitions.${number}.details.creditConfiguration.amount`, 6>>;
 /**
  * Adds a pool definition to a program definition.
  *
  * Pool definitions can be contained by multiple program definitions, so this doesn't affect other program definitions that contain this pool definition.
  * @param poolDefinitionId - ID of the pool definition to add to the program definition.
  * @public
- * @documentationMaturity preview
  * @requiredField options
  * @requiredField options.cascade
  * @requiredField options.programDefinitionId
@@ -1198,7 +1175,6 @@ interface AddPoolDefinitionToProgramDefinitionOptions {
  * Pool definitions don't need to be contained by a program definition, so this doesn't affect the usability of this pool definition.
  * @param poolDefinitionId - ID of the pool definition to remove from the program definition.
  * @public
- * @documentationMaturity preview
  * @requiredField options
  * @requiredField options.cascade
  * @requiredField options.programDefinitionId
@@ -1223,7 +1199,6 @@ interface RemovePoolDefinitionFromProgramDefinitionOptions {
  * Retrieve all a program definition's pool definitions.
  * @param programDefinitionId - ID of the program definition to retrieve its pool definitions.
  * @public
- * @documentationMaturity preview
  * @requiredField options
  * @requiredField options.namespace
  * @requiredField programDefinitionId
@@ -1241,4 +1216,4 @@ interface FindPoolDefinitionsByProgramDefinitionOptions {
     namespace: string;
 }
 
-export { type ActionEvent, type AddPoolDefinitionToProgramDefinitionOptions, type AddPoolDefinitionToProgramDefinitionRequest, type AddPoolDefinitionToProgramDefinitionResponse, type AddPoolDefinitionToProgramDefinitionValidationErrors, type ApplicationError, type Benefit, type BulkActionMetadata, type BulkCreatePoolDefinitionsOptions, type BulkCreatePoolDefinitionsRequest, type BulkCreatePoolDefinitionsResponse, type BulkDeletePoolDefinitionsOptions, type BulkDeletePoolDefinitionsRequest, type BulkDeletePoolDefinitionsResponse, type BulkPoolDefinitionResult, type BulkUpdatePoolDefinitionsOptions, type BulkUpdatePoolDefinitionsRequest, type BulkUpdatePoolDefinitionsResponse, type BulkUpdatePoolDefinitionsValidationErrors, Cascade, type CascadeWithLiterals, type CreatePoolDefinitionOptions, type CreatePoolDefinitionRequest, type CreatePoolDefinitionResponse, type CreditConfiguration, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomPolicy, type DeletePoolDefinitionRequest, type DeletePoolDefinitionResponse, type Details, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type FindPoolDefinitionsByProgramDefinitionOptions, type FindPoolDefinitionsByProgramDefinitionRequest, type FindPoolDefinitionsByProgramDefinitionResponse, type FixedIntervalPolicy, type GetPoolDefinitionRequest, type GetPoolDefinitionResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MaskedPoolDefinition, type MessageEnvelope, type Policy, type PolicyExpression, type PolicyExpressionAnd, type PolicyExpressionExpressionOneOf, type PolicyExpressionNot, type PolicyExpressionOr, PolicyExpressionType, type PolicyExpressionTypeWithLiterals, type PolicyPolicyOneOf, type PoolDefinition, type PoolDefinitionAddedToProgramDefinition, type PoolDefinitionDeletedProxySupport, type PoolDefinitionRemovedFromProgramDefinition, type PoolDefinitionUpdatedProxySupport, type PoolDefinitionsQueryBuilder, type PoolDefinitionsQueryResult, type ProgramDefinitionInfo, type QueryPoolDefinitionsRequest, type QueryPoolDefinitionsResponse, type RateLimitedPolicy, type RateLimitedPolicyPeriodOneOf, RateLimitedPolicyType, type RateLimitedPolicyTypeWithLiterals, type RemovePoolDefinitionFromProgramDefinitionOptions, type RemovePoolDefinitionFromProgramDefinitionRequest, type RemovePoolDefinitionFromProgramDefinitionResponse, type RemovePoolDefinitionFromProgramDefinitionValidationErrors, type RestoreInfo, type RolloverConfiguration, SortOrder, type SortOrderWithLiterals, type Sorting, Type, type TypeWithLiterals, type UpdatePoolDefinition, type UpdatePoolDefinitionOptions, type UpdatePoolDefinitionRequest, type UpdatePoolDefinitionResponse, type UpdatePoolDefinitionValidationErrors, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeekDay, type WeekDayWithLiterals, addPoolDefinitionToProgramDefinition, bulkCreatePoolDefinitions, bulkDeletePoolDefinitions, bulkUpdatePoolDefinitions, createPoolDefinition, deletePoolDefinition, findPoolDefinitionsByProgramDefinition, getPoolDefinition, queryPoolDefinitions, removePoolDefinitionFromProgramDefinition, updatePoolDefinition };
+export { type ActionEvent, type AddPoolDefinitionToProgramDefinitionOptions, type AddPoolDefinitionToProgramDefinitionRequest, type AddPoolDefinitionToProgramDefinitionResponse, type AddPoolDefinitionToProgramDefinitionValidationErrors, type ApplicationError, type Benefit, type BulkActionMetadata, type BulkCreatePoolDefinitionsOptions, type BulkCreatePoolDefinitionsRequest, type BulkCreatePoolDefinitionsResponse, type BulkDeletePoolDefinitionsOptions, type BulkDeletePoolDefinitionsRequest, type BulkDeletePoolDefinitionsResponse, type BulkPoolDefinitionResult, type BulkUpdatePoolDefinitionsOptions, type BulkUpdatePoolDefinitionsRequest, type BulkUpdatePoolDefinitionsResponse, type BulkUpdatePoolDefinitionsValidationErrors, Cascade, type CascadeWithLiterals, type CreatePoolDefinitionOptions, type CreatePoolDefinitionRequest, type CreatePoolDefinitionResponse, type CreditConfiguration, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomPolicy, type DeletePoolDefinitionRequest, type DeletePoolDefinitionResponse, type Details, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type FindPoolDefinitionsByProgramDefinitionOptions, type FindPoolDefinitionsByProgramDefinitionRequest, type FindPoolDefinitionsByProgramDefinitionResponse, type FixedIntervalPolicy, type GetPoolDefinitionRequest, type GetPoolDefinitionResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MaskedPoolDefinition, type MessageEnvelope, type Policy, type PolicyExpression, type PolicyExpressionAnd, type PolicyExpressionExpressionOneOf, type PolicyExpressionNot, type PolicyExpressionOr, PolicyExpressionType, type PolicyExpressionTypeWithLiterals, type PolicyPolicyOneOf, type PoolDefinition, type PoolDefinitionAddedToProgramDefinition, type PoolDefinitionDeletedProxySupport, type PoolDefinitionRemovedFromProgramDefinition, type PoolDefinitionUpdatedProxySupport, type PoolDefinitionsQueryBuilder, type PoolDefinitionsQueryResult, type ProgramDefinitionInfo, type QueryPoolDefinitionsRequest, type QueryPoolDefinitionsResponse, type RateLimitedPolicy, type RateLimitedPolicyPeriodOneOf, RateLimitedPolicyType, type RateLimitedPolicyTypeWithLiterals, type RemovePoolDefinitionFromProgramDefinitionOptions, type RemovePoolDefinitionFromProgramDefinitionRequest, type RemovePoolDefinitionFromProgramDefinitionResponse, type RemovePoolDefinitionFromProgramDefinitionValidationErrors, type RestoreInfo, type RolloverConfiguration, SortOrder, type SortOrderWithLiterals, type Sorting, Type, type TypeWithLiterals, type UpdatePoolDefinition, type UpdatePoolDefinitionOptions, type UpdatePoolDefinitionRequest, type UpdatePoolDefinitionResponse, type UpdatePoolDefinitionValidationErrors, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeekDay, type WeekDayWithLiterals, addPoolDefinitionToProgramDefinition, bulkCreatePoolDefinitions, bulkDeletePoolDefinitions, bulkUpdatePoolDefinitions, createPoolDefinition, deletePoolDefinition, findPoolDefinitionsByProgramDefinition, getPoolDefinition, queryPoolDefinitions, removePoolDefinitionFromProgramDefinition, typedQueryPoolDefinitions, updatePoolDefinition };

package/build/cjs/index.typings.js

@@ -37,6 +37,7 @@ __export(index_typings_exports, {
   getPoolDefinition: () => getPoolDefinition2,
   queryPoolDefinitions: () => queryPoolDefinitions2,
   removePoolDefinitionFromProgramDefinition: () => removePoolDefinitionFromProgramDefinition2,
+  typedQueryPoolDefinitions: () => typedQueryPoolDefinitions,
   updatePoolDefinition: () => updatePoolDefinition2
 });
 module.exports = __toCommonJS(index_typings_exports);
@@ -861,6 +862,29 @@ function queryPoolDefinitions2() {
     transformationPaths: {}
   });
 }
+async function typedQueryPoolDefinitions(query) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({ query });
+  const reqOpts = queryPoolDefinitions(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: { query: "$[0]" },
+        singleArgumentUnchanged: false
+      },
+      ["query"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 async function addPoolDefinitionToProgramDefinition2(poolDefinitionId, options) {
   const { httpClient, sideEffects } = arguments[2];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
@@ -977,6 +1001,7 @@ async function findPoolDefinitionsByProgramDefinition2(programDefinitionId, opti
   getPoolDefinition,
   queryPoolDefinitions,
   removePoolDefinitionFromProgramDefinition,
+  typedQueryPoolDefinitions,
   updatePoolDefinition
 });
 //# sourceMappingURL=index.typings.js.map