@wix/auto_sdk_benefit-programs_pools 1.0.76 → 1.0.77

package/build/internal/es/meta.d.mts

@@ -102,6 +102,37 @@ interface Pool {
      * @readonly
      */
     renewalCount?: number | null;
+    /**
+     * Previous status of the benefit pool.
+     * @internal
+     * @readonly
+     */
+    previousStatus?: PoolStatusWithLiterals;
+    /**
+     * Origin of the benefit pool.
+     * @internal
+     * @readonly
+     * @immutable
+     */
+    origin?: PoolOriginWithLiterals;
+    /**
+     * Action to be performed on pool renewal
+     * @internal
+     * @readonly
+     */
+    renewalAction?: PoolRenewalAction;
+    /**
+     * Pool description.
+     * @internal
+     * @maxLength 450
+     */
+    description?: string | null;
+    /**
+     * Monotonic counter incremented on every change, including system/materialization updates that do not bump revision.
+     * @internal
+     * @readonly
+     */
+    changesCounter?: string | null;
 }
 declare enum PoolStatus {
     /** Pool is active. */
@@ -135,6 +166,12 @@ interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
      * @format GUID
      */
     wixUserId?: string;
+    /**
+     * Identity type.
+     * @internal
+     * @readonly
+     */
+    identityType?: IdentityTypeWithLiterals;
 }
 /** @oneof */
 interface CommonIdentificationDataIdOneOf {
@@ -178,6 +215,19 @@ interface Details {
      * If this object is empty, you can't set a price for the benefit.
      */
     creditConfiguration?: CreditConfiguration;
+    /**
+     * Defines when benefits can be redeemed.
+     *
+     * Benefit redemption can be limited by:
+     * - **Fixed intervals**: Benefits can be redeemed during specific times of the day or week.
+     * - **Rate limited**: Up to a maximum amount of benefits can be redeemed in a specified time period.
+     *
+     * Expressions can be combined using the *not*, *and*, and *or* operators.
+     *
+     * Each benefit can override this policy.
+     * @internal
+     */
+    policyExpression?: PolicyExpression;
     /** Additional information relating to this object. */
     additionalData?: Record<string, any> | null;
 }
@@ -201,6 +251,11 @@ interface Benefit {
      * @decimalValue options { gte:0, maxScale:4 }
      */
     price?: string | null;
+    /**
+     * Overrides the default policy expression in `benefit.details`.
+     * @internal
+     */
+    policyExpression?: PolicyExpression;
     /** Additional information for this benefit. */
     additionalData?: Record<string, any> | null;
     /**
@@ -408,6 +463,12 @@ interface CreditConfiguration {
      * @maxLength 32
      */
     unitDisplayName?: string | null;
+    /**
+     * Credit unit type.
+     * @internal
+     * @maxLength 16
+     */
+    unitType?: string | null;
 }
 interface RolloverConfiguration {
     /** Whether unused credits roll over to a new cycle when a program renews. */
@@ -713,6 +774,11 @@ interface GetPoolResponse {
 interface UpdatePoolRequest {
     /** Pool to update. */
     pool: Pool;
+    /**
+     * Explicit list of fields to update.
+     * @internal
+     */
+    fieldMask?: string[];
 }
 interface UpdatePoolResponse {
     /** Updated pool. */
@@ -730,6 +796,11 @@ interface DeletePoolResponse {
 interface QueryPoolsRequest {
     /** Filter, sort, and paging to apply to the query. */
     query?: CursorQuery;
+    /**
+     * If true, the response will reflect a consistent snapshot of the data as of the time the request was received.
+     * @internal
+     */
+    consistent?: boolean | null;
 }
 interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
@@ -763,6 +834,20 @@ interface Sorting {
      * Default: `ASC`
      */
     order?: SortOrderWithLiterals;
+    /**
+     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+     *
+     * If multiple filters are provided, they are combined with AND operator.
+     *
+     * Example:
+     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+     * @internal
+     * @maxSize 10
+     */
+    selectItemsBy?: Record<string, any>[] | null;
 }
 declare enum SortOrder {
     /** Ascending sort order. */
@@ -884,6 +969,26 @@ interface NotEnoughBalance {
      * @decimalValue options { maxScale:4 }
      */
     requestedBalance?: string;
+    /**
+     * Pool information.
+     * @internal
+     */
+    poolInfo?: PoolInfo;
+    /**
+     * Program definition information.
+     * @internal
+     */
+    programDefinitionInfo?: ProgramDefinitionInfo;
+    /**
+     * Program information.
+     * @internal
+     */
+    programInfo?: PoolProgramInfo;
+    /**
+     * Benefit information.
+     * @internal
+     */
+    benefitInfo?: BenefitInfo;
 }
 interface PoolInfo {
     /** Current pool balance */
@@ -908,6 +1013,12 @@ interface PoolInfo {
      * @format GUID
      */
     poolDefinitionId?: string;
+    /**
+     * Credit unit type.
+     * @internal
+     * @maxLength 16
+     */
+    creditUnitType?: string | null;
 }
 interface BalanceAmount {
     /**
@@ -939,6 +1050,12 @@ interface BenefitInfo {
      * @maxLength 64
      */
     benefitKey?: string;
+    /**
+     * Price of the benefit in credits.
+     * @internal
+     * @decimalValue options { gte:0, maxScale:4 }
+     */
+    price?: string | null;
 }
 interface PolicyExpressionEvaluatedToFalse {
     /**
@@ -953,6 +1070,26 @@ interface PolicyExpressionEvaluatedToFalse {
      * @maxSize 10
      */
     failureDetails?: FailureDetails[];
+    /**
+     * Pool information.
+     * @internal
+     */
+    poolInfo?: PoolInfo;
+    /**
+     * Program definition information.
+     * @internal
+     */
+    programDefinitionInfo?: ProgramDefinitionInfo;
+    /**
+     * Program information.
+     * @internal
+     */
+    programInfo?: PoolProgramInfo;
+    /**
+     * Benefit information.
+     * @internal
+     */
+    benefitInfo?: BenefitInfo;
 }
 interface FailureDetails {
     /**
@@ -987,6 +1124,26 @@ interface PoolNotActive {
     poolId?: string;
     /** Pool status. */
     poolStatus?: PoolStatusWithLiterals;
+    /**
+     * Pool information.
+     * @internal
+     */
+    poolInfo?: PoolInfo;
+    /**
+     * Program definition information.
+     * @internal
+     */
+    programDefinitionInfo?: ProgramDefinitionInfo;
+    /**
+     * Program information.
+     * @internal
+     */
+    programInfo?: PoolProgramInfo;
+    /**
+     * Benefit information.
+     * @internal
+     */
+    benefitInfo?: BenefitInfo;
 }
 interface PoolNotFound {
     /**
@@ -1018,6 +1175,21 @@ interface BenefitNotFound {
      * @maxLength 64
      */
     benefitKey?: string | null;
+    /**
+     * Pool information.
+     * @internal
+     */
+    poolInfo?: PoolInfo;
+    /**
+     * Program definition information.
+     * @internal
+     */
+    programDefinitionInfo?: ProgramDefinitionInfo;
+    /**
+     * Program information.
+     * @internal
+     */
+    programInfo?: PoolProgramInfo;
 }
 interface ReserveBenefitRequest {
     /**
@@ -1157,6 +1329,11 @@ declare enum BenefitResultType {
     ELIGIBLE_BENEFIT = "ELIGIBLE_BENEFIT",
     /** Balance is lower than the cost of redeeming the items. */
     NOT_ENOUGH_BALANCE = "NOT_ENOUGH_BALANCE",
+    /**
+     * Policy is false.
+     * @internal
+     */
+    POLICY_EXPRESSION_EVALUATED_TO_FALSE = "POLICY_EXPRESSION_EVALUATED_TO_FALSE",
     /** Pool isn't active. */
     POOL_NOT_ACTIVE = "POOL_NOT_ACTIVE",
     /** Invalid benefit details provided. */
@@ -1185,6 +1362,26 @@ interface EligibleBenefit {
      * @decimalValue options { gte:0, maxScale:4 }
      */
     price?: string | null;
+    /**
+     * Pool information.
+     * @internal
+     */
+    poolInfo?: PoolInfo;
+    /**
+     * Benefit information.
+     * @internal
+     */
+    benefitInfo?: BenefitInfo;
+    /**
+     * Program definition information.
+     * @internal
+     */
+    programDefinitionInfo?: ProgramDefinitionInfo;
+    /**
+     * Program information.
+     * @internal
+     */
+    programInfo?: PoolProgramInfo;
 }
 interface BenefitResult extends BenefitResultResultOneOf {
     /** Returned when item is eligible to be redeemed. */
@@ -1667,8 +1864,18 @@ interface DomainEventBodyOneOf {
 }
 interface EntityCreatedEvent {
     entityAsJson?: string;
+    /**
+     * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
+     * @internal
+     */
+    triggeredByUndelete?: boolean | null;
     /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
     restoreInfo?: RestoreInfo;
+    /**
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
+     * @internal
+     */
+    additionalMetadataAsJson?: string | null;
 }
 interface RestoreInfo {
     deletedDate?: Date | null;
@@ -1680,10 +1887,42 @@ interface EntityUpdatedEvent {
      * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
      */
     currentEntityAsJson?: string;
+    /**
+     * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
+     * wont populate it / have any reference to it in the API.
+     * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
+     * the developer should send only the new (current) entity.
+     * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
+     * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
+     * @internal
+     * @deprecated
+     */
+    previousEntityAsJson?: string | null;
+    /**
+     * Map of fully qualified field paths to their previous values for fields that changed.
+     * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
+     * @internal
+     */
+    modifiedFields?: Record<string, any>;
+    /**
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
+     * @internal
+     */
+    additionalMetadataAsJson?: string | null;
 }
 interface EntityDeletedEvent {
+    /**
+     * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
+     * @internal
+     */
+    movedToTrash?: boolean | null;
     /** Entity that was deleted. */
     deletedEntityAsJson?: string | null;
+    /**
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
+     * @internal
+     */
+    additionalMetadataAsJson?: string | null;
 }
 interface ActionEvent {
     bodyAsJson?: string;

package/build/internal/es/meta.mjs

@@ -550,6 +550,7 @@ var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
 var BenefitResultType = /* @__PURE__ */ ((BenefitResultType2) => {
   BenefitResultType2["ELIGIBLE_BENEFIT"] = "ELIGIBLE_BENEFIT";
   BenefitResultType2["NOT_ENOUGH_BALANCE"] = "NOT_ENOUGH_BALANCE";
+  BenefitResultType2["POLICY_EXPRESSION_EVALUATED_TO_FALSE"] = "POLICY_EXPRESSION_EVALUATED_TO_FALSE";
   BenefitResultType2["POOL_NOT_ACTIVE"] = "POOL_NOT_ACTIVE";
   BenefitResultType2["BENEFIT_NOT_FOUND"] = "BENEFIT_NOT_FOUND";
   BenefitResultType2["POOL_NOT_FOUND"] = "POOL_NOT_FOUND";