@wix/auto_sdk_benefit-programs_pool-definitions 1.0.23 → 1.0.24

package/build/cjs/index.d.ts

@@ -1,6 +1,6 @@
-import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
-import { P as PoolDefinition, C as CreatePoolDefinitionOptions, B as BulkCreatePoolDefinitionsOptions, a as BulkCreatePoolDefinitionsResponse, U as UpdatePoolDefinition, b as UpdatePoolDefinitionOptions, c as BulkUpdatePoolDefinitionsOptions, d as BulkUpdatePoolDefinitionsResponse, D as DeletePoolDefinitionOptions, e as BulkDeletePoolDefinitionsOptions, f as BulkDeletePoolDefinitionsResponse, g as PoolDefinitionsQueryBuilder, A as AddPoolDefinitionToProgramDefinitionOptions, h as AddPoolDefinitionToProgramDefinitionResponse, R as RemovePoolDefinitionFromProgramDefinitionOptions, i as RemovePoolDefinitionFromProgramDefinitionResponse, F as FindPoolDefinitionsByProgramDefinitionOptions, j as FindPoolDefinitionsByProgramDefinitionResponse } from './benefit-programs-v1-pool-definition-pool-definitions.universal-DxzRfpcA.js';
-export { ap as ActionEvent, ag as AddPoolDefinitionToProgramDefinitionRequest, Z as ApplicationError, p as Benefit, _ as BulkActionMetadata, V as BulkCreatePoolDefinitionsRequest, a5 as BulkDeletePoolDefinitionsRequest, X as BulkPoolDefinitionResult, a1 as BulkUpdatePoolDefinitionsRequest, m as Cascade, O as CreatePoolDefinitionRequest, Q as CreatePoolDefinitionResponse, G as CreditConfiguration, ac as CursorPaging, ae as CursorPagingMetadata, a9 as CursorQuery, aa as CursorQueryPagingMethodOneOf, af as Cursors, E as CustomPolicy, a3 as DeletePoolDefinitionRequest, a4 as DeletePoolDefinitionResponse, o as Details, aj as DomainEvent, ak as DomainEventBodyOneOf, al as EntityCreatedEvent, ao as EntityDeletedEvent, an as EntityUpdatedEvent, I as ExtendedFields, ai as FindPoolDefinitionsByProgramDefinitionRequest, x as FixedIntervalPolicy, a6 as GetPoolDefinitionRequest, a7 as GetPoolDefinitionResponse, ar as IdentificationData, as as IdentificationDataIdOneOf, Y as ItemMetadata, a2 as MaskedPoolDefinition, aq as MessageEnvelope, v as Policy, q as PolicyExpression, t as PolicyExpressionAnd, r as PolicyExpressionExpressionOneOf, s as PolicyExpressionNot, u as PolicyExpressionOr, k as PolicyExpressionType, w as PolicyPolicyOneOf, K as PoolDefinitionAddedToProgramDefinition, N as PoolDefinitionDeletedProxySupport, L as PoolDefinitionRemovedFromProgramDefinition, M as PoolDefinitionUpdatedProxySupport, at as PoolDefinitionsQueryResult, J as ProgramDefinitionInfo, a8 as QueryPoolDefinitionsRequest, ad as QueryPoolDefinitionsResponse, y as RateLimitedPolicy, z as RateLimitedPolicyPeriodOneOf, l as RateLimitedPolicyType, ah as RemovePoolDefinitionFromProgramDefinitionRequest, am as RestoreInfo, H as RolloverConfiguration, S as SortOrder, ab as Sorting, T as Type, $ as UpdatePoolDefinitionRequest, a0 as UpdatePoolDefinitionResponse, n as WebhookIdentityType, W as WeekDay } from './benefit-programs-v1-pool-definition-pool-definitions.universal-DxzRfpcA.js';
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { PoolDefinition, CreatePoolDefinitionOptions, BulkCreatePoolDefinitionsOptions, BulkCreatePoolDefinitionsResponse, UpdatePoolDefinition, UpdatePoolDefinitionOptions, UpdatePoolDefinitionValidationErrors, BulkUpdatePoolDefinitionsOptions, BulkUpdatePoolDefinitionsResponse, BulkUpdatePoolDefinitionsValidationErrors, DeletePoolDefinitionOptions, BulkDeletePoolDefinitionsOptions, BulkDeletePoolDefinitionsResponse, PoolDefinitionsQueryBuilder, AddPoolDefinitionToProgramDefinitionOptions, AddPoolDefinitionToProgramDefinitionResponse, AddPoolDefinitionToProgramDefinitionValidationErrors, RemovePoolDefinitionFromProgramDefinitionOptions, RemovePoolDefinitionFromProgramDefinitionResponse, RemovePoolDefinitionFromProgramDefinitionValidationErrors, FindPoolDefinitionsByProgramDefinitionOptions, FindPoolDefinitionsByProgramDefinitionResponse } from './index.typings.js';
+export { ActionEvent, AddPoolDefinitionToProgramDefinitionRequest, ApplicationError, Benefit, BulkActionMetadata, BulkCreatePoolDefinitionsRequest, BulkDeletePoolDefinitionsRequest, BulkPoolDefinitionResult, BulkUpdatePoolDefinitionsRequest, Cascade, CascadeWithLiterals, CreatePoolDefinitionRequest, CreatePoolDefinitionResponse, CreditConfiguration, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, CustomPolicy, DeletePoolDefinitionRequest, DeletePoolDefinitionResponse, Details, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, ExtendedFields, FindPoolDefinitionsByProgramDefinitionRequest, FixedIntervalPolicy, GetPoolDefinitionRequest, GetPoolDefinitionResponse, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, MaskedPoolDefinition, MessageEnvelope, Policy, PolicyExpression, PolicyExpressionAnd, PolicyExpressionExpressionOneOf, PolicyExpressionNot, PolicyExpressionOr, PolicyExpressionType, PolicyExpressionTypeWithLiterals, PolicyPolicyOneOf, PoolDefinitionAddedToProgramDefinition, PoolDefinitionDeletedProxySupport, PoolDefinitionRemovedFromProgramDefinition, PoolDefinitionUpdatedProxySupport, PoolDefinitionsQueryResult, ProgramDefinitionInfo, QueryPoolDefinitionsRequest, QueryPoolDefinitionsResponse, RateLimitedPolicy, RateLimitedPolicyPeriodOneOf, RateLimitedPolicyType, RateLimitedPolicyTypeWithLiterals, RemovePoolDefinitionFromProgramDefinitionRequest, RestoreInfo, RolloverConfiguration, SortOrder, SortOrderWithLiterals, Sorting, Type, TypeWithLiterals, UpdatePoolDefinitionRequest, UpdatePoolDefinitionResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WeekDay, WeekDayWithLiterals } from './index.typings.js';
 
 declare function createPoolDefinition$1(httpClient: HttpClient): CreatePoolDefinitionSignature;
 interface CreatePoolDefinitionSignature {
@@ -9,7 +9,7 @@ interface CreatePoolDefinitionSignature {
      * @param - Pool definition to create.
      * @returns Created pool definition.
      */
-    (poolDefinition: PoolDefinition, options?: CreatePoolDefinitionOptions | undefined): Promise<PoolDefinition>;
+    (poolDefinition: NonNullablePaths<PoolDefinition, `details` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.benefits.${number}.providerAppId` | `namespace`, 5>, options?: CreatePoolDefinitionOptions): Promise<NonNullablePaths<PoolDefinition, `displayName` | `programDefinitionIds` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.creditConfiguration.amount` | `programDefinitions` | `programDefinitions.${number}._id`, 5>>;
 }
 declare function bulkCreatePoolDefinitions$1(httpClient: HttpClient): BulkCreatePoolDefinitionsSignature;
 interface BulkCreatePoolDefinitionsSignature {
@@ -17,7 +17,7 @@ interface BulkCreatePoolDefinitionsSignature {
      * Creates pool definitions.
      * @param - Pool definitions to create.
      */
-    (poolDefinitions: PoolDefinition[], options?: BulkCreatePoolDefinitionsOptions | undefined): Promise<BulkCreatePoolDefinitionsResponse>;
+    (poolDefinitions: NonNullablePaths<PoolDefinition, `details` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.benefits.${number}.providerAppId` | `namespace`, 5>[], options?: BulkCreatePoolDefinitionsOptions): Promise<NonNullablePaths<BulkCreatePoolDefinitionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.poolDefinition.displayName` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
 }
 declare function updatePoolDefinition$1(httpClient: HttpClient): UpdatePoolDefinitionSignature;
 interface UpdatePoolDefinitionSignature {
@@ -32,14 +32,18 @@ interface UpdatePoolDefinitionSignature {
      * @param - Pool definition ID.
      * @returns Updated pool definition.
      */
-    (_id: string, poolDefinition: UpdatePoolDefinition, options?: UpdatePoolDefinitionOptions | undefined): Promise<PoolDefinition>;
+    (_id: string, poolDefinition: NonNullablePaths<UpdatePoolDefinition, `revision`, 2>, options?: UpdatePoolDefinitionOptions): Promise<NonNullablePaths<PoolDefinition, `displayName` | `programDefinitionIds` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.creditConfiguration.amount` | `programDefinitions` | `programDefinitions.${number}._id`, 5> & {
+        __validationErrorsType?: UpdatePoolDefinitionValidationErrors;
+    }>;
 }
 declare function bulkUpdatePoolDefinitions$1(httpClient: HttpClient): BulkUpdatePoolDefinitionsSignature;
 interface BulkUpdatePoolDefinitionsSignature {
     /**
      * Updates pool definitions.
      */
-    (options?: BulkUpdatePoolDefinitionsOptions | undefined): Promise<BulkUpdatePoolDefinitionsResponse>;
+    (options?: NonNullablePaths<BulkUpdatePoolDefinitionsOptions, `poolDefinitions.${number}.poolDefinition` | `poolDefinitions.${number}.poolDefinition._id` | `poolDefinitions.${number}.poolDefinition.revision`, 5>): Promise<NonNullablePaths<BulkUpdatePoolDefinitionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.poolDefinition.displayName` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
+        __validationErrorsType?: BulkUpdatePoolDefinitionsValidationErrors;
+    }>;
 }
 declare function deletePoolDefinition$1(httpClient: HttpClient): DeletePoolDefinitionSignature;
 interface DeletePoolDefinitionSignature {
@@ -47,7 +51,7 @@ interface DeletePoolDefinitionSignature {
      * Deletes a pool definition.
      * @param - ID of the pool definition to delete.
      */
-    (poolDefinitionId: string, options?: DeletePoolDefinitionOptions | undefined): Promise<void>;
+    (poolDefinitionId: string, options?: DeletePoolDefinitionOptions): Promise<void>;
 }
 declare function bulkDeletePoolDefinitions$1(httpClient: HttpClient): BulkDeletePoolDefinitionsSignature;
 interface BulkDeletePoolDefinitionsSignature {
@@ -55,7 +59,7 @@ interface BulkDeletePoolDefinitionsSignature {
      * Deletes pool definitions.
      * @param - List of IDs of the pool definitions to delete.
      */
-    (poolDefinitionIds: string[], options?: BulkDeletePoolDefinitionsOptions | undefined): Promise<BulkDeletePoolDefinitionsResponse>;
+    (poolDefinitionIds: string[], options?: BulkDeletePoolDefinitionsOptions): Promise<NonNullablePaths<BulkDeletePoolDefinitionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.poolDefinition.displayName` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
 }
 declare function getPoolDefinition$1(httpClient: HttpClient): GetPoolDefinitionSignature;
 interface GetPoolDefinitionSignature {
@@ -64,7 +68,7 @@ interface GetPoolDefinitionSignature {
      * @param - ID of the pool definition to retrieve.
      * @returns Retrieved pool definition.
      */
-    (poolDefinitionId: string): Promise<PoolDefinition>;
+    (poolDefinitionId: string): Promise<NonNullablePaths<PoolDefinition, `displayName` | `programDefinitionIds` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.creditConfiguration.amount` | `programDefinitions` | `programDefinitions.${number}._id`, 5>>;
 }
 declare function queryPoolDefinitions$1(httpClient: HttpClient): QueryPoolDefinitionsSignature;
 interface QueryPoolDefinitionsSignature {
@@ -91,7 +95,9 @@ interface AddPoolDefinitionToProgramDefinitionSignature {
      * Pool definitions can be contained by multiple program definitions, so this doesn't affect other program definitions that contain this pool definition.
      * @param - ID of the pool definition to add to the program definition.
      */
-    (poolDefinitionId: string, options: AddPoolDefinitionToProgramDefinitionOptions): Promise<AddPoolDefinitionToProgramDefinitionResponse>;
+    (poolDefinitionId: string, options: NonNullablePaths<AddPoolDefinitionToProgramDefinitionOptions, `cascade` | `programDefinitionId`, 2>): Promise<NonNullablePaths<AddPoolDefinitionToProgramDefinitionResponse, `poolDefinition.displayName` | `poolDefinition.programDefinitionIds` | `poolDefinition.details.benefits` | `poolDefinition.details.benefits.${number}.benefitKey` | `poolDefinition.details.creditConfiguration.amount` | `poolDefinition.programDefinitions` | `poolDefinition.programDefinitions.${number}._id`, 6> & {
+        __validationErrorsType?: AddPoolDefinitionToProgramDefinitionValidationErrors;
+    }>;
 }
 declare function removePoolDefinitionFromProgramDefinition$1(httpClient: HttpClient): RemovePoolDefinitionFromProgramDefinitionSignature;
 interface RemovePoolDefinitionFromProgramDefinitionSignature {
@@ -101,7 +107,9 @@ interface RemovePoolDefinitionFromProgramDefinitionSignature {
      * Pool definitions don't need to be contained by a program definition, so this doesn't affect the usability of this pool definition.
      * @param - ID of the pool definition to remove from the program definition.
      */
-    (poolDefinitionId: string, options: RemovePoolDefinitionFromProgramDefinitionOptions): Promise<RemovePoolDefinitionFromProgramDefinitionResponse>;
+    (poolDefinitionId: string, options: NonNullablePaths<RemovePoolDefinitionFromProgramDefinitionOptions, `cascade` | `programDefinitionId`, 2>): Promise<NonNullablePaths<RemovePoolDefinitionFromProgramDefinitionResponse, `poolDefinition.displayName` | `poolDefinition.programDefinitionIds` | `poolDefinition.details.benefits` | `poolDefinition.details.benefits.${number}.benefitKey` | `poolDefinition.details.creditConfiguration.amount` | `poolDefinition.programDefinitions` | `poolDefinition.programDefinitions.${number}._id`, 6> & {
+        __validationErrorsType?: RemovePoolDefinitionFromProgramDefinitionValidationErrors;
+    }>;
 }
 declare function findPoolDefinitionsByProgramDefinition$1(httpClient: HttpClient): FindPoolDefinitionsByProgramDefinitionSignature;
 interface FindPoolDefinitionsByProgramDefinitionSignature {
@@ -109,7 +117,7 @@ interface FindPoolDefinitionsByProgramDefinitionSignature {
      * Retrieve all a program definition's pool definitions.
      * @param - ID of the program definition to retrieve its pool definitions.
      */
-    (programDefinitionId: string, options: FindPoolDefinitionsByProgramDefinitionOptions): Promise<FindPoolDefinitionsByProgramDefinitionResponse>;
+    (programDefinitionId: string, options: NonNullablePaths<FindPoolDefinitionsByProgramDefinitionOptions, `namespace`, 2>): Promise<NonNullablePaths<FindPoolDefinitionsByProgramDefinitionResponse, `poolDefinitions` | `poolDefinitions.${number}.displayName` | `poolDefinitions.${number}.details.creditConfiguration.amount`, 6>>;
 }
 
 declare const createPoolDefinition: MaybeContext<BuildRESTFunction<typeof createPoolDefinition$1> & typeof createPoolDefinition$1>;
@@ -124,4 +132,4 @@ declare const addPoolDefinitionToProgramDefinition: MaybeContext<BuildRESTFuncti
 declare const removePoolDefinitionFromProgramDefinition: MaybeContext<BuildRESTFunction<typeof removePoolDefinitionFromProgramDefinition$1> & typeof removePoolDefinitionFromProgramDefinition$1>;
 declare const findPoolDefinitionsByProgramDefinition: MaybeContext<BuildRESTFunction<typeof findPoolDefinitionsByProgramDefinition$1> & typeof findPoolDefinitionsByProgramDefinition$1>;
 
-export { AddPoolDefinitionToProgramDefinitionOptions, AddPoolDefinitionToProgramDefinitionResponse, BulkCreatePoolDefinitionsOptions, BulkCreatePoolDefinitionsResponse, BulkDeletePoolDefinitionsOptions, BulkDeletePoolDefinitionsResponse, BulkUpdatePoolDefinitionsOptions, BulkUpdatePoolDefinitionsResponse, CreatePoolDefinitionOptions, DeletePoolDefinitionOptions, FindPoolDefinitionsByProgramDefinitionOptions, FindPoolDefinitionsByProgramDefinitionResponse, PoolDefinition, PoolDefinitionsQueryBuilder, RemovePoolDefinitionFromProgramDefinitionOptions, RemovePoolDefinitionFromProgramDefinitionResponse, UpdatePoolDefinition, UpdatePoolDefinitionOptions, addPoolDefinitionToProgramDefinition, bulkCreatePoolDefinitions, bulkDeletePoolDefinitions, bulkUpdatePoolDefinitions, createPoolDefinition, deletePoolDefinition, findPoolDefinitionsByProgramDefinition, getPoolDefinition, queryPoolDefinitions, removePoolDefinitionFromProgramDefinition, updatePoolDefinition };
+export { AddPoolDefinitionToProgramDefinitionOptions, AddPoolDefinitionToProgramDefinitionResponse, AddPoolDefinitionToProgramDefinitionValidationErrors, BulkCreatePoolDefinitionsOptions, BulkCreatePoolDefinitionsResponse, BulkDeletePoolDefinitionsOptions, BulkDeletePoolDefinitionsResponse, BulkUpdatePoolDefinitionsOptions, BulkUpdatePoolDefinitionsResponse, BulkUpdatePoolDefinitionsValidationErrors, CreatePoolDefinitionOptions, DeletePoolDefinitionOptions, FindPoolDefinitionsByProgramDefinitionOptions, FindPoolDefinitionsByProgramDefinitionResponse, PoolDefinition, PoolDefinitionsQueryBuilder, RemovePoolDefinitionFromProgramDefinitionOptions, RemovePoolDefinitionFromProgramDefinitionResponse, RemovePoolDefinitionFromProgramDefinitionValidationErrors, UpdatePoolDefinition, UpdatePoolDefinitionOptions, UpdatePoolDefinitionValidationErrors, addPoolDefinitionToProgramDefinition, bulkCreatePoolDefinitions, bulkDeletePoolDefinitions, bulkUpdatePoolDefinitions, createPoolDefinition, deletePoolDefinition, findPoolDefinitionsByProgramDefinition, getPoolDefinition, queryPoolDefinitions, removePoolDefinitionFromProgramDefinition, updatePoolDefinition };