@wix/auto_sdk_benefit-programs_pools 1.0.42 → 1.0.44

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

@@ -362,29 +362,31 @@ declare enum WeekDay {
 }
 /** @enumType */
 type WeekDayWithLiterals = WeekDay | 'UNKNOWN' | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
-interface RateLimitedPolicy extends RateLimitedPolicyPeriodOneOf {
-    /** Fixed interval used to limit benefit redemption. */
-    fixedIntervalOptions?: FixedIntervalPolicy;
+interface RateLimitedPolicy {
     /** Maximum number of times a benefit can be redeemed per specified time period. */
     times?: number;
-    /** Time period type. */
-    type?: RateLimitedPolicyTypeWithLiterals;
-}
-/** @oneof */
-interface RateLimitedPolicyPeriodOneOf {
-    /** Fixed interval used to limit benefit redemption. */
-    fixedIntervalOptions?: FixedIntervalPolicy;
+    /** Time period for the rate limit, resets at the start of each period. */
+    timePeriod?: TimePeriodWithLiterals;
+    /**
+     * Unique identifier for the quota resource. Set during creation and immutable afterwards.
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    quotaId?: string | null;
 }
-declare enum RateLimitedPolicyType {
-    /** Unknown rate limit method. */
-    UNKNOWN = "UNKNOWN",
-    /** Time period is defined using `fixedIntervalOptions`. */
-    FIXED_INTERVAL = "FIXED_INTERVAL",
-    /** Time period is from one program renewal to the next. */
-    PER_CYCLE = "PER_CYCLE"
+declare enum TimePeriod {
+    /** Unknown time period. */
+    UNKNOWN_TIME_PERIOD = "UNKNOWN_TIME_PERIOD",
+    /** Day, starting at midnight. */
+    DAY = "DAY",
+    /** Calendar week, starting day depending on locale. */
+    WEEK = "WEEK",
+    /** Calendar month, starting on the first day of the month. */
+    MONTH = "MONTH"
 }
 /** @enumType */
-type RateLimitedPolicyTypeWithLiterals = RateLimitedPolicyType | 'UNKNOWN' | 'FIXED_INTERVAL' | 'PER_CYCLE';
+type TimePeriodWithLiterals = TimePeriod | 'UNKNOWN_TIME_PERIOD' | 'DAY' | 'WEEK' | 'MONTH';
 /** Custom policy as implemented by the Entitlement Policy Provider */
 interface CustomPolicy {
     /**
@@ -1241,7 +1243,7 @@ interface BenefitSelector {
     /**
      * Amount of items to check.
      *
-     * Ensures the balance is high enough to redeem this many it
+     * Ensures the balance is high enough to redeem this many items.
      * @min 1
      */
     count?: number;
@@ -1601,7 +1603,7 @@ interface CheckEligibilityByFilterRequest {
     /**
      * Amount of items to check.
      *
-     * Ensures the balance is high enough to redeem this many it
+     * Ensures the balance is high enough to redeem this many items.
      * @min 1
      */
     count: number;
@@ -1612,7 +1614,7 @@ interface CheckEligibilityByFilterRequest {
      */
     targetDate?: Date | null;
     /** Pool beneficiary. */
-    beneficiary: CommonIdentificationData;
+    beneficiary?: CommonIdentificationData;
     /** Additional information. */
     additionalData?: Record<string, any> | null;
 }
@@ -2230,7 +2232,7 @@ interface CheckEligibilityByFilterOptions {
     /**
      * Amount of items to check.
      *
-     * Ensures the balance is high enough to redeem this many it
+     * Ensures the balance is high enough to redeem this many items.
      * @min 1
      */
     count: number;
@@ -2241,9 +2243,9 @@ interface CheckEligibilityByFilterOptions {
      */
     targetDate?: Date | null;
     /** Pool beneficiary. */
-    beneficiary: CommonIdentificationData;
+    beneficiary?: CommonIdentificationData;
     /** Additional information. */
     additionalData?: Record<string, any> | null;
 }
 
-export { type ActionEvent, type ApplicationError, type AsyncResult, type BalanceAmount, type Benefit, type BenefitAlreadyRedeemed, type BenefitInfo, type BenefitNotFound, type BenefitRedeemed, type BenefitReservationCanceled, type BenefitReservationReleased, type BenefitReserved, type BenefitSelector, type BulkActionMetadata, type BulkCheckBenefitEligibilityOptions, type BulkCheckBenefitEligibilityRequest, type BulkCheckBenefitEligibilityResponse, type BulkEligibilityCheckResult, type BulkPoolResult, type BulkUpdatePoolsOptions, type BulkUpdatePoolsRequest, type BulkUpdatePoolsResponse, type ByItemReference, type ByItemReferenceFilter, type ByPoolDefinitionIdAndProgramDefinitionIdOptions, type ByProgramIdOptions, type CancelBenefitReservationRequest, type CancelBenefitReservationResponse, type CheckBenefitEligibilityOptions, type CheckBenefitEligibilityRequest, type CheckBenefitEligibilityResponse, type CheckEligibilityByFilterOptions, type CheckEligibilityByFilterRequest, type CheckEligibilityByFilterResponse, type CommonIdentificationData, type CommonIdentificationDataIdOneOf, type CountNumberOfPoolsInProvisioningStatusRequest, type CountNumberOfPoolsInProvisioningStatusResponse, type CreatePoolRequest, type CreatePoolResponse, type CreditConfiguration, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomPolicy, type DeletePoolRequest, type DeletePoolResponse, type Details, type DomainEvent, type DomainEventBodyOneOf, type EligibilityCheckResult, type EligibilityCheckResultResultOneOf, EligibilityCheckResultType, type EligibilityCheckResultTypeWithLiterals, type Eligible, type EligibleBenefit, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type FailureDetails, type Filter, type FilterFilterOneOf, type FixedIntervalPolicy, type GetEligibleBenefitsApplicationErrors, type GetEligibleBenefitsOptions, type GetEligibleBenefitsRequest, type GetEligibleBenefitsResponse, type GetPoolRequest, type GetPoolResponse, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type IdentityTypeWithLiterals, type InvalidPoolDefinitionReference, type ItemMetadata, type ItemReference, type ListPoolsRequest, ListPoolsRequestType, type ListPoolsRequestTypeWithLiterals, type ListPoolsResponse, type MaskedPool, type MessageEnvelope, type NotEnoughBalance, type Policy, type PolicyExpression, type PolicyExpressionAnd, type PolicyExpressionEvaluatedToFalse, type PolicyExpressionExpressionOneOf, type PolicyExpressionNot, type PolicyExpressionOr, PolicyExpressionType, type PolicyExpressionTypeWithLiterals, type PolicyPolicyOneOf, type Pool, type PoolDefinitionAndProgramDefinition, type PoolDefinitionLookupId, type PoolDefinitionLookupIdIdOneOf, type PoolEnded, type PoolFilter, type PoolInfo, type PoolNotActive, type PoolNotFound, PoolOrigin, type PoolOriginWithLiterals, type PoolPaused, type PoolProgramInfo, type PoolProvisionJobFinished, type PoolProvisioned, type PoolRenewalAction, type PoolRenewalActionActionOneOf, PoolRenewalActionType, type PoolRenewalActionTypeWithLiterals, type PoolRenewed, type PoolResumed, PoolSelectorType, type PoolSelectorTypeWithLiterals, PoolStatus, type PoolStatusUpdateJobFinished, type PoolStatusUpdateJobFinishedContextOneOf, type PoolStatusUpdateParamsPoolInfo, type PoolStatusWithLiterals, type PoolWithItems, type PoolsQueryBuilder, type PoolsQueryResult, type ProgramDefinitionInfo, type ProgramInfo, type ProvisionPoolsForProgramRequest, type ProvisionPoolsForProgramResponse, type ProvisionPoolsForProgramResponseResultOneOf, ProvisionPoolsForProgramResponseType, type ProvisionPoolsForProgramResponseTypeWithLiterals, type QueryPoolsRequest, type QueryPoolsResponse, type RateLimitedPolicy, type RateLimitedPolicyPeriodOneOf, RateLimitedPolicyType, type RateLimitedPolicyTypeWithLiterals, type RedeemBenefitApplicationErrors, type RedeemBenefitOptions, type RedeemBenefitRequest, type RedeemBenefitResponse, type RedemptionDetails, type ReleaseBenefitReservationRequest, type ReleaseBenefitReservationResponse, type RenewPoolsForProgramRequest, type RenewPoolsForProgramResponse, type ReserveBenefitRequest, type ReserveBenefitResponse, type RestoreInfo, type RolloverConfiguration, SortOrder, type SortOrderWithLiterals, type Sorting, type SyncResult, Type, type TypeWithLiterals, type Update, type UpdatePool, type UpdatePoolRequest, type UpdatePoolResponse, type UpdatePoolStatusRequest, type UpdatePoolStatusRequestPoolSelectorOneOf, type UpdatePoolStatusResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeekDay, type WeekDayWithLiterals, bulkCheckBenefitEligibility, bulkUpdatePools, checkBenefitEligibility, getEligibleBenefits, getPool, queryPools, redeemBenefit, typedQueryPools, updatePool };
+export { type ActionEvent, type ApplicationError, type AsyncResult, type BalanceAmount, type Benefit, type BenefitAlreadyRedeemed, type BenefitInfo, type BenefitNotFound, type BenefitRedeemed, type BenefitReservationCanceled, type BenefitReservationReleased, type BenefitReserved, type BenefitSelector, type BulkActionMetadata, type BulkCheckBenefitEligibilityOptions, type BulkCheckBenefitEligibilityRequest, type BulkCheckBenefitEligibilityResponse, type BulkEligibilityCheckResult, type BulkPoolResult, type BulkUpdatePoolsOptions, type BulkUpdatePoolsRequest, type BulkUpdatePoolsResponse, type ByItemReference, type ByItemReferenceFilter, type ByPoolDefinitionIdAndProgramDefinitionIdOptions, type ByProgramIdOptions, type CancelBenefitReservationRequest, type CancelBenefitReservationResponse, type CheckBenefitEligibilityOptions, type CheckBenefitEligibilityRequest, type CheckBenefitEligibilityResponse, type CheckEligibilityByFilterOptions, type CheckEligibilityByFilterRequest, type CheckEligibilityByFilterResponse, type CommonIdentificationData, type CommonIdentificationDataIdOneOf, type CountNumberOfPoolsInProvisioningStatusRequest, type CountNumberOfPoolsInProvisioningStatusResponse, type CreatePoolRequest, type CreatePoolResponse, type CreditConfiguration, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomPolicy, type DeletePoolRequest, type DeletePoolResponse, type Details, type DomainEvent, type DomainEventBodyOneOf, type EligibilityCheckResult, type EligibilityCheckResultResultOneOf, EligibilityCheckResultType, type EligibilityCheckResultTypeWithLiterals, type Eligible, type EligibleBenefit, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type FailureDetails, type Filter, type FilterFilterOneOf, type FixedIntervalPolicy, type GetEligibleBenefitsApplicationErrors, type GetEligibleBenefitsOptions, type GetEligibleBenefitsRequest, type GetEligibleBenefitsResponse, type GetPoolRequest, type GetPoolResponse, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type IdentityTypeWithLiterals, type InvalidPoolDefinitionReference, type ItemMetadata, type ItemReference, type ListPoolsRequest, ListPoolsRequestType, type ListPoolsRequestTypeWithLiterals, type ListPoolsResponse, type MaskedPool, type MessageEnvelope, type NotEnoughBalance, type Policy, type PolicyExpression, type PolicyExpressionAnd, type PolicyExpressionEvaluatedToFalse, type PolicyExpressionExpressionOneOf, type PolicyExpressionNot, type PolicyExpressionOr, PolicyExpressionType, type PolicyExpressionTypeWithLiterals, type PolicyPolicyOneOf, type Pool, type PoolDefinitionAndProgramDefinition, type PoolDefinitionLookupId, type PoolDefinitionLookupIdIdOneOf, type PoolEnded, type PoolFilter, type PoolInfo, type PoolNotActive, type PoolNotFound, PoolOrigin, type PoolOriginWithLiterals, type PoolPaused, type PoolProgramInfo, type PoolProvisionJobFinished, type PoolProvisioned, type PoolRenewalAction, type PoolRenewalActionActionOneOf, PoolRenewalActionType, type PoolRenewalActionTypeWithLiterals, type PoolRenewed, type PoolResumed, PoolSelectorType, type PoolSelectorTypeWithLiterals, PoolStatus, type PoolStatusUpdateJobFinished, type PoolStatusUpdateJobFinishedContextOneOf, type PoolStatusUpdateParamsPoolInfo, type PoolStatusWithLiterals, type PoolWithItems, type PoolsQueryBuilder, type PoolsQueryResult, type ProgramDefinitionInfo, type ProgramInfo, type ProvisionPoolsForProgramRequest, type ProvisionPoolsForProgramResponse, type ProvisionPoolsForProgramResponseResultOneOf, ProvisionPoolsForProgramResponseType, type ProvisionPoolsForProgramResponseTypeWithLiterals, type QueryPoolsRequest, type QueryPoolsResponse, type RateLimitedPolicy, type RedeemBenefitApplicationErrors, type RedeemBenefitOptions, type RedeemBenefitRequest, type RedeemBenefitResponse, type RedemptionDetails, type ReleaseBenefitReservationRequest, type ReleaseBenefitReservationResponse, type RenewPoolsForProgramRequest, type RenewPoolsForProgramResponse, type ReserveBenefitRequest, type ReserveBenefitResponse, type RestoreInfo, type RolloverConfiguration, SortOrder, type SortOrderWithLiterals, type Sorting, type SyncResult, TimePeriod, type TimePeriodWithLiterals, Type, type TypeWithLiterals, type Update, type UpdatePool, type UpdatePoolRequest, type UpdatePoolResponse, type UpdatePoolStatusRequest, type UpdatePoolStatusRequestPoolSelectorOneOf, type UpdatePoolStatusResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeekDay, type WeekDayWithLiterals, bulkCheckBenefitEligibility, bulkUpdatePools, checkBenefitEligibility, getEligibleBenefits, getPool, queryPools, redeemBenefit, typedQueryPools, updatePool };

package/build/es/index.typings.mjs

@@ -539,12 +539,13 @@ var WeekDay = /* @__PURE__ */ ((WeekDay2) => {
   WeekDay2["SUNDAY"] = "SUNDAY";
   return WeekDay2;
 })(WeekDay || {});
-var RateLimitedPolicyType = /* @__PURE__ */ ((RateLimitedPolicyType2) => {
-  RateLimitedPolicyType2["UNKNOWN"] = "UNKNOWN";
-  RateLimitedPolicyType2["FIXED_INTERVAL"] = "FIXED_INTERVAL";
-  RateLimitedPolicyType2["PER_CYCLE"] = "PER_CYCLE";
-  return RateLimitedPolicyType2;
-})(RateLimitedPolicyType || {});
+var TimePeriod = /* @__PURE__ */ ((TimePeriod2) => {
+  TimePeriod2["UNKNOWN_TIME_PERIOD"] = "UNKNOWN_TIME_PERIOD";
+  TimePeriod2["DAY"] = "DAY";
+  TimePeriod2["WEEK"] = "WEEK";
+  TimePeriod2["MONTH"] = "MONTH";
+  return TimePeriod2;
+})(TimePeriod || {});
 var PoolOrigin = /* @__PURE__ */ ((PoolOrigin2) => {
   PoolOrigin2["UNKNOWN"] = "UNKNOWN";
   PoolOrigin2["PROVISION"] = "PROVISION";
@@ -940,8 +941,8 @@ export {
   PoolSelectorType,
   PoolStatus,
   ProvisionPoolsForProgramResponseType,
-  RateLimitedPolicyType,
   SortOrder,
+  TimePeriod,
   Type,
   WebhookIdentityType,
   WeekDay,