@wix/auto_sdk_benefit-programs_pools 1.0.79 → 1.0.80

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

@@ -689,6 +689,38 @@ interface ReallocationDetails {
     /** Beneficiary of the entitlement */
     beneficiary?: CommonIdentificationData;
 }
+interface RedemptionCanceled {
+    /** Pool which the canceled redemption belongs to */
+    pool?: Pool;
+    /** Details of the cancellation */
+    cancellationDetails?: CancellationDetails;
+}
+interface CancellationDetails {
+    /**
+     * Id of the cancellation transaction. This is the terminal transaction of the chain
+     * @format GUID
+     */
+    transactionId?: string;
+    /**
+     * Id of the transaction superseded by the cancellation
+     * @format GUID
+     */
+    previousTransactionId?: string;
+    /** Reference of the item whose redemption was canceled */
+    itemReference?: ItemReference;
+    /**
+     * Number of items that were redeemed
+     * @min 1
+     */
+    itemCount?: number;
+    /**
+     * Idempotency key of the cancellation request
+     * @maxLength 200
+     */
+    idempotencyKey?: string;
+    /** Beneficiary of the entitlement */
+    beneficiary?: CommonIdentificationData;
+}
 interface PoolPaused {
     /** Pool which has been paused */
     pool?: Pool;
@@ -1293,6 +1325,27 @@ interface AlreadyExecuted {
      */
     idempotencyKey?: string;
 }
+interface CancelRedemptionRequest {
+    /**
+     * 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;
+    /**
+     * Unique identifier, generated by the client.
+     * Used to recognize repeated attempts to make the same request.
+     * @maxLength 200
+     */
+    idempotencyKey: string;
+}
+interface CancelRedemptionResponse {
+    /**
+     * ID of the cancellation transaction. This is the terminal transaction of the chain.
+     * @format GUID
+     */
+    transactionId?: string;
+}
 interface ReserveBenefitRequest {
     /**
      * Id of the pool that is being redeemed from
@@ -2159,6 +2212,32 @@ type ReallocateBenefitApplicationErrors = {
     data?: AlreadyExecuted;
 };
 /** @docsIgnore */
+type CancelRedemptionApplicationErrors = {
+    code?: 'TRANSACTION_NOT_FOUND';
+    description?: string;
+    data?: TransactionNotFound;
+} | {
+    code?: 'NOT_LATEST_TRANSACTION';
+    description?: string;
+    data?: NotLatestTransaction;
+} | {
+    code?: 'REDEMPTION_ALREADY_CANCELED';
+    description?: string;
+    data?: RedemptionAlreadyCanceled;
+} | {
+    code?: 'TRANSACTION_NOT_CANCELABLE';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    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;
@@ -2602,6 +2681,32 @@ interface ReallocateBenefitOptions {
      */
     namespace: string;
 }
+/**
+ * Cancels a redemption, crediting the redeemed amount back to the pool's available balance.
+ *
+ * The cancellation is recorded as a new transaction that supersedes the specified transaction and terminates the redemption's transaction chain.
+ * The specified transaction must be the latest transaction in the chain. The credited amount is always the amount of the original redemption, regardless of any reallocations in between.
+ * @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
+ * @requiredField options.idempotencyKey
+ * @requiredField transactionId
+ * @permissionId benefit_programs:v1:pool:cancel_redemption
+ * @fqn wix.benefit_programs.v1.pool.PoolService.CancelRedemption
+ */
+declare function cancelRedemption(transactionId: string, options: NonNullablePaths<CancelRedemptionOptions, `idempotencyKey`, 2>): Promise<NonNullablePaths<CancelRedemptionResponse, `transactionId`, 2> & {
+    __applicationErrorsType?: CancelRedemptionApplicationErrors;
+}>;
+interface CancelRedemptionOptions {
+    /**
+     * Unique identifier, generated by the client.
+     * Used to recognize repeated attempts to make the same request.
+     * @maxLength 200
+     */
+    idempotencyKey: string;
+}
 /**
  * Checks if a benefit can currently be redeemed.
  *
@@ -2831,4 +2936,4 @@ interface CheckBenefitEligibilityByFilterOptions {
     poolSelector?: PoolSelector;
 }
 
-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 };
+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 CancelRedemptionApplicationErrors, type CancelRedemptionOptions, type CancelRedemptionRequest, type CancelRedemptionResponse, type CancellationDetails, 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 RedemptionCanceled, 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, cancelRedemption, checkBenefitEligibility, checkBenefitEligibilityByFilter, getEligibleBenefits, getPool, queryPools, reallocateBenefit, redeemBenefit, typedQueryPools, updatePool, utils };

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

@@ -36,6 +36,7 @@ __export(index_typings_exports, {
   WeekDay: () => WeekDay,
   bulkCheckBenefitEligibility: () => bulkCheckBenefitEligibility2,
   bulkUpdatePools: () => bulkUpdatePools2,
+  cancelRedemption: () => cancelRedemption2,
   checkBenefitEligibility: () => checkBenefitEligibility2,
   checkBenefitEligibilityByFilter: () => checkBenefitEligibilityByFilter2,
   getEligibleBenefits: () => getEligibleBenefits2,
@@ -411,6 +412,27 @@ function reallocateBenefit(payload) {
   }
   return __reallocateBenefit;
 }
+function cancelRedemption(payload) {
+  function __cancelRedemption({ host }) {
+    const metadata = {
+      entityFqdn: "wix.benefit_programs.v1.pool",
+      method: "POST",
+      methodFqn: "wix.benefit_programs.v1.pool.PoolService.CancelRedemption",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixBenefitProgramsV1PoolPoolServiceUrl({
+        protoPath: "/v1/benefits/cancel-redemption",
+        data: payload,
+        host
+      }),
+      data: payload
+    };
+    return metadata;
+  }
+  return __cancelRedemption;
+}
 function checkBenefitEligibility(payload) {
   function __checkBenefitEligibility({ host }) {
     const serializedData = (0, import_transform_paths.transformPaths)(payload, [
@@ -865,6 +887,35 @@ async function reallocateBenefit2(transactionId, options) {
     throw transformedError;
   }
 }
+async function cancelRedemption2(transactionId, options) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    transactionId,
+    idempotencyKey: options?.idempotencyKey
+  });
+  const reqOpts = cancelRedemption(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]",
+          idempotencyKey: "$[1].idempotencyKey"
+        },
+        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)({
@@ -1064,6 +1115,7 @@ async function checkBenefitEligibilityByFilter2(options) {
   WeekDay,
   bulkCheckBenefitEligibility,
   bulkUpdatePools,
+  cancelRedemption,
   checkBenefitEligibility,
   checkBenefitEligibilityByFilter,
   getEligibleBenefits,