@wix/auto_sdk_benefit-programs_pool-definitions 1.0.23 → 1.0.24

package/build/es/{benefit-programs-v1-pool-definition-pool-definitions.universal-DxzRfpcA.d.mts → index.typings.d.mts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface PoolDefinition {
     /**
      * Pool definition ID.
@@ -827,6 +829,43 @@ declare enum WebhookIdentityType {
 }
 /** @enumType */
 type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+type UpdatePoolDefinitionValidationErrors = {
+    ruleName?: 'cascade_is_required';
+} | {
+    ruleName?: 'cascade_value_not_supported';
+};
+type BulkUpdatePoolDefinitionsValidationErrors = {
+    ruleName?: 'cascade_is_required';
+} | {
+    ruleName?: 'cascade_value_not_supported';
+};
+type AddPoolDefinitionToProgramDefinitionValidationErrors = {
+    ruleName?: 'cascade_is_required';
+} | {
+    ruleName?: 'cascade_value_not_supported';
+};
+type RemovePoolDefinitionFromProgramDefinitionValidationErrors = {
+    ruleName?: 'cascade_is_required';
+} | {
+    ruleName?: 'cascade_value_not_supported';
+};
+/**
+ * Creates a pool definition.
+ * @param poolDefinition - Pool definition to create.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField poolDefinition
+ * @requiredField poolDefinition.details
+ * @requiredField poolDefinition.details.benefits
+ * @requiredField poolDefinition.details.benefits.benefitKey
+ * @requiredField poolDefinition.details.benefits.providerAppId
+ * @requiredField poolDefinition.namespace
+ * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_CREATE
+ * @applicableIdentity APP
+ * @returns Created pool definition.
+ * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.CreatePoolDefinition
+ */
+declare function createPoolDefinition(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>>;
 interface CreatePoolDefinitionOptions {
     /**
      * Determines when the changes to the program definitions containing this pool definition will be applied to associated programs.
@@ -835,6 +874,22 @@ interface CreatePoolDefinitionOptions {
      */
     cascade?: CascadeWithLiterals;
 }
+/**
+ * Creates pool definitions.
+ * @param poolDefinitions - Pool definitions to create.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField poolDefinitions
+ * @requiredField poolDefinitions.details
+ * @requiredField poolDefinitions.details.benefits
+ * @requiredField poolDefinitions.details.benefits.benefitKey
+ * @requiredField poolDefinitions.details.benefits.providerAppId
+ * @requiredField poolDefinitions.namespace
+ * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_CREATE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.BulkCreatePoolDefinitions
+ */
+declare function bulkCreatePoolDefinitions(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>>;
 interface BulkCreatePoolDefinitionsOptions {
     /**
      * Determines when the changes to the program definitions containing these pool definitions will be applied to associated programs.
@@ -849,6 +904,28 @@ interface BulkCreatePoolDefinitionsOptions {
      */
     returnEntity?: boolean;
 }
+/**
+ * Updates a pool definition.
+ *
+ * Each time the pool definition is updated,
+ * `revision` increments by 1.
+ * The current `revision` must be passed when updating the pool definition.
+ * This ensures you're working with the latest pool definition
+ * and prevents unintended overwrites.
+ * @param _id - Pool definition ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField poolDefinition
+ * @requiredField poolDefinition.revision
+ * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
+ * @applicableIdentity APP
+ * @returns Updated pool definition.
+ * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.UpdatePoolDefinition
+ */
+declare function updatePoolDefinition(_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;
+}>;
 interface UpdatePoolDefinition {
     /**
      * Pool definition ID.
@@ -913,6 +990,20 @@ interface UpdatePoolDefinitionOptions {
     /** Required.** Determines when the changes to this pool definition and program definitions containing it will be applied to associated programs and pools. */
     cascade?: CascadeWithLiterals;
 }
+/**
+ * Updates pool definitions.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.poolDefinitions.poolDefinition
+ * @requiredField options.poolDefinitions.poolDefinition._id
+ * @requiredField options.poolDefinitions.poolDefinition.revision
+ * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.BulkUpdatePoolDefinitions
+ */
+declare function bulkUpdatePoolDefinitions(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;
+}>;
 interface BulkUpdatePoolDefinitionsOptions {
     /**
      * Pool definitions to update.
@@ -929,14 +1020,69 @@ interface BulkUpdatePoolDefinitionsOptions {
      */
     returnEntity?: boolean;
 }
+/**
+ * Deletes a pool definition.
+ * @param poolDefinitionId - ID of the pool definition to delete.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField poolDefinitionId
+ * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_DELETE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.DeletePoolDefinition
+ */
+declare function deletePoolDefinition(poolDefinitionId: string, options?: DeletePoolDefinitionOptions): Promise<void>;
 interface DeletePoolDefinitionOptions {
     /** Required**. Determines when the changes to this pool definition the program definitions containing it will be applied to associated programs and pools. */
     cascade?: CascadeWithLiterals;
 }
+/**
+ * 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
+ * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.BulkDeletePoolDefinitions
+ */
+declare function bulkDeletePoolDefinitions(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>>;
 interface BulkDeletePoolDefinitionsOptions {
     /** Required**. Determines when the changes to these pool definitions the program definitions containing it will be applied to associated programs and pools. */
     cascade?: CascadeWithLiterals;
 }
+/**
+ * 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
+ * @applicableIdentity VISITOR
+ * @returns Retrieved pool definition.
+ * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.GetPoolDefinition
+ */
+declare function getPoolDefinition(poolDefinitionId: string): Promise<NonNullablePaths<PoolDefinition, `displayName` | `programDefinitionIds` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.creditConfiguration.amount` | `programDefinitions` | `programDefinitions.${number}._id`, 5>>;
+/**
+ * Creates a query to retrieve a list of pool definitions.
+ *
+ * The Query Pool Definitions method builds a query to retrieve a list of pool definitions and returns a `PoolDefinitionsQueryBuilder` object.
+ *
+ * The returned object contains the query definition, which is used to run the query using the `find()` method.
+ *
+ * You can refine the query by chaining `PoolDefinitionsQueryBuilder` methods onto the query. `PoolDefinitionsQueryBuilder` methods enable you to filter, sort, and control the results that Query Pool Definitions returns.
+ *
+ * Query Pool Definitions has a default paging limit of 50, which you can override.
+ *
+ *  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
+ * @applicableIdentity VISITOR
+ * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.QueryPoolDefinitions
+ */
+declare function queryPoolDefinitions(): PoolDefinitionsQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -1019,6 +1165,24 @@ interface PoolDefinitionsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<PoolDefinitionsQueryResult>;
 }
+/**
+ * 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
+ * @requiredField poolDefinitionId
+ * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.AddPoolDefinitionToProgramDefinition
+ */
+declare function addPoolDefinitionToProgramDefinition(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;
+}>;
 interface AddPoolDefinitionToProgramDefinitionOptions {
     /**
      * ID of the program definition to add the pool definition to.
@@ -1028,6 +1192,24 @@ interface AddPoolDefinitionToProgramDefinitionOptions {
     /** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
     cascade: CascadeWithLiterals;
 }
+/**
+ * Removes a pool definition from a program definition.
+ *
+ * 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
+ * @requiredField poolDefinitionId
+ * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.RemovePoolDefinitionFromProgramDefinition
+ */
+declare function removePoolDefinitionFromProgramDefinition(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;
+}>;
 interface RemovePoolDefinitionFromProgramDefinitionOptions {
     /**
      * ID of the program definition to remove the pool definition from.
@@ -1037,6 +1219,20 @@ interface RemovePoolDefinitionFromProgramDefinitionOptions {
     /** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
     cascade: CascadeWithLiterals;
 }
+/**
+ * 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
+ * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_READ
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.FindPoolDefinitionsByProgramDefinition
+ */
+declare function findPoolDefinitionsByProgramDefinition(programDefinitionId: string, options: NonNullablePaths<FindPoolDefinitionsByProgramDefinitionOptions, `namespace`, 2>): Promise<NonNullablePaths<FindPoolDefinitionsByProgramDefinitionResponse, `poolDefinitions` | `poolDefinitions.${number}.displayName` | `poolDefinitions.${number}.details.creditConfiguration.amount`, 6>>;
 interface FindPoolDefinitionsByProgramDefinitionOptions {
     /**
      * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
@@ -1046,4 +1242,4 @@ interface FindPoolDefinitionsByProgramDefinitionOptions {
     namespace: string;
 }
 
-export { type UpdatePoolDefinitionRequest as $, type AddPoolDefinitionToProgramDefinitionOptions as A, type BulkCreatePoolDefinitionsOptions as B, type CreatePoolDefinitionOptions as C, type DeletePoolDefinitionOptions as D, type CustomPolicy as E, type FindPoolDefinitionsByProgramDefinitionOptions as F, type CreditConfiguration as G, type RolloverConfiguration as H, type ExtendedFields as I, type ProgramDefinitionInfo as J, type PoolDefinitionAddedToProgramDefinition as K, type PoolDefinitionRemovedFromProgramDefinition as L, type PoolDefinitionUpdatedProxySupport as M, type PoolDefinitionDeletedProxySupport as N, type CreatePoolDefinitionRequest as O, type PoolDefinition as P, type CreatePoolDefinitionResponse as Q, type RemovePoolDefinitionFromProgramDefinitionOptions as R, SortOrder as S, Type as T, type UpdatePoolDefinition as U, type BulkCreatePoolDefinitionsRequest as V, WeekDay as W, type BulkPoolDefinitionResult as X, type ItemMetadata as Y, type ApplicationError as Z, type BulkActionMetadata as _, type BulkCreatePoolDefinitionsResponse as a, type UpdatePoolDefinitionResponse as a0, type BulkUpdatePoolDefinitionsRequest as a1, type MaskedPoolDefinition as a2, type DeletePoolDefinitionRequest as a3, type DeletePoolDefinitionResponse as a4, type BulkDeletePoolDefinitionsRequest as a5, type GetPoolDefinitionRequest as a6, type GetPoolDefinitionResponse as a7, type QueryPoolDefinitionsRequest as a8, type CursorQuery as a9, type CursorQueryPagingMethodOneOf as aa, type Sorting as ab, type CursorPaging as ac, type QueryPoolDefinitionsResponse as ad, type CursorPagingMetadata as ae, type Cursors as af, type AddPoolDefinitionToProgramDefinitionRequest as ag, type RemovePoolDefinitionFromProgramDefinitionRequest as ah, type FindPoolDefinitionsByProgramDefinitionRequest as ai, type DomainEvent as aj, type DomainEventBodyOneOf as ak, type EntityCreatedEvent as al, type RestoreInfo as am, type EntityUpdatedEvent as an, type EntityDeletedEvent as ao, type ActionEvent as ap, type MessageEnvelope as aq, type IdentificationData as ar, type IdentificationDataIdOneOf as as, type PoolDefinitionsQueryResult as at, type UpdatePoolDefinitionOptions as b, type BulkUpdatePoolDefinitionsOptions as c, type BulkUpdatePoolDefinitionsResponse as d, type BulkDeletePoolDefinitionsOptions as e, type BulkDeletePoolDefinitionsResponse as f, type PoolDefinitionsQueryBuilder as g, type AddPoolDefinitionToProgramDefinitionResponse as h, type RemovePoolDefinitionFromProgramDefinitionResponse as i, type FindPoolDefinitionsByProgramDefinitionResponse as j, PolicyExpressionType as k, RateLimitedPolicyType as l, Cascade as m, WebhookIdentityType as n, type Details as o, type Benefit as p, type PolicyExpression as q, type PolicyExpressionExpressionOneOf as r, type PolicyExpressionNot as s, type PolicyExpressionAnd as t, type PolicyExpressionOr as u, type Policy as v, type PolicyPolicyOneOf as w, type FixedIntervalPolicy as x, type RateLimitedPolicy as y, type RateLimitedPolicyPeriodOneOf as z };
+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 DeletePoolDefinitionOptions, 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 };