@wix/auto_sdk_benefit-programs_balances 1.0.1 → 1.0.2

package/build/internal/cjs/src/benefit-programs-v1-balance-balances.universal.d.ts

@@ -1,6 +1,6 @@
 export interface Balance {
     /**
-     * Balance ID, which is the same as its associated pool ID.
+     * Balance ID. This is the same as the associated pool's ID.
      * @format GUID
      * @immutable
      */
@@ -22,17 +22,17 @@ export interface Balance {
      */
     _updatedDate?: Date | null;
     /**
-     * Identity of the individual that enrolled in the program associated with this pool balance.
+     * Beneficiary of the associated pool.
      * @readonly
      */
     beneficiary?: CommonIdentificationData;
     /**
-     * Benefit pool balance.
+     * Available credits.
      * @readonly
      */
     amount?: BalanceAmount;
     /**
-     * Pool information.
+     * Associated pool information.
      * @readonly
      */
     poolInfo?: PoolInfo;
@@ -42,7 +42,7 @@ export interface Balance {
      */
     extendedFields?: ExtendedFields;
     /**
-     * Last transaction ID that triggered the change in balance.
+     * ID of the transaction associated with the most recent change to the balance.
      * @format GUID
      * @readonly
      */
@@ -50,17 +50,17 @@ export interface Balance {
 }
 export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
     /**
-     * ID of a site visitor that has not logged in to the site.
+     * ID of a site visitor that hasn't logged in to the site.
      * @format GUID
      */
     anonymousVisitorId?: string;
     /**
-     * ID of a site visitor that has logged in to the site.
+     * ID of a site member.
      * @format GUID
      */
     memberId?: string;
     /**
-     * ID of a Wix user (site owner, contributor, etc.).
+     * ID of a Wix user.
      * @format GUID
      */
     wixUserId?: string;
@@ -68,17 +68,17 @@ export interface CommonIdentificationData extends CommonIdentificationDataIdOneO
 /** @oneof */
 export interface CommonIdentificationDataIdOneOf {
     /**
-     * ID of a site visitor that has not logged in to the site.
+     * ID of a site visitor that hasn't logged in to the site.
      * @format GUID
      */
     anonymousVisitorId?: string;
     /**
-     * ID of a site visitor that has logged in to the site.
+     * ID of a site member.
      * @format GUID
      */
     memberId?: string;
     /**
-     * ID of a Wix user (site owner, contributor, etc.).
+     * ID of a Wix user.
      * @format GUID
      */
     wixUserId?: string;
@@ -95,7 +95,7 @@ export declare enum IdentityType {
 }
 export interface BalanceAmount {
     /**
-     * Total credits available in the benefit pool.
+     * Amount of available credits.
      * @decimalValue options { maxScale:4 }
      * @readonly
      */
@@ -104,37 +104,35 @@ export interface BalanceAmount {
 export interface PoolInfo {
     /**
      * Pool ID.
-     *
-     * Represents the ID of the benefit pool linked to this balance.
      * @format GUID
      * @readonly
      */
     _id?: string;
     /**
-     * Pool definition that this benefit pool was instantiated from.
+     * ID of the pool definition the pool was created from.
      * @format GUID
      * @readonly
      */
     poolDefinitionId?: string | null;
     /**
-     * Program definition from which this benefit pool's program was provisioned from.
+     * ID of the program definition the pool was created from.
      * @format GUID
      * @readonly
      */
     programDefinitionId?: string | null;
     /**
-     * Active program that this benefit pool belongs to.
+     * ID of the program that contains the pool.
      * @format GUID
      * @readonly
      */
     programId?: string | null;
     /**
-     * Total credits available in this benefit pool
+     * Available credits.
      * @decimalValue options { gte:0, maxScale:4 }
      */
     creditAmount?: string | null;
     /**
-     * Module that is the source of this benefit pool creation.
+     * Namespace for your app or site's benefit programs.
      * @minLength 1
      * @maxLength 50
      */
@@ -153,7 +151,7 @@ export interface ExtendedFields {
 }
 export interface GetBalanceRequest {
     /**
-     * ID of the pool from which to retrieve the balance.
+     * ID of the pool associated with the balance to retrieve. This is also the ID of the balance.
      * @format GUID
      */
     poolId: string;
@@ -164,12 +162,12 @@ export interface GetBalanceResponse {
 }
 export interface ListBalancesRequest {
     /**
-     * IDs of the pools from which to receive the balances.
+     * List of IDs of the pools associated with the balances to retrieve. These are also the IDs of the balances.
      * @format GUID
      * @maxSize 100
      */
     poolIds?: string[];
-    /** Cursor paging */
+    /** Cursor paging. */
     cursorPaging?: CursorPaging;
 }
 export interface CursorPaging {
@@ -189,7 +187,7 @@ export interface CursorPaging {
 }
 export interface ListBalancesResponse {
     /**
-     * Balances.
+     * Retrieved balances.
      * @maxSize 100
      */
     balances?: Balance[];
@@ -222,7 +220,7 @@ export interface Cursors {
     prev?: string | null;
 }
 export interface QueryBalancesRequest {
-    /** Query to select balances. */
+    /** Filter, sort, and paging to apply to the query. */
     query?: CursorQuery;
 }
 export interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -265,18 +263,18 @@ export declare enum SortOrder {
     DESC = "DESC"
 }
 export interface QueryBalancesResponse {
-    /** List of balances. */
+    /** List of retrieved balances. */
     balances?: Balance[];
     /** Metadata for the paginated results. */
     metadata?: CursorPagingMetadata;
 }
 export interface BalanceChangeBalanceRequest extends BalanceChangeBalanceRequestOperationOneOf {
-    /** Set the amount of credits to adjust the balance to. */
+    /** Adjust the balance by a specific amount of credits. */
     adjustOptions?: AdjustOptions;
-    /** Sets the balance to a specific amount. */
+    /** Set the balance to a specific amount of credits. */
     setOptions?: SetOptions;
     /**
-     * ID of the benefit pool to adjust.
+     * ID of the pool associated with the balance to change. This is also the ID of the balance.
      * @format GUID
      */
     poolId: string;
@@ -286,54 +284,37 @@ export interface BalanceChangeBalanceRequest extends BalanceChangeBalanceRequest
      * @maxLength 200
      */
     idempotencyKey: string;
-    /**
-     * Party requesting the balance change.
-     *
-     * Possible values could include:
-     *
-     * + App owner.
-     *
-     * + Pool beneficiary.
-     *
-     * + Site admin.
-     */
+    /** Identity changing the balance. */
     instructingParty?: CommonIdentificationData;
-    /**
-     * Specify the type of operation to change the balance. Depending on the selected balance change type, you must use the corresponding `adjustOptions` or `setOptions` parameter.
-     *
-     * Use `ADJUST` to specify the number of credits to apply to the current balance of the benefit pool.
-     * For example, if there is a currently 10 credits, and you use `ADJUST` with an amount of 5, the resulting balance will be 15 credits (10+5) after the adjustment.
-     *
-     * Use `SET` to change the entire balance to a specified amount.
-     * For example, if you apply `SET` with an amount of 10 credits, the resulting balance will be 10 credits, regardless of the initial balance.
-     */
+    /** Balance change type. */
     type?: ChangeBalanceRequestType;
-    /** Transaction details associated with the balance change. */
+    /** Details to send to the transaction created from this balance change. */
     transactionDetails?: TransactionDetails;
 }
 /** @oneof */
 export interface BalanceChangeBalanceRequestOperationOneOf {
-    /** Set the amount of credits to adjust the balance to. */
+    /** Adjust the balance by a specific amount of credits. */
     adjustOptions?: AdjustOptions;
-    /** Sets the balance to a specific amount. */
+    /** Set the balance to a specific amount of credits. */
     setOptions?: SetOptions;
 }
 export declare enum ChangeBalanceRequestType {
-    /** Unknown type of balance operation. */
+    /** Unknown balance change type. */
     UNKNOWN_OPERATION = "UNKNOWN_OPERATION",
-    /** Adjust the current balance by a specific amount. */
+    /** Use with `adjustOptions`. */
     ADJUST = "ADJUST",
-    /** Set the balance to a specific amount. */
-    SET = "SET",
-    SET_INITIAL = "SET_INITIAL"
+    /** Use with `setOptions`. */
+    SET = "SET"
 }
 export interface AdjustOptions {
     /**
-     * Amount to adjust the available balance by. Supports positive and negative values.
+     * Amount to change the balance's available credits by.
+     * - To increase the balance, specify a positive number.
+     * - To decrease the balance, specify a negative number.
      * @decimalValue options { maxScale:4 }
      */
     value?: string;
-    /** Benefit pool owner associated with this balance. */
+    /** Beneficiary of the associated pool. */
     beneficiary?: CommonIdentificationData;
 }
 export declare enum LimitRule {
@@ -348,13 +329,13 @@ export declare enum LimitRule {
 }
 export interface SetOptions {
     /**
-     * Set the available balance to the provided amount.
+     * Amount to set the balance's available credits to.
      *
-     * If the value set to is equal to the current balance, no action or corresponding transaction occurs.
+     * If this is the same as the current value, no transaction is created.
      * @decimalValue options { maxScale:4 }
      */
     value?: string;
-    /** Benefit pool owner associated with this balance. */
+    /** Beneficiary of the associated pool. */
     beneficiary?: CommonIdentificationData;
 }
 export interface SetInitialOptions {
@@ -368,20 +349,19 @@ export interface SetInitialOptions {
 }
 export interface TransactionDetails {
     /**
-     * Item associated with the balance change.
-     * The redemption of this item triggered the balance adjustment.
+     * Item associated with the transaction.
      * @readonly
      */
     item?: Item;
-    /** Quantity of an item related to the balance change. */
+    /** Amount of items associated with the transaction. */
     itemCount?: number | null;
     /**
-     * Date and time the transaction was made.
+     * Date and time the transaction was created.
      * @readonly
      */
     effectiveDate?: Date | null;
     /**
-     * Reason for the transaction. For example, `Redemption` or `Manual adjustment`.
+     * Reason for the transaction. For example, `Redemption`.
      * @readonly
      * @maxLength 256
      */
@@ -395,34 +375,35 @@ export interface Item {
      */
     _id?: string | null;
     /**
-     * External item ID.
+     * Item external ID.
      * @format GUID
      * @readonly
      */
     externalId?: string | null;
     /**
-     * Item category. Distinguishes between different types of items. For example, `posts`, `groups`, `events`.
+     * Item category.
      * @maxLength 20
      * @readonly
      */
     category?: string | null;
     /**
+     * Item set ID.
      * @format GUID
      * @readonly
      */
     itemSetId?: string | null;
     /**
-     * Item display name.
+     * Item name.
      * @maxLength 64
      * @readonly
      */
     displayName?: string | null;
 }
 export interface ChangeBalanceResponse {
-    /** Changed balance. */
+    /** Updated balance. */
     balance?: Balance;
     /**
-     * ID of the transaction resulting from the balance adjustment.
+     * ID of the transaction associated with this change in balance.
      * @format GUID
      */
     transactionId?: string | null;
@@ -451,7 +432,7 @@ export interface BalanceExceededLimits {
 }
 export interface BulkChangeBalancesRequest {
     /**
-     * Requests
+     * List of balances to change.
      * @minSize 1
      * @maxSize 100
      */
@@ -461,43 +442,25 @@ export interface BulkChangeBalancesRequest {
      * Used to recognize repeated attempts to make the same request.
      * @maxLength 200
      */
-    idempotencyKey: string;
-    /** Whether to return the entity in the response */
+    idempotencyKey?: string;
+    /** Whether to return the full balance entities in the response. */
     returnEntity?: boolean;
 }
 export declare enum Type {
-    /** Unknown type of balance operation. */
+    /** Unknown balance change type. */
     UNKNOWN_OPERATION = "UNKNOWN_OPERATION"
 }
 export interface ChangeBalanceRequest extends ChangeBalanceRequestOperationOneOf {
     /**
-     * ID of the benefit pool to adjust.
+     * ID of the pool associated with the balance to change. This is also the ID of the balance.
      * @format GUID
      */
     poolId?: string;
-    /**
-     * Party requesting the balance change.
-     *
-     * Possible values could include:
-     *
-     * + App owner.
-     *
-     * + Pool beneficiary.
-     *
-     * + Site admin.
-     */
+    /** Identity changing the balance. */
     instructingParty?: CommonIdentificationData;
-    /**
-     * Specify the type of operation to change the balance. Depending on the selected balance change type, you must use the corresponding `adjustOptions` or `setOptions` parameter.
-     *
-     * Use `ADJUST` to specify the number of credits to apply to the current balance of the benefit pool.
-     * For example, if there is a currently 10 credits, and you use `ADJUST` with an amount of 5, the resulting balance will be 15 credits (10+5) after the adjustment.
-     *
-     * Use `SET` to change the entire balance to a specified amount.
-     * For example, if you apply `SET` with an amount of 10 credits, the resulting balance will be 10 credits, regardless of the initial balance.
-     */
+    /** Balance change type. */
     type?: Type;
-    /** Transaction details associated with the balance change. */
+    /** Details to send to the transaction created from this balance change. */
     transactionDetails?: TransactionDetails;
 }
 /** @oneof */
@@ -505,12 +468,12 @@ export interface ChangeBalanceRequestOperationOneOf {
 }
 export interface BulkChangeBalancesResponse {
     /**
-     * Results
+     * Updated item and associated metadata.
      * @minSize 1
      * @maxSize 100
      */
     results?: BulkChangeBalanceResult[];
-    /** Metadata for the bulk action */
+    /** Metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 export interface ItemMetadata {
@@ -535,9 +498,9 @@ export interface ApplicationError {
     data?: Record<string, any> | null;
 }
 export interface BulkChangeBalanceResult {
-    /** Metadata for the item */
+    /** Item metadata. */
     itemMetadata?: ItemMetadata;
-    /** Only exists if `returnEntity` was set to `true` in the request */
+    /** Updated item. */
     balance?: Balance;
 }
 export interface BulkActionMetadata {
@@ -550,7 +513,7 @@ export interface BulkActionMetadata {
 }
 export interface RevertBalanceChangeRequest {
     /**
-     * ID of the resulting transaction from the balance adjustment.
+     * ID of the transaction associated with the balance change to revert.
      * @format GUID
      */
     transactionId: string;
@@ -560,22 +523,12 @@ export interface RevertBalanceChangeRequest {
      * @maxLength 200
      */
     idempotencyKey: string;
-    /**
-     * Party requesting the balance change.
-     *
-     * Possible values could include:
-     *
-     * + App owner.
-     *
-     * + Pool beneficiary.
-     *
-     * + Site admin.
-     */
+    /** Identity reverting the balance change. */
     instructingParty?: CommonIdentificationData;
 }
 export interface RevertBalanceChangeResponse {
     /**
-     * ID of the resulting transaction from the balance adjustment.
+     * ID of the transaction associated with the balance reversion.
      * @format GUID
      */
     transactionId?: string | null;
@@ -790,31 +743,9 @@ export interface QueryBalancesResponseNonNullableFields {
 export interface ChangeBalanceResponseNonNullableFields {
     balance?: BalanceNonNullableFields;
 }
-interface ApplicationErrorNonNullableFields {
-    code: string;
-    description: string;
-}
-interface ItemMetadataNonNullableFields {
-    originalIndex: number;
-    success: boolean;
-    error?: ApplicationErrorNonNullableFields;
-}
-interface BulkChangeBalanceResultNonNullableFields {
-    itemMetadata?: ItemMetadataNonNullableFields;
-    balance?: BalanceNonNullableFields;
-}
-interface BulkActionMetadataNonNullableFields {
-    totalSuccesses: number;
-    totalFailures: number;
-    undetailedFailures: number;
-}
-export interface BulkChangeBalancesResponseNonNullableFields {
-    results: BulkChangeBalanceResultNonNullableFields[];
-    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
-}
 /**
- * Retrieves a benefit pool balance.
- * @param poolId - ID of the pool from which to retrieve the balance.
+ * 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
@@ -831,7 +762,7 @@ export interface BulkChangeBalancesResponseNonNullableFields {
  */
 export declare function getBalance(poolId: string): Promise<Balance & BalanceNonNullableFields>;
 /**
- * Retrieves a list of benefit pool balances.
+ * Retrieves a list of balances.
  * @public
  * @documentationMaturity preview
  * @permissionId BENEFIT_PROGRAMS.BALANCE_READ
@@ -847,24 +778,26 @@ export declare function getBalance(poolId: string): Promise<Balance & BalanceNon
 export declare function listBalances(options?: ListBalancesOptions): Promise<ListBalancesResponse & ListBalancesResponseNonNullableFields>;
 export interface ListBalancesOptions {
     /**
-     * IDs of the pools from which to receive the balances.
+     * List of IDs of the pools associated with the balances to retrieve. These are also the IDs of the balances.
      * @format GUID
      * @maxSize 100
      */
     poolIds?: string[];
-    /** Cursor paging */
+    /** Cursor paging. */
     cursorPaging?: CursorPaging;
 }
 /**
  * Creates a query to retrieve a list of balances.
  *
- * The `queryBalances()` method builds a query to retrieve a list of balances and returns a `BalancesQueryBuilder` object.
+ * 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.
  *
- * The returned object contains the query definition, which is used to run the query using the [`find()`](/balances/balances-query-builder/find) function.
+ * 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.
  *
- * You can refine the query by chaining `BalancesQueryBuilder` methods onto the query. `BalancesQueryBuilder` methods enable you to filter, sort, and control the results that `queryBalances()` returns.
+ * Query Balances has a default paging limit of 50, which you can override.
  *
- * The following `BalancesQueryBuilder` functions are supported for `queryBalances()`. For a full description of the item object, see the object returned for the [`items`](/balances/balances-query-result/balances) property in `BalancesQueryResult`.
+ *  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
@@ -956,11 +889,10 @@ export interface BalancesQueryBuilder {
     find: () => Promise<BalancesQueryResult>;
 }
 /**
- * Adjust the balance of a benefit pool.
+ * Changes the amount of available credits in a balance.
  *
- * Make manual, one-time adjustments to a beneficiary's balance, granting additional credits directly into the beneficiary's account,
- * for example, credit awards or gifts.
- * @param poolId - ID of the benefit pool to adjust.
+ * You can adjust or set the amount 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
@@ -976,80 +908,32 @@ export interface BalancesQueryBuilder {
  */
 export declare function changeBalance(poolId: string, idempotencyKey: string, options?: ChangeBalanceOptions): Promise<ChangeBalanceResponse & ChangeBalanceResponseNonNullableFields>;
 export interface ChangeBalanceOptions extends ChangeBalanceOptionsOperationOneOf {
-    /**
-     * Party requesting the balance change.
-     *
-     * Possible values could include:
-     *
-     * + App owner.
-     *
-     * + Pool beneficiary.
-     *
-     * + Site admin.
-     */
+    /** Identity changing the balance. */
     instructingParty?: CommonIdentificationData;
-    /**
-     * Specify the type of operation to change the balance. Depending on the selected balance change type, you must use the corresponding `adjustOptions` or `setOptions` parameter.
-     *
-     * Use `ADJUST` to specify the number of credits to apply to the current balance of the benefit pool.
-     * For example, if there is a currently 10 credits, and you use `ADJUST` with an amount of 5, the resulting balance will be 15 credits (10+5) after the adjustment.
-     *
-     * Use `SET` to change the entire balance to a specified amount.
-     * For example, if you apply `SET` with an amount of 10 credits, the resulting balance will be 10 credits, regardless of the initial balance.
-     */
+    /** Balance change type. */
     type?: ChangeBalanceRequestType;
-    /** Set the amount of credits to adjust the balance to. */
+    /** Adjust the balance by a specific amount of credits. */
     adjustOptions?: AdjustOptions;
-    /** Sets the balance to a specific amount. */
+    /** Set the balance to a specific amount of credits. */
     setOptions?: SetOptions;
-    /** Transaction details associated with the balance change. */
+    /** Details to send to the transaction created from this balance change. */
     transactionDetails?: TransactionDetails;
 }
 /** @oneof */
 export interface ChangeBalanceOptionsOperationOneOf {
-    /** Set the amount of credits to adjust the balance to. */
+    /** Adjust the balance by a specific amount of credits. */
     adjustOptions?: AdjustOptions;
-    /** Sets the balance to a specific amount. */
+    /** Set the balance to a specific amount of credits. */
     setOptions?: SetOptions;
 }
 /**
- * Adjust the balance of benefit pools.
+ * Undoes a transaction created by calling Change Balance.
  *
- * Make manual, one-time adjustments to a beneficiary's balance, granting additional credits directly into the beneficiary's account,
- * for example, credit awards or gifts.
- * @public
- * @documentationMaturity preview
- * @requiredField options.idempotencyKey
- * @requiredField options.requests.operation
- * @requiredField options.requests.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.BulkChangeBalances
- */
-export declare function bulkChangeBalances(options?: BulkChangeBalancesOptions): Promise<BulkChangeBalancesResponse & BulkChangeBalancesResponseNonNullableFields>;
-export interface BulkChangeBalancesOptions {
-    /**
-     * Requests
-     * @minSize 1
-     * @maxSize 100
-     */
-    requests?: ChangeBalanceRequest[];
-    /**
-     * Unique identifier, generated by the client.
-     * Used to recognize repeated attempts to make the same request.
-     * @maxLength 200
-     */
-    idempotencyKey: string;
-    /** Whether to return the entity in the response */
-    returnEntity?: boolean;
-}
-/**
- * Restores a previously changed 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.
  *
- * Reverts a balance change that was made by a previous Change Balance call, restoring the balance to its state before the adjustment.
- * @param transactionId - ID of the resulting transaction from the balance adjustment.
+ * > **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
@@ -1064,17 +948,7 @@ export interface BulkChangeBalancesOptions {
  */
 export declare function revertBalanceChange(transactionId: string, idempotencyKey: string, options?: RevertBalanceChangeOptions): Promise<RevertBalanceChangeResponse>;
 export interface RevertBalanceChangeOptions {
-    /**
-     * Party requesting the balance change.
-     *
-     * Possible values could include:
-     *
-     * + App owner.
-     *
-     * + Pool beneficiary.
-     *
-     * + Site admin.
-     */
+    /** Identity reverting the balance change. */
     instructingParty?: CommonIdentificationData;
 }
 export {};