@wix/auto_sdk_benefit-programs_pools 1.0.78 → 1.0.79

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

@@ -653,6 +653,42 @@ interface ItemReference {
      */
     providerAppId?: string;
 }
+interface BenefitReallocated {
+    /** Pool which the reallocated benefit belongs to */
+    pool?: Pool;
+    /** Details of the reallocation */
+    reallocationDetails?: ReallocationDetails;
+}
+interface ReallocationDetails {
+    /**
+     * Id of the reallocation transaction. This is the new latest transaction in the chain
+     * @format GUID
+     */
+    transactionId?: string;
+    /**
+     * Id of the transaction superseded by the reallocation
+     * @format GUID
+     */
+    previousTransactionId?: string;
+    /** Reference of the item that is being reallocated */
+    itemReference?: ItemReference;
+    /**
+     * Number of items that were redeemed
+     * @min 1
+     */
+    itemCount?: number;
+    /** New date at which the item will be used */
+    targetDate?: Date | null;
+    /** Date at which the item would have been used before this reallocation */
+    previousTargetDate?: Date | null;
+    /**
+     * Idempotency key of the reallocation request
+     * @maxLength 200
+     */
+    idempotencyKey?: string;
+    /** Beneficiary of the entitlement */
+    beneficiary?: CommonIdentificationData;
+}
 interface PoolPaused {
     /** Pool which has been paused */
     pool?: Pool;
@@ -1191,6 +1227,72 @@ interface BenefitNotFound {
      */
     programInfo?: PoolProgramInfo;
 }
+interface ReallocateBenefitRequest {
+    /**
+     * ID of the latest transaction in the redemption's transaction chain.
+     * For a redemption that has never been reallocated, this is the redemption transaction ID.
+     * @format GUID
+     */
+    transactionId: string;
+    /** New date that the item will be provided to the beneficiary. */
+    targetDate: Date | null;
+    /**
+     * Unique identifier, generated by the client.
+     * Used to recognize repeated attempts to make the same request.
+     * @maxLength 200
+     */
+    idempotencyKey: string;
+    /** Beneficiary of the pool containing the benefit to reallocate. Must match the beneficiary of the original redemption. */
+    beneficiary?: CommonIdentificationData;
+    /**
+     * 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.
+     * @minLength 1
+     * @maxLength 20
+     */
+    namespace: string;
+}
+interface ReallocateBenefitResponse {
+    /**
+     * ID of the reallocation transaction. This is the new latest transaction in the chain.
+     * @format GUID
+     */
+    transactionId?: string;
+}
+interface TransactionNotFound {
+    /**
+     * ID of the transaction that wasn't found.
+     * @format GUID
+     */
+    transactionId?: string;
+}
+interface NotLatestTransaction {
+    /**
+     * ID of the latest transaction in the chain.
+     * @format GUID
+     */
+    latestTransactionId?: string;
+}
+interface RedemptionAlreadyCanceled {
+    /**
+     * ID of the transaction that canceled the redemption.
+     * @format GUID
+     */
+    cancellationTransactionId?: string;
+}
+interface ChainOperationInProgress {
+    /**
+     * ID of the pending transaction that hasn't settled yet.
+     * @format GUID
+     */
+    pendingTransactionId?: string;
+}
+interface AlreadyExecuted {
+    /**
+     * Idempotency key of the original request.
+     * @maxLength 200
+     */
+    idempotencyKey?: string;
+}
 interface ReserveBenefitRequest {
     /**
      * Id of the pool that is being redeemed from
@@ -2019,6 +2121,44 @@ type RedeemBenefitApplicationErrors = {
     data?: BenefitNotFound;
 };
 /** @docsIgnore */
+type ReallocateBenefitApplicationErrors = {
+    code?: 'TRANSACTION_NOT_FOUND';
+    description?: string;
+    data?: TransactionNotFound;
+} | {
+    code?: 'POOL_NOT_FOUND';
+    description?: string;
+    data?: PoolNotFound;
+} | {
+    code?: 'NOT_LATEST_TRANSACTION';
+    description?: string;
+    data?: NotLatestTransaction;
+} | {
+    code?: 'REDEMPTION_ALREADY_CANCELED';
+    description?: string;
+    data?: RedemptionAlreadyCanceled;
+} | {
+    code?: 'TRANSACTION_NOT_REALLOCATABLE';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'POOL_NOT_ACTIVE';
+    description?: string;
+    data?: PoolNotActive;
+} | {
+    code?: 'POLICY_EXPRESSION_EVALUATED_TO_FALSE';
+    description?: string;
+    data?: PolicyExpressionEvaluatedToFalse;
+} | {
+    code?: 'CHAIN_OPERATION_IN_PROGRESS';
+    description?: string;
+    data?: ChainOperationInProgress;
+} | {
+    code?: 'ALREADY_EXECUTED';
+    description?: string;
+    data?: AlreadyExecuted;
+};
+/** @docsIgnore */
 type GetEligibleBenefitsApplicationErrors = {
     code?: 'INVALID_ITEM_REFERENCE';
     description?: string;
@@ -2425,6 +2565,43 @@ interface RedeemBenefitOptions {
      */
     namespace: string;
 }
+/**
+ * Reallocates a redeemed benefit to a new target date.
+ *
+ * The reallocation is recorded as a new zero-amount transaction that supersedes the specified transaction in the redemption's transaction chain.
+ * The specified transaction must be the latest transaction in the chain. The item, count and benefit key are carried over from the original redemption; only the target date changes.
+ * @param transactionId - ID of the latest transaction in the redemption's transaction chain.
+ * For a redemption that has never been reallocated, this is the redemption transaction ID.
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField options.idempotencyKey
+ * @requiredField options.namespace
+ * @requiredField options.targetDate
+ * @requiredField transactionId
+ * @permissionId benefit_programs:v1:pool:reallocate_benefit
+ * @fqn wix.benefit_programs.v1.pool.PoolService.ReallocateBenefit
+ */
+declare function reallocateBenefit(transactionId: string, options?: NonNullablePaths<ReallocateBenefitOptions, `idempotencyKey` | `namespace` | `targetDate`, 2>): Promise<NonNullablePaths<ReallocateBenefitResponse, `transactionId`, 2> & {
+    __applicationErrorsType?: ReallocateBenefitApplicationErrors;
+}>;
+interface ReallocateBenefitOptions {
+    /** New date that the item will be provided to the beneficiary. */
+    targetDate: Date | null;
+    /**
+     * Unique identifier, generated by the client.
+     * Used to recognize repeated attempts to make the same request.
+     * @maxLength 200
+     */
+    idempotencyKey: string;
+    /** Beneficiary of the pool containing the benefit to reallocate. Must match the beneficiary of the original redemption. */
+    beneficiary?: CommonIdentificationData;
+    /**
+     * 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.
+     * @minLength 1
+     * @maxLength 20
+     */
+    namespace: string;
+}
 /**
  * Checks if a benefit can currently be redeemed.
  *
@@ -2654,4 +2831,4 @@ interface CheckBenefitEligibilityByFilterOptions {
     poolSelector?: PoolSelector;
 }
 
-export { type AccountInfo, 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 BenefitResult, type BenefitResultResultOneOf, BenefitResultType, type BenefitResultTypeWithLiterals, type BenefitSelector, type BulkActionMetadata, type BulkCheckBenefitEligibilityOptions, type BulkCheckBenefitEligibilityRequest, type BulkCheckBenefitEligibilityResponse, type BulkEligibilityCheckResult, type BulkPoolResult, type BulkUpdatePoolsOptions, type BulkUpdatePoolsRequest, type BulkUpdatePoolsResponse, type ByPoolDefinitionIdAndProgramDefinitionIdOptions, type ByProgramIdOptions, type CancelBenefitReservationRequest, type CancelBenefitReservationResponse, type CheckBenefitEligibilityByFilterApplicationErrors, type CheckBenefitEligibilityByFilterOptions, type CheckBenefitEligibilityByFilterRequest, type CheckBenefitEligibilityByFilterResponse, type CheckBenefitEligibilityOptions, type CheckBenefitEligibilityRequest, type CheckBenefitEligibilityResponse, type CommonIdentificationData, type CommonIdentificationDataIdOneOf, type CommonQueryWithEntityContext, 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 EligibleBenefit, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type FailureDetails, type FixedIntervalPolicy, type GetEligibleBenefitsApplicationErrors, type GetEligibleBenefitsOptions, type GetEligibleBenefitsRequest, type GetEligibleBenefitsResponse, type GetPoolRequest, type GetPoolResponse, type HealPoolRequest, type HealPoolResponse, type HealPoolTenantRequest, type HealPoolTenantResponse, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type IdentityTypeWithLiterals, Intent, type IntentWithLiterals, type InvalidPoolDefinitionReference, type ItemMetadata, type ItemReference, 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 PoolQuery, type PoolQuerySpec, type PoolRenewalAction, type PoolRenewalActionActionOneOf, PoolRenewalActionType, type PoolRenewalActionTypeWithLiterals, type PoolRenewed, type PoolResumed, type PoolSelector, PoolSelectorType, type PoolSelectorTypeWithLiterals, PoolStatus, type PoolStatusUpdateJobFinished, type PoolStatusUpdateJobFinishedContextOneOf, type PoolStatusUpdateParamsPoolInfo, type PoolStatusWithLiterals, 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, checkBenefitEligibilityByFilter, getEligibleBenefits, getPool, queryPools, redeemBenefit, typedQueryPools, updatePool, utils };
+export { type AccountInfo, type ActionEvent, type AlreadyExecuted, type ApplicationError, type AsyncResult, type BalanceAmount, type Benefit, type BenefitAlreadyRedeemed, type BenefitInfo, type BenefitNotFound, type BenefitReallocated, type BenefitRedeemed, type BenefitReservationCanceled, type BenefitReservationReleased, type BenefitReserved, type BenefitResult, type BenefitResultResultOneOf, BenefitResultType, type BenefitResultTypeWithLiterals, type BenefitSelector, type BulkActionMetadata, type BulkCheckBenefitEligibilityOptions, type BulkCheckBenefitEligibilityRequest, type BulkCheckBenefitEligibilityResponse, type BulkEligibilityCheckResult, type BulkPoolResult, type BulkUpdatePoolsOptions, type BulkUpdatePoolsRequest, type BulkUpdatePoolsResponse, type ByPoolDefinitionIdAndProgramDefinitionIdOptions, type ByProgramIdOptions, type CancelBenefitReservationRequest, type CancelBenefitReservationResponse, type ChainOperationInProgress, type CheckBenefitEligibilityByFilterApplicationErrors, type CheckBenefitEligibilityByFilterOptions, type CheckBenefitEligibilityByFilterRequest, type CheckBenefitEligibilityByFilterResponse, type CheckBenefitEligibilityOptions, type CheckBenefitEligibilityRequest, type CheckBenefitEligibilityResponse, type CommonIdentificationData, type CommonIdentificationDataIdOneOf, type CommonQueryWithEntityContext, 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 EligibleBenefit, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type FailureDetails, type FixedIntervalPolicy, type GetEligibleBenefitsApplicationErrors, type GetEligibleBenefitsOptions, type GetEligibleBenefitsRequest, type GetEligibleBenefitsResponse, type GetPoolRequest, type GetPoolResponse, type HealPoolRequest, type HealPoolResponse, type HealPoolTenantRequest, type HealPoolTenantResponse, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type IdentityTypeWithLiterals, Intent, type IntentWithLiterals, type InvalidPoolDefinitionReference, type ItemMetadata, type ItemReference, type MaskedPool, type MessageEnvelope, type NotEnoughBalance, type NotLatestTransaction, 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 PoolQuery, type PoolQuerySpec, type PoolRenewalAction, type PoolRenewalActionActionOneOf, PoolRenewalActionType, type PoolRenewalActionTypeWithLiterals, type PoolRenewed, type PoolResumed, type PoolSelector, PoolSelectorType, type PoolSelectorTypeWithLiterals, PoolStatus, type PoolStatusUpdateJobFinished, type PoolStatusUpdateJobFinishedContextOneOf, type PoolStatusUpdateParamsPoolInfo, type PoolStatusWithLiterals, 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 ReallocateBenefitApplicationErrors, type ReallocateBenefitOptions, type ReallocateBenefitRequest, type ReallocateBenefitResponse, type ReallocationDetails, type RedeemBenefitApplicationErrors, type RedeemBenefitOptions, type RedeemBenefitRequest, type RedeemBenefitResponse, type RedemptionAlreadyCanceled, 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 TransactionNotFound, 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, checkBenefitEligibilityByFilter, getEligibleBenefits, getPool, queryPools, reallocateBenefit, redeemBenefit, typedQueryPools, updatePool, utils };

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

@@ -41,6 +41,7 @@ __export(index_typings_exports, {
   getEligibleBenefits: () => getEligibleBenefits2,
   getPool: () => getPool2,
   queryPools: () => queryPools2,
+  reallocateBenefit: () => reallocateBenefit2,
   redeemBenefit: () => redeemBenefit2,
   typedQueryPools: () => typedQueryPools,
   updatePool: () => updatePool2,
@@ -383,6 +384,33 @@ function redeemBenefit(payload) {
   }
   return __redeemBenefit;
 }
+function reallocateBenefit(payload) {
+  function __reallocateBenefit({ host }) {
+    const serializedData = (0, import_transform_paths.transformPaths)(payload, [
+      {
+        transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
+        paths: [{ path: "targetDate" }]
+      }
+    ]);
+    const metadata = {
+      entityFqdn: "wix.benefit_programs.v1.pool",
+      method: "POST",
+      methodFqn: "wix.benefit_programs.v1.pool.PoolService.ReallocateBenefit",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixBenefitProgramsV1PoolPoolServiceUrl({
+        protoPath: "/v1/benefits/reallocate",
+        data: serializedData,
+        host
+      }),
+      data: serializedData
+    };
+    return metadata;
+  }
+  return __reallocateBenefit;
+}
 function checkBenefitEligibility(payload) {
   function __checkBenefitEligibility({ host }) {
     const serializedData = (0, import_transform_paths.transformPaths)(payload, [
@@ -802,6 +830,41 @@ async function redeemBenefit2(poolId, options) {
     throw transformedError;
   }
 }
+async function reallocateBenefit2(transactionId, options) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    transactionId,
+    targetDate: options?.targetDate,
+    idempotencyKey: options?.idempotencyKey,
+    beneficiary: options?.beneficiary,
+    namespace: options?.namespace
+  });
+  const reqOpts = reallocateBenefit(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {
+          transactionId: "$[0]",
+          targetDate: "$[1].targetDate",
+          idempotencyKey: "$[1].idempotencyKey",
+          beneficiary: "$[1].beneficiary",
+          namespace: "$[1].namespace"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["transactionId", "options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 async function checkBenefitEligibility2(poolId, options) {
   const { httpClient, sideEffects } = arguments[2];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
@@ -1006,6 +1069,7 @@ async function checkBenefitEligibilityByFilter2(options) {
   getEligibleBenefits,
   getPool,
   queryPools,
+  reallocateBenefit,
   redeemBenefit,
   typedQueryPools,
   updatePool,