@wix/auto_sdk_benefit-programs_balances 1.0.11 → 1.0.13

package/build/cjs/src/benefit-programs-v1-balance-balances.types.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookIdentityType = exports.TransactionReversibility = exports.Type = exports.LimitRule = exports.ChangeBalanceRequestType = exports.SortOrder = exports.IdentityType = void 0;
+var IdentityType;
+(function (IdentityType) {
+    /** Unknown type. This value is not used. */
+    IdentityType["UNKNOWN"] = "UNKNOWN";
+    /** A site visitor who has not logged in. */
+    IdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    /** A logged-in site member. */
+    IdentityType["MEMBER"] = "MEMBER";
+    /** A Wix account holder, such as a site owner or contributor. */
+    IdentityType["WIX_USER"] = "WIX_USER";
+})(IdentityType || (exports.IdentityType = IdentityType = {}));
+var SortOrder;
+(function (SortOrder) {
+    /** Ascending sort order. */
+    SortOrder["ASC"] = "ASC";
+    /** Descending sort order. */
+    SortOrder["DESC"] = "DESC";
+})(SortOrder || (exports.SortOrder = SortOrder = {}));
+var ChangeBalanceRequestType;
+(function (ChangeBalanceRequestType) {
+    /** Unknown balance change type. */
+    ChangeBalanceRequestType["UNKNOWN_OPERATION"] = "UNKNOWN_OPERATION";
+    /** Use with `adjustOptions`. */
+    ChangeBalanceRequestType["ADJUST"] = "ADJUST";
+    /** Use with `setOptions`. */
+    ChangeBalanceRequestType["SET"] = "SET";
+})(ChangeBalanceRequestType || (exports.ChangeBalanceRequestType = ChangeBalanceRequestType = {}));
+var LimitRule;
+(function (LimitRule) {
+    /** Unknown limit rule */
+    LimitRule["UNKNOWN_LIMIT_RULE"] = "UNKNOWN_LIMIT_RULE";
+    /** If the limit is exceeded, the operation will fail */
+    LimitRule["FAIL"] = "FAIL";
+    /** If the limit is exceeded, the operation will succeed but the balance never goes beyond the provided limits. For balance that was already outside of provided limits, it will not be changed. */
+    LimitRule["SOFT_ENFORCE"] = "SOFT_ENFORCE";
+    /** 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. */
+    LimitRule["HARD_ENFORCE"] = "HARD_ENFORCE";
+})(LimitRule || (exports.LimitRule = LimitRule = {}));
+var Type;
+(function (Type) {
+    /** Unknown balance change type. */
+    Type["UNKNOWN_OPERATION"] = "UNKNOWN_OPERATION";
+})(Type || (exports.Type = Type = {}));
+/** Transaction reversibility results */
+var TransactionReversibility;
+(function (TransactionReversibility) {
+    /** Transaction is allowed to be reverted */
+    TransactionReversibility["TRANSACTION_IS_REVERSIBLE"] = "TRANSACTION_IS_REVERSIBLE";
+    /** Transaction isn't allowed to be reverted, because it was already reverted */
+    TransactionReversibility["TRANSACTION_ALREADY_REVERSED"] = "TRANSACTION_ALREADY_REVERSED";
+})(TransactionReversibility || (exports.TransactionReversibility = TransactionReversibility = {}));
+var WebhookIdentityType;
+(function (WebhookIdentityType) {
+    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
+    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    WebhookIdentityType["MEMBER"] = "MEMBER";
+    WebhookIdentityType["WIX_USER"] = "WIX_USER";
+    WebhookIdentityType["APP"] = "APP";
+})(WebhookIdentityType || (exports.WebhookIdentityType = WebhookIdentityType = {}));
+//# sourceMappingURL=benefit-programs-v1-balance-balances.types.js.map

package/build/cjs/src/benefit-programs-v1-balance-balances.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"benefit-programs-v1-balance-balances.types.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-balance-balances.types.ts"],"names":[],"mappings":";;;AA2FA,IAAY,YASX;AATD,WAAY,YAAY;IACtB,4CAA4C;IAC5C,mCAAmB,CAAA;IACnB,4CAA4C;IAC5C,uDAAuC,CAAA;IACvC,+BAA+B;IAC/B,iCAAiB,CAAA;IACjB,iEAAiE;IACjE,qCAAqB,CAAA;AACvB,CAAC,EATW,YAAY,4BAAZ,YAAY,QASvB;AAmLD,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAA4B;IAC5B,wBAAW,CAAA;IACX,6BAA6B;IAC7B,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AA0CD,IAAY,wBAOX;AAPD,WAAY,wBAAwB;IAClC,mCAAmC;IACnC,mEAAuC,CAAA;IACvC,gCAAgC;IAChC,6CAAiB,CAAA;IACjB,6BAA6B;IAC7B,uCAAW,CAAA;AACb,CAAC,EAPW,wBAAwB,wCAAxB,wBAAwB,QAOnC;AAcD,IAAY,SASX;AATD,WAAY,SAAS;IACnB,yBAAyB;IACzB,sDAAyC,CAAA;IACzC,wDAAwD;IACxD,0BAAa,CAAA;IACb,mMAAmM;IACnM,0CAA6B,CAAA;IAC7B,kTAAkT;IAClT,0CAA6B,CAAA;AAC/B,CAAC,EATW,SAAS,yBAAT,SAAS,QASpB;AAgID,IAAY,IAGX;AAHD,WAAY,IAAI;IACd,mCAAmC;IACnC,+CAAuC,CAAA;AACzC,CAAC,EAHW,IAAI,oBAAJ,IAAI,QAGf;AAmID,wCAAwC;AACxC,IAAY,wBAKX;AALD,WAAY,wBAAwB;IAClC,4CAA4C;IAC5C,mFAAuD,CAAA;IACvD,gFAAgF;IAChF,yFAA6D,CAAA;AAC/D,CAAC,EALW,wBAAwB,wCAAxB,wBAAwB,QAKnC;AAmJD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}

package/build/{benefit-programs-v1-balance-balances.universal-qcbBfXdg.d.mts → cjs/src/benefit-programs-v1-balance-balances.universal.d.ts}

@@ -1,4 +1,5 @@
-interface Balance {
+import { NonNullablePaths } from '@wix/sdk-types';
+export interface Balance {
     /**
      * Balance ID. This is the same as the associated pool's ID.
      * @format GUID
@@ -50,7 +51,7 @@ interface Balance {
      */
     lastTransactionId?: string | null;
 }
-interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
+export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
     /**
      * ID of a site visitor that hasn't logged in to the site.
      * @format GUID
@@ -68,7 +69,7 @@ interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
     wixUserId?: string;
 }
 /** @oneof */
-interface CommonIdentificationDataIdOneOf {
+export interface CommonIdentificationDataIdOneOf {
     /**
      * ID of a site visitor that hasn't logged in to the site.
      * @format GUID
@@ -85,7 +86,7 @@ interface CommonIdentificationDataIdOneOf {
      */
     wixUserId?: string;
 }
-declare enum IdentityType {
+export declare enum IdentityType {
     /** Unknown type. This value is not used. */
     UNKNOWN = "UNKNOWN",
     /** A site visitor who has not logged in. */
@@ -95,7 +96,7 @@ declare enum IdentityType {
     /** A Wix account holder, such as a site owner or contributor. */
     WIX_USER = "WIX_USER"
 }
-interface BalanceAmount {
+export interface BalanceAmount {
     /**
      * number of available credits.
      * @decimalValue options { maxScale:4 }
@@ -103,7 +104,7 @@ interface BalanceAmount {
      */
     available?: string;
 }
-interface PoolInfo {
+export interface PoolInfo {
     /**
      * Pool ID.
      * @format GUID
@@ -140,7 +141,7 @@ interface PoolInfo {
      */
     namespace?: string | null;
 }
-interface ExtendedFields {
+export interface ExtendedFields {
     /**
      * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
      * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -151,18 +152,18 @@ interface ExtendedFields {
      */
     namespaces?: Record<string, Record<string, any>>;
 }
-interface GetBalanceRequest {
+export interface GetBalanceRequest {
     /**
      * ID of the pool associated with the balance to retrieve. This is also the ID of the balance.
      * @format GUID
      */
     poolId: string;
 }
-interface GetBalanceResponse {
+export interface GetBalanceResponse {
     /** Retrieved balance. */
     balance?: Balance;
 }
-interface ListBalancesRequest {
+export interface ListBalancesRequest {
     /**
      * List of IDs of the pools associated with the balances to retrieve. These are also the IDs of the balances.
      * @format GUID
@@ -172,7 +173,7 @@ interface ListBalancesRequest {
     /** Cursor paging. */
     cursorPaging?: CursorPaging;
 }
-interface CursorPaging {
+export interface CursorPaging {
     /**
      * Maximum number of items to return.
      * @max 100
@@ -187,7 +188,7 @@ interface CursorPaging {
      */
     cursor?: string | null;
 }
-interface ListBalancesResponse {
+export interface ListBalancesResponse {
     /**
      * Retrieved balances.
      * @maxSize 100
@@ -196,7 +197,7 @@ interface ListBalancesResponse {
     /** Metadata for paginated results. */
     metadata?: CursorPagingMetadata;
 }
-interface CursorPagingMetadata {
+export interface CursorPagingMetadata {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
@@ -209,7 +210,7 @@ interface CursorPagingMetadata {
      */
     hasNext?: boolean | null;
 }
-interface Cursors {
+export interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -221,11 +222,11 @@ interface Cursors {
      */
     prev?: string | null;
 }
-interface QueryBalancesRequest {
+export interface QueryBalancesRequest {
     /** Filter, sort, and paging to apply to the query. */
     query?: CursorQuery;
 }
-interface CursorQuery extends CursorQueryPagingMethodOneOf {
+export 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`. */
     cursorPaging?: CursorPaging;
     /**
@@ -241,11 +242,11 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
     sort?: Sorting[];
 }
 /** @oneof */
-interface CursorQueryPagingMethodOneOf {
+export interface 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`. */
     cursorPaging?: CursorPaging;
 }
-interface Sorting {
+export interface Sorting {
     /**
      * Field to sort by.
      * @maxLength 512
@@ -258,19 +259,19 @@ interface Sorting {
      */
     order?: SortOrder;
 }
-declare enum SortOrder {
+export declare enum SortOrder {
     /** Ascending sort order. */
     ASC = "ASC",
     /** Descending sort order. */
     DESC = "DESC"
 }
-interface QueryBalancesResponse {
+export interface QueryBalancesResponse {
     /** List of retrieved balances. */
     balances?: Balance[];
     /** Metadata for the paginated results. */
     metadata?: CursorPagingMetadata;
 }
-interface BalanceChangeBalanceRequest extends BalanceChangeBalanceRequestOperationOneOf {
+export interface BalanceChangeBalanceRequest extends BalanceChangeBalanceRequestOperationOneOf {
     /** Adjust the balance by a specific number of credits. */
     adjustOptions?: AdjustOptions;
     /** Set the balance to a specific number of credits. */
@@ -294,13 +295,13 @@ interface BalanceChangeBalanceRequest extends BalanceChangeBalanceRequestOperati
     transactionDetails?: TransactionDetails;
 }
 /** @oneof */
-interface BalanceChangeBalanceRequestOperationOneOf {
+export interface BalanceChangeBalanceRequestOperationOneOf {
     /** Adjust the balance by a specific number of credits. */
     adjustOptions?: AdjustOptions;
     /** Set the balance to a specific number of credits. */
     setOptions?: SetOptions;
 }
-declare enum ChangeBalanceRequestType {
+export declare enum ChangeBalanceRequestType {
     /** Unknown balance change type. */
     UNKNOWN_OPERATION = "UNKNOWN_OPERATION",
     /** Use with `adjustOptions`. */
@@ -308,7 +309,7 @@ declare enum ChangeBalanceRequestType {
     /** Use with `setOptions`. */
     SET = "SET"
 }
-interface AdjustOptions {
+export interface AdjustOptions {
     /**
      * Amount to change the balance's available credits by.
      * - To increase the balance, specify a positive number.
@@ -319,7 +320,7 @@ interface AdjustOptions {
     /** Beneficiary of the associated pool. */
     beneficiary?: CommonIdentificationData;
 }
-declare enum LimitRule {
+export declare enum LimitRule {
     /** Unknown limit rule */
     UNKNOWN_LIMIT_RULE = "UNKNOWN_LIMIT_RULE",
     /** If the limit is exceeded, the operation will fail */
@@ -329,7 +330,7 @@ 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"
 }
-interface SetOptions {
+export interface SetOptions {
     /**
      * Amount to set the balance's available credits to.
      *
@@ -340,7 +341,7 @@ interface SetOptions {
     /** Beneficiary of the associated pool. */
     beneficiary?: CommonIdentificationData;
 }
-interface SetInitialOptions {
+export interface SetInitialOptions {
     /**
      * Set the available balance to the provided amount.
      * @decimalValue options { maxScale:4 }
@@ -349,7 +350,7 @@ interface SetInitialOptions {
     /** Benefit pool owner associated with this balance. */
     beneficiary?: CommonIdentificationData;
 }
-interface TransactionDetails {
+export interface TransactionDetails {
     /**
      * Item associated with the transaction.
      * @readonly
@@ -369,7 +370,7 @@ interface TransactionDetails {
      */
     reason?: string | null;
 }
-interface Item {
+export interface Item {
     /**
      * Item ID.
      * @format GUID
@@ -401,7 +402,7 @@ interface Item {
      */
     displayName?: string | null;
 }
-interface ChangeBalanceResponse {
+export interface ChangeBalanceResponse {
     /** Updated balance. */
     balance?: Balance;
     /**
@@ -410,7 +411,7 @@ interface ChangeBalanceResponse {
      */
     transactionId?: string | null;
 }
-interface BalanceExceededLimits {
+export interface BalanceExceededLimits {
     /** Current balance */
     balance?: BalanceAmount;
     /**
@@ -432,7 +433,7 @@ interface BalanceExceededLimits {
      */
     upperLimit?: string | null;
 }
-interface BulkChangeBalancesRequest {
+export interface BulkChangeBalancesRequest {
     /**
      * List of balances to change.
      * @minSize 1
@@ -448,11 +449,11 @@ interface BulkChangeBalancesRequest {
     /** Whether to return the full balance entities in the response. */
     returnEntity?: boolean;
 }
-declare enum Type {
+export declare enum Type {
     /** Unknown balance change type. */
     UNKNOWN_OPERATION = "UNKNOWN_OPERATION"
 }
-interface ChangeBalanceRequest extends ChangeBalanceRequestOperationOneOf {
+export interface ChangeBalanceRequest extends ChangeBalanceRequestOperationOneOf {
     /**
      * ID of the pool associated with the balance to change. This is also the ID of the balance.
      * @format GUID
@@ -466,9 +467,9 @@ interface ChangeBalanceRequest extends ChangeBalanceRequestOperationOneOf {
     transactionDetails?: TransactionDetails;
 }
 /** @oneof */
-interface ChangeBalanceRequestOperationOneOf {
+export interface ChangeBalanceRequestOperationOneOf {
 }
-interface BulkChangeBalancesResponse {
+export interface BulkChangeBalancesResponse {
     /**
      * Updated item and associated metadata.
      * @minSize 1
@@ -478,7 +479,7 @@ interface BulkChangeBalancesResponse {
     /** Metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
-interface ItemMetadata {
+export interface ItemMetadata {
     /**
      * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
      * @format GUID
@@ -491,7 +492,7 @@ interface ItemMetadata {
     /** Details about the error in case of failure. */
     error?: ApplicationError;
 }
-interface ApplicationError {
+export interface ApplicationError {
     /** Error code. */
     code?: string;
     /** Description of the error. */
@@ -499,13 +500,13 @@ interface ApplicationError {
     /** Data related to the error. */
     data?: Record<string, any> | null;
 }
-interface BulkChangeBalanceResult {
+export interface BulkChangeBalanceResult {
     /** Item metadata. */
     itemMetadata?: ItemMetadata;
     /** Updated item. */
     balance?: Balance;
 }
-interface BulkActionMetadata {
+export interface BulkActionMetadata {
     /** Number of items that were successfully processed. */
     totalSuccesses?: number;
     /** Number of items that couldn't be processed. */
@@ -513,7 +514,7 @@ interface BulkActionMetadata {
     /** Number of failures without details because detailed failure threshold was exceeded. */
     undetailedFailures?: number;
 }
-interface RevertBalanceChangeRequest {
+export interface RevertBalanceChangeRequest {
     /**
      * ID of the transaction associated with the balance change to revert.
      * @format GUID
@@ -528,14 +529,14 @@ interface RevertBalanceChangeRequest {
     /** Identity reverting the balance change. */
     instructingParty?: CommonIdentificationData;
 }
-interface RevertBalanceChangeResponse {
+export interface RevertBalanceChangeResponse {
     /**
      * ID of the transaction associated with the balance reversion.
      * @format GUID
      */
     transactionId?: string | null;
 }
-interface ChangeAlreadyReverted {
+export interface ChangeAlreadyReverted {
     /**
      * The id of the transaction which was already reverted
      * @format GUID
@@ -547,7 +548,7 @@ interface ChangeAlreadyReverted {
      */
     revertedTransactionId?: string;
 }
-interface NotEnoughBalance {
+export interface NotEnoughBalance {
     /** Current balance */
     balance?: BalanceAmount;
     /**
@@ -557,25 +558,25 @@ interface NotEnoughBalance {
      */
     requested?: string;
 }
-interface GetTransactionReversibilityRequest {
+export interface GetTransactionReversibilityRequest {
     /**
      * Id of the transaction to get the reversibility
      * @format GUID
      */
     transactionId?: string;
 }
-interface GetTransactionReversibilityResponse {
+export interface GetTransactionReversibilityResponse {
     /** The result of transaction reversibility validation */
     transactionReversibility?: TransactionReversibility;
 }
 /** Transaction reversibility results */
-declare enum TransactionReversibility {
+export declare enum TransactionReversibility {
     /** Transaction is allowed to be reverted */
     TRANSACTION_IS_REVERSIBLE = "TRANSACTION_IS_REVERSIBLE",
     /** Transaction isn't allowed to be reverted, because it was already reverted */
     TRANSACTION_ALREADY_REVERSED = "TRANSACTION_ALREADY_REVERSED"
 }
-interface DomainEvent extends DomainEventBodyOneOf {
+export interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -618,19 +619,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-interface DomainEventBodyOneOf {
+export interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-interface EntityCreatedEvent {
+export interface EntityCreatedEvent {
     entity?: string;
 }
-interface RestoreInfo {
+export interface RestoreInfo {
     deletedDate?: Date | null;
 }
-interface EntityUpdatedEvent {
+export interface EntityUpdatedEvent {
     /**
      * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
      * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -638,14 +639,14 @@ interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-interface EntityDeletedEvent {
+export interface EntityDeletedEvent {
     /** Entity that was deleted */
     deletedEntity?: string | null;
 }
-interface ActionEvent {
+export interface ActionEvent {
     body?: string;
 }
-interface MessageEnvelope {
+export interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -661,7 +662,7 @@ interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-interface IdentificationData extends IdentificationDataIdOneOf {
+export interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -686,7 +687,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-interface IdentificationDataIdOneOf {
+export interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -708,14 +709,50 @@ interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-declare enum WebhookIdentityType {
+export declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-interface ListBalancesOptions {
+type BalanceNonNullablePaths = `_id` | `beneficiary.anonymousVisitorId` | `beneficiary.memberId` | `beneficiary.wixUserId` | `amount.available` | `poolInfo._id`;
+/**
+ * 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
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @applicableIdentity APP
+ * @returns Retrieved balance.
+ * @fqn wix.benefit_programs.v1.balance.BalanceService.GetBalance
+ */
+export declare function getBalance(poolId: string): Promise<NonNullablePaths<Balance, BalanceNonNullablePaths>>;
+/**
+ * Retrieves a list of balances.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId BENEFIT_PROGRAMS.BALANCE_READ
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.balance.BalanceService.ListBalances
+ */
+export declare function listBalances(options?: ListBalancesOptions): Promise<NonNullablePaths<ListBalancesResponse, {
+    [P in BalanceNonNullablePaths]: `balances.${number}.${P}`;
+}[BalanceNonNullablePaths]>>;
+export interface ListBalancesOptions {
     /**
      * List of IDs of the pools associated with the balances to retrieve. These are also the IDs of the balances.
      * @format GUID
@@ -725,6 +762,31 @@ 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
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId BENEFIT_PROGRAMS.BALANCE_READ
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.balance.BalanceService.QueryBalances
+ */
+export declare function queryBalances(): BalancesQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -732,13 +794,13 @@ interface QueryCursorResult {
     length: number;
     pageSize: number;
 }
-interface BalancesQueryResult extends QueryCursorResult {
+export interface BalancesQueryResult extends QueryCursorResult {
     items: Balance[];
     query: BalancesQueryBuilder;
     next: () => Promise<BalancesQueryResult>;
     prev: () => Promise<BalancesQueryResult>;
 }
-interface BalancesQueryBuilder {
+export interface BalancesQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
@@ -802,7 +864,28 @@ interface BalancesQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<BalancesQueryResult>;
 }
-interface ChangeBalanceOptions extends ChangeBalanceOptionsOperationOneOf {
+/**
+ * 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
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.balance.BalanceService.ChangeBalance
+ */
+export declare function changeBalance(poolId: string, idempotencyKey: string, options?: ChangeBalanceOptions): Promise<NonNullablePaths<ChangeBalanceResponse, {
+    [P in BalanceNonNullablePaths]: `balance.${P}`;
+}[BalanceNonNullablePaths]>>;
+export interface ChangeBalanceOptions extends ChangeBalanceOptionsOperationOneOf {
     /** Identity changing the balance. */
     instructingParty?: CommonIdentificationData;
     /** Balance change type. */
@@ -815,15 +898,35 @@ interface ChangeBalanceOptions extends ChangeBalanceOptionsOperationOneOf {
     transactionDetails?: TransactionDetails;
 }
 /** @oneof */
-interface ChangeBalanceOptionsOperationOneOf {
+export interface ChangeBalanceOptionsOperationOneOf {
     /** Adjust the balance by a specific number of credits. */
     adjustOptions?: AdjustOptions;
     /** Set the balance to a specific number of credits. */
     setOptions?: SetOptions;
 }
-interface RevertBalanceChangeOptions {
+/**
+ * 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
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.balance.BalanceService.RevertBalanceChange
+ */
+export declare function revertBalanceChange(transactionId: string, idempotencyKey: string, options?: RevertBalanceChangeOptions): Promise<RevertBalanceChangeResponse>;
+export interface RevertBalanceChangeOptions {
     /** Identity reverting the balance change. */
     instructingParty?: CommonIdentificationData;
 }
-
-export { type DomainEventBodyOneOf as $, type AdjustOptions as A, type Balance as B, type ChangeBalanceOptions as C, type BulkChangeBalancesRequest as D, type ExtendedFields as E, type ChangeBalanceRequest as F, type GetBalanceRequest as G, type ChangeBalanceRequestOperationOneOf as H, IdentityType as I, type BulkChangeBalancesResponse as J, type ItemMetadata as K, type ListBalancesOptions as L, type ApplicationError as M, type BulkChangeBalanceResult as N, type BulkActionMetadata as O, type PoolInfo as P, type QueryBalancesRequest as Q, type RevertBalanceChangeOptions as R, SortOrder as S, Type as T, type RevertBalanceChangeRequest as U, type ChangeAlreadyReverted as V, WebhookIdentityType as W, type NotEnoughBalance as X, type GetTransactionReversibilityRequest as Y, type GetTransactionReversibilityResponse as Z, type DomainEvent as _, type ListBalancesResponse as a, type EntityCreatedEvent as a0, type RestoreInfo as a1, type EntityUpdatedEvent as a2, type EntityDeletedEvent as a3, type ActionEvent as a4, type MessageEnvelope as a5, type IdentificationData as a6, type IdentificationDataIdOneOf as a7, type BalancesQueryResult as a8, type ChangeBalanceOptionsOperationOneOf as a9, 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 GetBalanceResponse as k, type ListBalancesRequest as l, type CursorPaging as m, type CursorPagingMetadata as n, type Cursors as o, type CursorQuery as p, type CursorQueryPagingMethodOneOf as q, type Sorting as r, type QueryBalancesResponse as s, type BalanceChangeBalanceRequest as t, type BalanceChangeBalanceRequestOperationOneOf as u, type SetOptions as v, type SetInitialOptions as w, type TransactionDetails as x, type Item as y, type BalanceExceededLimits as z };
+export {};