@wix/auto_sdk_benefit-programs_balances 1.0.7 → 1.0.9

package/build/index.d.mts

@@ -0,0 +1,72 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { B as Balance, L as ListBalancesOptions, a as ListBalancesResponse, b as BalancesQueryBuilder, C as ChangeBalanceOptions, c as ChangeBalanceResponse, R as RevertBalanceChangeOptions, d as RevertBalanceChangeResponse } from './benefit-programs-v1-balance-balances.universal-qcbBfXdg.mjs';
+export { a4 as ActionEvent, A as AdjustOptions, M as ApplicationError, j as BalanceAmount, t as BalanceChangeBalanceRequest, u as BalanceChangeBalanceRequestOperationOneOf, z as BalanceExceededLimits, a8 as BalancesQueryResult, O as BulkActionMetadata, N as BulkChangeBalanceResult, D as BulkChangeBalancesRequest, J as BulkChangeBalancesResponse, V as ChangeAlreadyReverted, a9 as ChangeBalanceOptionsOperationOneOf, F as ChangeBalanceRequest, H as ChangeBalanceRequestOperationOneOf, e as ChangeBalanceRequestType, h as CommonIdentificationData, i as CommonIdentificationDataIdOneOf, m as CursorPaging, n as CursorPagingMetadata, p as CursorQuery, q as CursorQueryPagingMethodOneOf, o as Cursors, _ as DomainEvent, $ as DomainEventBodyOneOf, a0 as EntityCreatedEvent, a3 as EntityDeletedEvent, a2 as EntityUpdatedEvent, E as ExtendedFields, G as GetBalanceRequest, k as GetBalanceResponse, Y as GetTransactionReversibilityRequest, Z as GetTransactionReversibilityResponse, a6 as IdentificationData, a7 as IdentificationDataIdOneOf, I as IdentityType, y as Item, K as ItemMetadata, f as LimitRule, l as ListBalancesRequest, a5 as MessageEnvelope, X as NotEnoughBalance, P as PoolInfo, Q as QueryBalancesRequest, s as QueryBalancesResponse, a1 as RestoreInfo, U as RevertBalanceChangeRequest, w as SetInitialOptions, v as SetOptions, S as SortOrder, r as Sorting, x as TransactionDetails, g as TransactionReversibility, T as Type, W as WebhookIdentityType } from './benefit-programs-v1-balance-balances.universal-qcbBfXdg.mjs';
+
+declare function getBalance$1(httpClient: HttpClient): GetBalanceSignature;
+interface GetBalanceSignature {
+    /**
+     * Retrieves a balance.
+     * @param - ID of the pool associated with the balance to retrieve. This is also the ID of the balance.
+     * @returns Retrieved balance.
+     */
+    (poolId: string): Promise<Balance>;
+}
+declare function listBalances$1(httpClient: HttpClient): ListBalancesSignature;
+interface ListBalancesSignature {
+    /**
+     * Retrieves a list of balances.
+     */
+    (options?: ListBalancesOptions | undefined): Promise<ListBalancesResponse>;
+}
+declare function queryBalances$1(httpClient: HttpClient): QueryBalancesSignature;
+interface QueryBalancesSignature {
+    /**
+     * 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`.
+     */
+    (): BalancesQueryBuilder;
+}
+declare function changeBalance$1(httpClient: HttpClient): ChangeBalanceSignature;
+interface ChangeBalanceSignature {
+    /**
+     * Changes the number of available credits in a balance.
+     *
+     * You can adjust or set the number of available credits.
+     * @param - ID of the pool associated with the balance to change. This is also the ID of the balance.
+     * @param - Unique identifier, generated by the client.
+     * Used to recognize repeated attempts to make the same request.
+     */
+    (poolId: string, idempotencyKey: string, options?: ChangeBalanceOptions | undefined): Promise<ChangeBalanceResponse>;
+}
+declare function revertBalanceChange$1(httpClient: HttpClient): RevertBalanceChangeSignature;
+interface RevertBalanceChangeSignature {
+    /**
+     * 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 - ID of the transaction associated with the balance change to revert.
+     * @param - Unique identifier, generated by the client.
+     * Used to recognize repeated attempts to make the same request.
+     */
+    (transactionId: string, idempotencyKey: string, options?: RevertBalanceChangeOptions | undefined): Promise<RevertBalanceChangeResponse>;
+}
+
+declare const getBalance: MaybeContext<BuildRESTFunction<typeof getBalance$1> & typeof getBalance$1>;
+declare const listBalances: MaybeContext<BuildRESTFunction<typeof listBalances$1> & typeof listBalances$1>;
+declare const queryBalances: MaybeContext<BuildRESTFunction<typeof queryBalances$1> & typeof queryBalances$1>;
+declare const changeBalance: MaybeContext<BuildRESTFunction<typeof changeBalance$1> & typeof changeBalance$1>;
+declare const revertBalanceChange: MaybeContext<BuildRESTFunction<typeof revertBalanceChange$1> & typeof revertBalanceChange$1>;
+
+export { Balance, BalancesQueryBuilder, ChangeBalanceOptions, ChangeBalanceResponse, ListBalancesOptions, ListBalancesResponse, RevertBalanceChangeOptions, RevertBalanceChangeResponse, changeBalance, getBalance, listBalances, queryBalances, revertBalanceChange };

package/build/index.d.ts

@@ -0,0 +1,72 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { B as Balance, L as ListBalancesOptions, a as ListBalancesResponse, b as BalancesQueryBuilder, C as ChangeBalanceOptions, c as ChangeBalanceResponse, R as RevertBalanceChangeOptions, d as RevertBalanceChangeResponse } from './benefit-programs-v1-balance-balances.universal-qcbBfXdg.js';
+export { a4 as ActionEvent, A as AdjustOptions, M as ApplicationError, j as BalanceAmount, t as BalanceChangeBalanceRequest, u as BalanceChangeBalanceRequestOperationOneOf, z as BalanceExceededLimits, a8 as BalancesQueryResult, O as BulkActionMetadata, N as BulkChangeBalanceResult, D as BulkChangeBalancesRequest, J as BulkChangeBalancesResponse, V as ChangeAlreadyReverted, a9 as ChangeBalanceOptionsOperationOneOf, F as ChangeBalanceRequest, H as ChangeBalanceRequestOperationOneOf, e as ChangeBalanceRequestType, h as CommonIdentificationData, i as CommonIdentificationDataIdOneOf, m as CursorPaging, n as CursorPagingMetadata, p as CursorQuery, q as CursorQueryPagingMethodOneOf, o as Cursors, _ as DomainEvent, $ as DomainEventBodyOneOf, a0 as EntityCreatedEvent, a3 as EntityDeletedEvent, a2 as EntityUpdatedEvent, E as ExtendedFields, G as GetBalanceRequest, k as GetBalanceResponse, Y as GetTransactionReversibilityRequest, Z as GetTransactionReversibilityResponse, a6 as IdentificationData, a7 as IdentificationDataIdOneOf, I as IdentityType, y as Item, K as ItemMetadata, f as LimitRule, l as ListBalancesRequest, a5 as MessageEnvelope, X as NotEnoughBalance, P as PoolInfo, Q as QueryBalancesRequest, s as QueryBalancesResponse, a1 as RestoreInfo, U as RevertBalanceChangeRequest, w as SetInitialOptions, v as SetOptions, S as SortOrder, r as Sorting, x as TransactionDetails, g as TransactionReversibility, T as Type, W as WebhookIdentityType } from './benefit-programs-v1-balance-balances.universal-qcbBfXdg.js';
+
+declare function getBalance$1(httpClient: HttpClient): GetBalanceSignature;
+interface GetBalanceSignature {
+    /**
+     * Retrieves a balance.
+     * @param - ID of the pool associated with the balance to retrieve. This is also the ID of the balance.
+     * @returns Retrieved balance.
+     */
+    (poolId: string): Promise<Balance>;
+}
+declare function listBalances$1(httpClient: HttpClient): ListBalancesSignature;
+interface ListBalancesSignature {
+    /**
+     * Retrieves a list of balances.
+     */
+    (options?: ListBalancesOptions | undefined): Promise<ListBalancesResponse>;
+}
+declare function queryBalances$1(httpClient: HttpClient): QueryBalancesSignature;
+interface QueryBalancesSignature {
+    /**
+     * 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`.
+     */
+    (): BalancesQueryBuilder;
+}
+declare function changeBalance$1(httpClient: HttpClient): ChangeBalanceSignature;
+interface ChangeBalanceSignature {
+    /**
+     * Changes the number of available credits in a balance.
+     *
+     * You can adjust or set the number of available credits.
+     * @param - ID of the pool associated with the balance to change. This is also the ID of the balance.
+     * @param - Unique identifier, generated by the client.
+     * Used to recognize repeated attempts to make the same request.
+     */
+    (poolId: string, idempotencyKey: string, options?: ChangeBalanceOptions | undefined): Promise<ChangeBalanceResponse>;
+}
+declare function revertBalanceChange$1(httpClient: HttpClient): RevertBalanceChangeSignature;
+interface RevertBalanceChangeSignature {
+    /**
+     * 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 - ID of the transaction associated with the balance change to revert.
+     * @param - Unique identifier, generated by the client.
+     * Used to recognize repeated attempts to make the same request.
+     */
+    (transactionId: string, idempotencyKey: string, options?: RevertBalanceChangeOptions | undefined): Promise<RevertBalanceChangeResponse>;
+}
+
+declare const getBalance: MaybeContext<BuildRESTFunction<typeof getBalance$1> & typeof getBalance$1>;
+declare const listBalances: MaybeContext<BuildRESTFunction<typeof listBalances$1> & typeof listBalances$1>;
+declare const queryBalances: MaybeContext<BuildRESTFunction<typeof queryBalances$1> & typeof queryBalances$1>;
+declare const changeBalance: MaybeContext<BuildRESTFunction<typeof changeBalance$1> & typeof changeBalance$1>;
+declare const revertBalanceChange: MaybeContext<BuildRESTFunction<typeof revertBalanceChange$1> & typeof revertBalanceChange$1>;
+
+export { Balance, BalancesQueryBuilder, ChangeBalanceOptions, ChangeBalanceResponse, ListBalancesOptions, ListBalancesResponse, RevertBalanceChangeOptions, RevertBalanceChangeResponse, changeBalance, getBalance, listBalances, queryBalances, revertBalanceChange };