@wix/auto_sdk_benefit-programs_pool-definitions 1.0.65 → 1.0.67

package/build/internal/cjs/meta.d.ts

@@ -60,6 +60,18 @@ interface PoolDefinition {
      * @maxSize 20
      */
     programDefinitions?: ProgramDefinitionInfo[];
+    /**
+     * 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;
 }
 interface Details {
     /**
@@ -73,6 +85,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;
 }
@@ -96,6 +121,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;
     /**
@@ -303,6 +333,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. */
@@ -337,6 +373,18 @@ interface ProgramDefinitionInfo {
      * @readonly
      */
     externalId?: string | null;
+    /**
+     * Program definition name.
+     * @internal
+     * @maxLength 64
+     */
+    displayName?: string | null;
+    /**
+     * Program definition description.
+     * @internal
+     * @maxLength 450
+     */
+    description?: string | null;
 }
 interface PoolDefinitionAddedToProgramDefinition {
     /** PoolDefinition that was added to the program definition */
@@ -489,6 +537,11 @@ interface BulkActionMetadata {
 interface UpdatePoolDefinitionRequest {
     /** Pool definition to update. */
     poolDefinition: PoolDefinition;
+    /**
+     * Explicit list of fields to update.
+     * @internal
+     */
+    fieldMask?: string[];
     /** *Required.** Determines when the changes to this pool definition and program definitions containing it will be applied to associated programs and pools. */
     cascade?: CascadeWithLiterals;
 }
@@ -574,6 +627,19 @@ interface GetPoolDefinitionResponse {
 interface QueryPoolDefinitionsRequest {
     /** 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;
+    /**
+     * HACK FIXME PPNP-4611. Supersedes the page limit provided in the CursorQuery. Provides a way for trusted clients to query large
+     * amounts of data because necessary index crashes mysql cluster so the only option is to perform filtering in memory
+     * https://wix.slack.com/archives/C0E3MBAGH/p1765097287055939
+     * @internal
+     * @max 10000
+     */
+    overrideLimit?: number | 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`. */
@@ -607,6 +673,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. */
@@ -724,9 +804,9 @@ interface HealPoolDefinitionRequest {
 }
 interface HealPoolDefinitionResponse {
 }
-interface HealPoolDefinitionsTenantRequest {
+interface HealPoolDefinitionTenantRequest {
 }
-interface HealPoolDefinitionsTenantResponse {
+interface HealPoolDefinitionTenantResponse {
 }
 interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
@@ -771,8 +851,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;
@@ -784,10 +874,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;
@@ -936,4 +1058,4 @@ declare function addPoolDefinitionToProgramDefinition(): __PublicMethodMetaInfo<
 declare function removePoolDefinitionFromProgramDefinition(): __PublicMethodMetaInfo<'POST', {}, RemovePoolDefinitionFromProgramDefinitionRequest$1, RemovePoolDefinitionFromProgramDefinitionRequest, RemovePoolDefinitionFromProgramDefinitionResponse$1, RemovePoolDefinitionFromProgramDefinitionResponse>;
 declare function findPoolDefinitionsByProgramDefinition(): __PublicMethodMetaInfo<'POST', {}, FindPoolDefinitionsByProgramDefinitionRequest$1, FindPoolDefinitionsByProgramDefinitionRequest, FindPoolDefinitionsByProgramDefinitionResponse$1, FindPoolDefinitionsByProgramDefinitionResponse>;
 
-export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddPoolDefinitionToProgramDefinitionRequest as AddPoolDefinitionToProgramDefinitionRequestOriginal, type AddPoolDefinitionToProgramDefinitionResponse as AddPoolDefinitionToProgramDefinitionResponseOriginal, type AddPoolDefinitionToProgramDefinitionValidationErrors as AddPoolDefinitionToProgramDefinitionValidationErrorsOriginal, type ApplicationError as ApplicationErrorOriginal, type Benefit as BenefitOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCreatePoolDefinitionsRequest as BulkCreatePoolDefinitionsRequestOriginal, type BulkCreatePoolDefinitionsResponse as BulkCreatePoolDefinitionsResponseOriginal, type BulkDeletePoolDefinitionsRequest as BulkDeletePoolDefinitionsRequestOriginal, type BulkDeletePoolDefinitionsResponse as BulkDeletePoolDefinitionsResponseOriginal, type BulkPoolDefinitionResult as BulkPoolDefinitionResultOriginal, type BulkUpdatePoolDefinitionsRequest as BulkUpdatePoolDefinitionsRequestOriginal, type BulkUpdatePoolDefinitionsResponse as BulkUpdatePoolDefinitionsResponseOriginal, type BulkUpdatePoolDefinitionsValidationErrors as BulkUpdatePoolDefinitionsValidationErrorsOriginal, Cascade as CascadeOriginal, type CascadeWithLiterals as CascadeWithLiteralsOriginal, type CreatePoolDefinitionRequest as CreatePoolDefinitionRequestOriginal, type CreatePoolDefinitionResponse as CreatePoolDefinitionResponseOriginal, type CreditConfiguration as CreditConfigurationOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomPolicy as CustomPolicyOriginal, type DeletePoolDefinitionRequest as DeletePoolDefinitionRequestOriginal, type DeletePoolDefinitionResponse as DeletePoolDefinitionResponseOriginal, type Details as DetailsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type FindPoolDefinitionsByProgramDefinitionRequest as FindPoolDefinitionsByProgramDefinitionRequestOriginal, type FindPoolDefinitionsByProgramDefinitionResponse as FindPoolDefinitionsByProgramDefinitionResponseOriginal, type FixedIntervalPolicy as FixedIntervalPolicyOriginal, type GetPoolDefinitionRequest as GetPoolDefinitionRequestOriginal, type GetPoolDefinitionResponse as GetPoolDefinitionResponseOriginal, type HealPoolDefinitionRequest as HealPoolDefinitionRequestOriginal, type HealPoolDefinitionResponse as HealPoolDefinitionResponseOriginal, type HealPoolDefinitionsTenantRequest as HealPoolDefinitionsTenantRequestOriginal, type HealPoolDefinitionsTenantResponse as HealPoolDefinitionsTenantResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ItemMetadata as ItemMetadataOriginal, type MaskedPoolDefinition as MaskedPoolDefinitionOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type PolicyExpressionAnd as PolicyExpressionAndOriginal, type PolicyExpressionExpressionOneOf as PolicyExpressionExpressionOneOfOriginal, type PolicyExpressionNot as PolicyExpressionNotOriginal, type PolicyExpressionOr as PolicyExpressionOrOriginal, type PolicyExpression as PolicyExpressionOriginal, PolicyExpressionType as PolicyExpressionTypeOriginal, type PolicyExpressionTypeWithLiterals as PolicyExpressionTypeWithLiteralsOriginal, type Policy as PolicyOriginal, type PolicyPolicyOneOf as PolicyPolicyOneOfOriginal, type PoolDefinitionAddedToProgramDefinition as PoolDefinitionAddedToProgramDefinitionOriginal, type PoolDefinitionDeletedProxySupport as PoolDefinitionDeletedProxySupportOriginal, type PoolDefinition as PoolDefinitionOriginal, type PoolDefinitionRemovedFromProgramDefinition as PoolDefinitionRemovedFromProgramDefinitionOriginal, type PoolDefinitionTranslated as PoolDefinitionTranslatedOriginal, type PoolDefinitionTranslationDeleted as PoolDefinitionTranslationDeletedOriginal, type PoolDefinitionUpdatedProxySupport as PoolDefinitionUpdatedProxySupportOriginal, type ProgramDefinitionInfo as ProgramDefinitionInfoOriginal, type QueryPoolDefinitionsRequest as QueryPoolDefinitionsRequestOriginal, type QueryPoolDefinitionsResponse as QueryPoolDefinitionsResponseOriginal, type RateLimitedPolicy as RateLimitedPolicyOriginal, type RemovePoolDefinitionFromProgramDefinitionRequest as RemovePoolDefinitionFromProgramDefinitionRequestOriginal, type RemovePoolDefinitionFromProgramDefinitionResponse as RemovePoolDefinitionFromProgramDefinitionResponseOriginal, type RemovePoolDefinitionFromProgramDefinitionValidationErrors as RemovePoolDefinitionFromProgramDefinitionValidationErrorsOriginal, type RestoreInfo as RestoreInfoOriginal, type RolloverConfiguration as RolloverConfigurationOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, TimePeriod as TimePeriodOriginal, type TimePeriodWithLiterals as TimePeriodWithLiteralsOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, type UpdatePoolDefinitionRequest as UpdatePoolDefinitionRequestOriginal, type UpdatePoolDefinitionResponse as UpdatePoolDefinitionResponseOriginal, type UpdatePoolDefinitionValidationErrors as UpdatePoolDefinitionValidationErrorsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeekDay as WeekDayOriginal, type WeekDayWithLiterals as WeekDayWithLiteralsOriginal, type __PublicMethodMetaInfo, addPoolDefinitionToProgramDefinition, bulkCreatePoolDefinitions, bulkDeletePoolDefinitions, bulkUpdatePoolDefinitions, createPoolDefinition, deletePoolDefinition, findPoolDefinitionsByProgramDefinition, getPoolDefinition, queryPoolDefinitions, removePoolDefinitionFromProgramDefinition, updatePoolDefinition };
+export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddPoolDefinitionToProgramDefinitionRequest as AddPoolDefinitionToProgramDefinitionRequestOriginal, type AddPoolDefinitionToProgramDefinitionResponse as AddPoolDefinitionToProgramDefinitionResponseOriginal, type AddPoolDefinitionToProgramDefinitionValidationErrors as AddPoolDefinitionToProgramDefinitionValidationErrorsOriginal, type ApplicationError as ApplicationErrorOriginal, type Benefit as BenefitOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCreatePoolDefinitionsRequest as BulkCreatePoolDefinitionsRequestOriginal, type BulkCreatePoolDefinitionsResponse as BulkCreatePoolDefinitionsResponseOriginal, type BulkDeletePoolDefinitionsRequest as BulkDeletePoolDefinitionsRequestOriginal, type BulkDeletePoolDefinitionsResponse as BulkDeletePoolDefinitionsResponseOriginal, type BulkPoolDefinitionResult as BulkPoolDefinitionResultOriginal, type BulkUpdatePoolDefinitionsRequest as BulkUpdatePoolDefinitionsRequestOriginal, type BulkUpdatePoolDefinitionsResponse as BulkUpdatePoolDefinitionsResponseOriginal, type BulkUpdatePoolDefinitionsValidationErrors as BulkUpdatePoolDefinitionsValidationErrorsOriginal, Cascade as CascadeOriginal, type CascadeWithLiterals as CascadeWithLiteralsOriginal, type CreatePoolDefinitionRequest as CreatePoolDefinitionRequestOriginal, type CreatePoolDefinitionResponse as CreatePoolDefinitionResponseOriginal, type CreditConfiguration as CreditConfigurationOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomPolicy as CustomPolicyOriginal, type DeletePoolDefinitionRequest as DeletePoolDefinitionRequestOriginal, type DeletePoolDefinitionResponse as DeletePoolDefinitionResponseOriginal, type Details as DetailsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type FindPoolDefinitionsByProgramDefinitionRequest as FindPoolDefinitionsByProgramDefinitionRequestOriginal, type FindPoolDefinitionsByProgramDefinitionResponse as FindPoolDefinitionsByProgramDefinitionResponseOriginal, type FixedIntervalPolicy as FixedIntervalPolicyOriginal, type GetPoolDefinitionRequest as GetPoolDefinitionRequestOriginal, type GetPoolDefinitionResponse as GetPoolDefinitionResponseOriginal, type HealPoolDefinitionRequest as HealPoolDefinitionRequestOriginal, type HealPoolDefinitionResponse as HealPoolDefinitionResponseOriginal, type HealPoolDefinitionTenantRequest as HealPoolDefinitionTenantRequestOriginal, type HealPoolDefinitionTenantResponse as HealPoolDefinitionTenantResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ItemMetadata as ItemMetadataOriginal, type MaskedPoolDefinition as MaskedPoolDefinitionOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type PolicyExpressionAnd as PolicyExpressionAndOriginal, type PolicyExpressionExpressionOneOf as PolicyExpressionExpressionOneOfOriginal, type PolicyExpressionNot as PolicyExpressionNotOriginal, type PolicyExpressionOr as PolicyExpressionOrOriginal, type PolicyExpression as PolicyExpressionOriginal, PolicyExpressionType as PolicyExpressionTypeOriginal, type PolicyExpressionTypeWithLiterals as PolicyExpressionTypeWithLiteralsOriginal, type Policy as PolicyOriginal, type PolicyPolicyOneOf as PolicyPolicyOneOfOriginal, type PoolDefinitionAddedToProgramDefinition as PoolDefinitionAddedToProgramDefinitionOriginal, type PoolDefinitionDeletedProxySupport as PoolDefinitionDeletedProxySupportOriginal, type PoolDefinition as PoolDefinitionOriginal, type PoolDefinitionRemovedFromProgramDefinition as PoolDefinitionRemovedFromProgramDefinitionOriginal, type PoolDefinitionTranslated as PoolDefinitionTranslatedOriginal, type PoolDefinitionTranslationDeleted as PoolDefinitionTranslationDeletedOriginal, type PoolDefinitionUpdatedProxySupport as PoolDefinitionUpdatedProxySupportOriginal, type ProgramDefinitionInfo as ProgramDefinitionInfoOriginal, type QueryPoolDefinitionsRequest as QueryPoolDefinitionsRequestOriginal, type QueryPoolDefinitionsResponse as QueryPoolDefinitionsResponseOriginal, type RateLimitedPolicy as RateLimitedPolicyOriginal, type RemovePoolDefinitionFromProgramDefinitionRequest as RemovePoolDefinitionFromProgramDefinitionRequestOriginal, type RemovePoolDefinitionFromProgramDefinitionResponse as RemovePoolDefinitionFromProgramDefinitionResponseOriginal, type RemovePoolDefinitionFromProgramDefinitionValidationErrors as RemovePoolDefinitionFromProgramDefinitionValidationErrorsOriginal, type RestoreInfo as RestoreInfoOriginal, type RolloverConfiguration as RolloverConfigurationOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, TimePeriod as TimePeriodOriginal, type TimePeriodWithLiterals as TimePeriodWithLiteralsOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, type UpdatePoolDefinitionRequest as UpdatePoolDefinitionRequestOriginal, type UpdatePoolDefinitionResponse as UpdatePoolDefinitionResponseOriginal, type UpdatePoolDefinitionValidationErrors as UpdatePoolDefinitionValidationErrorsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeekDay as WeekDayOriginal, type WeekDayWithLiterals as WeekDayWithLiteralsOriginal, type __PublicMethodMetaInfo, addPoolDefinitionToProgramDefinition, bulkCreatePoolDefinitions, bulkDeletePoolDefinitions, bulkUpdatePoolDefinitions, createPoolDefinition, deletePoolDefinition, findPoolDefinitionsByProgramDefinition, getPoolDefinition, queryPoolDefinitions, removePoolDefinitionFromProgramDefinition, updatePoolDefinition };