@wix/auto_sdk_benefit-programs_balances 1.0.22 → 1.0.23

package/build/internal/cjs/{benefit-programs-v1-balance-balances.universal-m87JvYFn.d.ts → index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface Balance {
     /**
      * Balance ID. This is the same as the associated pool's ID.
@@ -95,6 +97,8 @@ declare enum IdentityType {
     /** A Wix account holder, such as a site owner or contributor. */
     WIX_USER = "WIX_USER"
 }
+/** @enumType */
+type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER';
 interface BalanceAmount {
     /**
      * number of available credits.
@@ -386,6 +390,8 @@ declare enum LimitRule {
     /** If the limit is exceeded, the operation will succeed but the balance will be adjusted so that it satisfies the provided limits. If the resulting balance is below the lower_limit, it will be set to the lower_limit. If the resulting balance is above the upper_limit, it will be set to the upper_limit. */
     HARD_ENFORCE = "HARD_ENFORCE"
 }
+/** @enumType */
+type LimitRuleWithLiterals = LimitRule | 'UNKNOWN_LIMIT_RULE' | 'FAIL' | 'SOFT_ENFORCE' | 'HARD_ENFORCE';
 interface SetOptions {
     /**
      * Amount to set the balance's available credits to.
@@ -770,6 +776,49 @@ declare enum WebhookIdentityType {
 }
 /** @enumType */
 type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+type ChangeBalanceApplicationErrors = {
+    code?: 'ALREADY_EXECUTED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'BALANCE_EXCEEDED_LIMITS';
+    description?: string;
+    data?: BalanceExceededLimits;
+};
+type RevertBalanceChangeApplicationErrors = {
+    code?: 'CHANGE_ALREADY_REVERTED';
+    description?: string;
+    data?: ChangeAlreadyReverted;
+} | {
+    code?: 'NOT_ENOUGH_BALANCE';
+    description?: string;
+    data?: NotEnoughBalance;
+} | {
+    code?: 'TRANSACTION_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+};
+/**
+ * Retrieves a balance.
+ * @param poolId - ID of the pool associated with the balance to retrieve. This is also the ID of the balance.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField poolId
+ * @permissionId BENEFIT_PROGRAMS.BALANCE_READ
+ * @applicableIdentity APP
+ * @returns Retrieved balance.
+ * @fqn wix.benefit_programs.v1.balance.BalanceService.GetBalance
+ */
+declare function getBalance(poolId: string): Promise<NonNullablePaths<Balance, `_id` | `beneficiary.anonymousVisitorId` | `beneficiary.memberId` | `beneficiary.wixUserId` | `amount.available` | `poolInfo._id` | `poolInfo.status`, 3>>;
+/**
+ * Retrieves a list of balances.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId BENEFIT_PROGRAMS.BALANCE_READ
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.balance.BalanceService.ListBalances
+ */
+declare function listBalances(options?: ListBalancesOptions): Promise<NonNullablePaths<ListBalancesResponse, `balances` | `balances.${number}._id` | `balances.${number}.beneficiary.anonymousVisitorId` | `balances.${number}.beneficiary.memberId` | `balances.${number}.beneficiary.wixUserId` | `balances.${number}.amount.available` | `balances.${number}.poolInfo._id` | `balances.${number}.poolInfo.status`, 5>>;
 interface ListBalancesOptions {
     /**
      * List of IDs of the pools associated with the balances to retrieve. These are also the IDs of the balances.
@@ -780,6 +829,25 @@ interface ListBalancesOptions {
     /** Cursor paging. */
     cursorPaging?: CursorPaging;
 }
+/**
+ * Creates a query to retrieve a list of balances.
+ *
+ * The Query Balances method builds a query to retrieve a list of balances and returns a `BalancesQueryBuilder` object.
+ *
+ * The returned object contains the query definition, which is used to run the query using the `find()` method.
+ *
+ * You can refine the query by chaining `BalancesQueryBuilder` methods onto the query. `BalancesQueryBuilder` methods enable you to filter, sort, and control the results that Query Balances returns.
+ *
+ * Query Balances has a default paging limit of 50, which you can override.
+ *
+ *  For a full description of the item object, see the object returned for the `items` property in `BalancesQueryResult`.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId BENEFIT_PROGRAMS.BALANCE_READ
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.balance.BalanceService.QueryBalances
+ */
+declare function queryBalances(): BalancesQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -857,6 +925,25 @@ interface BalancesQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<BalancesQueryResult>;
 }
+/**
+ * Changes the number of available credits in a balance.
+ *
+ * You can adjust or set the number of available credits.
+ * @param poolId - ID of the pool associated with the balance to change. This is also the ID of the balance.
+ * @param idempotencyKey - Unique identifier, generated by the client.
+ * Used to recognize repeated attempts to make the same request.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField idempotencyKey
+ * @requiredField options.operation
+ * @requiredField poolId
+ * @permissionId BENEFIT_PROGRAMS.BALANCE_CHANGE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.balance.BalanceService.ChangeBalance
+ */
+declare function changeBalance(poolId: string, idempotencyKey: string, options?: ChangeBalanceOptions): Promise<NonNullablePaths<ChangeBalanceResponse, `balance._id` | `balance.beneficiary.anonymousVisitorId` | `balance.beneficiary.memberId` | `balance.beneficiary.wixUserId` | `balance.amount.available` | `balance.poolInfo._id` | `balance.poolInfo.status`, 4> & {
+    __applicationErrorsType?: ChangeBalanceApplicationErrors;
+}>;
 interface ChangeBalanceOptions extends ChangeBalanceOptionsOperationOneOf {
     /** Identity changing the balance. */
     instructingParty?: CommonIdentificationData;
@@ -876,9 +963,30 @@ interface ChangeBalanceOptionsOperationOneOf {
     /** Set the balance to a specific number of credits. */
     setOptions?: SetOptions;
 }
+/**
+ * Reverts a transaction created by calling Change Balance.
+ *
+ * For example, if a transaction increased a balance's available credits by 5,
+ * calling Revert Balance Change with the transaction's ID will decrease the balance's available credit by 5.
+ *
+ * > **Note:** If the Change Balance call set the balance, Revert Transaction reverts the amount the balance changed by, ensuring subsequent balance changes are still reflected after the reversion.
+ * @param transactionId - ID of the transaction associated with the balance change to revert.
+ * @param idempotencyKey - Unique identifier, generated by the client.
+ * Used to recognize repeated attempts to make the same request.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField idempotencyKey
+ * @requiredField transactionId
+ * @permissionId BENEFIT_PROGRAMS.BALANCE_CHANGE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.balance.BalanceService.RevertBalanceChange
+ */
+declare function revertBalanceChange(transactionId: string, idempotencyKey: string, options?: RevertBalanceChangeOptions): Promise<RevertBalanceChangeResponse & {
+    __applicationErrorsType?: RevertBalanceChangeApplicationErrors;
+}>;
 interface RevertBalanceChangeOptions {
     /** Identity reverting the balance change. */
     instructingParty?: CommonIdentificationData;
 }
 
-export { type GetTransactionReversibilityResponse as $, type AdjustOptions as A, type Balance as B, type ChangeBalanceOptions as C, type Item as D, type ExtendedFields as E, type BalanceExceededLimits as F, type GetBalanceRequest as G, type BulkChangeBalancesRequest as H, IdentityType as I, type ChangeBalanceRequest as J, type ChangeBalanceRequestOperationOneOf as K, type ListBalancesOptions as L, type BulkChangeBalancesResponse as M, type ItemMetadata as N, type ApplicationError as O, PoolStatus as P, type QueryBalancesRequest as Q, type RevertBalanceChangeOptions as R, SortOrder as S, Type as T, type BulkChangeBalanceResult as U, type BulkActionMetadata as V, WebhookIdentityType as W, type RevertBalanceChangeRequest as X, type ChangeAlreadyReverted as Y, type NotEnoughBalance as Z, type GetTransactionReversibilityRequest as _, type ListBalancesResponse as a, type DomainEvent as a0, type DomainEventBodyOneOf as a1, type EntityCreatedEvent as a2, type RestoreInfo as a3, type EntityUpdatedEvent as a4, type EntityDeletedEvent as a5, type ActionEvent as a6, type MessageEnvelope as a7, type IdentificationData as a8, type IdentificationDataIdOneOf as a9, type BalancesQueryResult as aa, type ChangeBalanceOptionsOperationOneOf as ab, type BalancesQueryBuilder as b, type ChangeBalanceResponse as c, type RevertBalanceChangeResponse as d, ChangeBalanceRequestType as e, LimitRule as f, TransactionReversibility as g, type CommonIdentificationData as h, type CommonIdentificationDataIdOneOf as i, type BalanceAmount as j, type PoolInfo as k, type RolloverConfigurationInfo as l, type GetBalanceResponse as m, type ListBalancesRequest as n, type CursorPaging as o, type CursorPagingMetadata as p, type Cursors as q, type CursorQuery as r, type CursorQueryPagingMethodOneOf as s, type Sorting as t, type QueryBalancesResponse as u, type BalanceChangeBalanceRequest as v, type BalanceChangeBalanceRequestOperationOneOf as w, type SetOptions as x, type SetInitialOptions as y, type TransactionDetails as z };
+export { type ActionEvent, type AdjustOptions, type ApplicationError, type Balance, type BalanceAmount, type BalanceChangeBalanceRequest, type BalanceChangeBalanceRequestOperationOneOf, type BalanceExceededLimits, type BalancesQueryBuilder, type BalancesQueryResult, type BulkActionMetadata, type BulkChangeBalanceResult, type BulkChangeBalancesRequest, type BulkChangeBalancesResponse, type ChangeAlreadyReverted, type ChangeBalanceApplicationErrors, type ChangeBalanceOptions, type ChangeBalanceOptionsOperationOneOf, type ChangeBalanceRequest, type ChangeBalanceRequestOperationOneOf, ChangeBalanceRequestType, type ChangeBalanceRequestTypeWithLiterals, type ChangeBalanceResponse, type CommonIdentificationData, type CommonIdentificationDataIdOneOf, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type GetBalanceRequest, type GetBalanceResponse, type GetTransactionReversibilityRequest, type GetTransactionReversibilityResponse, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type IdentityTypeWithLiterals, type Item, type ItemMetadata, LimitRule, type LimitRuleWithLiterals, type ListBalancesOptions, type ListBalancesRequest, type ListBalancesResponse, type MessageEnvelope, type NotEnoughBalance, type PoolInfo, PoolStatus, type PoolStatusWithLiterals, type QueryBalancesRequest, type QueryBalancesResponse, type RestoreInfo, type RevertBalanceChangeApplicationErrors, type RevertBalanceChangeOptions, type RevertBalanceChangeRequest, type RevertBalanceChangeResponse, type RolloverConfigurationInfo, type SetInitialOptions, type SetOptions, SortOrder, type SortOrderWithLiterals, type Sorting, type TransactionDetails, TransactionReversibility, type TransactionReversibilityWithLiterals, Type, type TypeWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, changeBalance, getBalance, listBalances, queryBalances, revertBalanceChange };