@wix/auto_sdk_benefit-programs_pools 1.0.45 → 1.0.47

package/build/internal/cjs/index.typings.d.ts

@@ -451,7 +451,7 @@ interface ProgramDefinitionInfo {
      */
     externalId?: string | null;
     /**
-     * Program external ID.
+     * Display name of the program definition.
      * @readonly
      * @maxLength 128
      */
@@ -477,7 +477,7 @@ interface PoolProgramInfo {
      */
     externalId?: string | null;
     /**
-     * Program external ID.
+     * Display name of the program.
      * @readonly
      * @maxLength 64
      */
@@ -891,6 +891,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 */
@@ -950,6 +970,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 {
     /**
@@ -984,6 +1024,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 {
     /**
@@ -1012,9 +1072,24 @@ interface BenefitNotFound {
     poolId?: string;
     /**
      * Specified benefit key.
-     * @format GUID
+     * @maxLength 64
      */
     benefitKey?: string | null;
+    /**
+     * Pool information.
+     * @internal
+     */
+    poolInfo?: PoolInfo;
+    /**
+     * Program definition information.
+     * @internal
+     */
+    programDefinitionInfo?: ProgramDefinitionInfo;
+    /**
+     * Program information.
+     * @internal
+     */
+    programInfo?: PoolProgramInfo;
 }
 interface ReserveBenefitRequest {
     /**
@@ -1188,6 +1263,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;
 }
 declare enum EligibilityCheckResultType {
     /** Unknown eligibility. */
@@ -1402,8 +1497,12 @@ interface BulkUpdatePoolsResponse {
 interface BulkPoolResult {
     /** Pool metadata. */
     poolMetadata?: ItemMetadata;
+    /** Item metadata. */
+    itemMetadata?: ItemMetadata;
     /** Pool data. */
     pool?: Pool;
+    /** Pool data. */
+    item?: Pool;
 }
 interface ItemMetadata {
     /**
@@ -1951,7 +2050,9 @@ interface UpdatePool {
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool.PoolService.QueryPools
  */
-declare function queryPools(): PoolsQueryBuilder;
+declare function queryPools(options?: QueryPoolsOptions): PoolsQueryBuilder;
+interface QueryPoolsOptions {
+}
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -2015,7 +2116,7 @@ interface PoolsQueryBuilder {
  * @fqn wix.benefit_programs.v1.pool.PoolService.QueryPools
  * @requiredField query
  */
-declare function typedQueryPools(query: CursorQuery): Promise<NonNullablePaths<QueryPoolsResponse, `pools` | `pools.${number}.status` | `pools.${number}.beneficiary.anonymousVisitorId` | `pools.${number}.beneficiary.memberId` | `pools.${number}.beneficiary.wixUserId` | `pools.${number}.details.creditConfiguration.amount` | `pools.${number}.displayName` | `pools.${number}.programDefinition._id` | `pools.${number}.program._id`, 6>>;
+declare function typedQueryPools(query: CursorQuery, options?: QueryPoolsOptions): Promise<NonNullablePaths<QueryPoolsResponse, `pools` | `pools.${number}.status` | `pools.${number}.beneficiary.anonymousVisitorId` | `pools.${number}.beneficiary.memberId` | `pools.${number}.beneficiary.wixUserId` | `pools.${number}.details.creditConfiguration.amount` | `pools.${number}.displayName` | `pools.${number}.programDefinition._id` | `pools.${number}.program._id`, 6>>;
 /**
  * Redeems a specified benefit.
  *
@@ -2267,4 +2368,4 @@ interface CheckEligibilityByFilterOptions {
     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 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, checkEligibilityByFilter, 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 QueryPoolsOptions, 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, checkEligibilityByFilter, getEligibleBenefits, getPool, queryPools, redeemBenefit, typedQueryPools, updatePool };

package/build/internal/cjs/index.typings.js

@@ -503,7 +503,9 @@ function bulkUpdatePools(payload) {
           transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
           paths: [
             { path: "results.pool.createdDate" },
-            { path: "results.pool.updatedDate" }
+            { path: "results.pool.updatedDate" },
+            { path: "results.item.createdDate" },
+            { path: "results.item.updatedDate" }
           ]
         }
       ])
@@ -691,11 +693,14 @@ async function updatePool2(_id, pool) {
     throw transformedError;
   }
 }
-function queryPools2() {
-  const { httpClient, sideEffects } = arguments[0];
+function queryPools2(options) {
+  const { httpClient, sideEffects } = arguments[1];
   return (0, import_query_builder.queryBuilder)({
     func: async (payload) => {
-      const reqOpts = queryPools(payload);
+      const reqOpts = queryPools({
+        ...payload,
+        ...options ?? {}
+      });
       sideEffects?.onSiteCall?.();
       try {
         const result = await httpClient.request(reqOpts);
@@ -707,7 +712,7 @@ function queryPools2() {
       }
     },
     requestTransformer: (query) => {
-      const args = [query, {}];
+      const args = [query, options];
       return (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
         ...args?.[1],
         query: args?.[0]
@@ -734,9 +739,12 @@ function queryPools2() {
     transformationPaths: {}
   });
 }
-async function typedQueryPools(query) {
-  const { httpClient, sideEffects } = arguments[1];
-  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({ query });
+async function typedQueryPools(query, options) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    query,
+    ...options
+  });
   const reqOpts = queryPools(payload);
   sideEffects?.onSiteCall?.();
   try {
@@ -751,7 +759,7 @@ async function typedQueryPools(query) {
         explicitPathsToArguments: { query: "$[0]" },
         singleArgumentUnchanged: false
       },
-      ["query"]
+      ["query", "options"]
     );
     sideEffects?.onError?.(err);
     throw transformedError;