@wix/auto_sdk_benefit-programs_balances 1.0.8 → 1.0.9

package/build/meta.d.mts

@@ -0,0 +1,431 @@
+import { G as GetBalanceRequest$1, k as GetBalanceResponse$1, l as ListBalancesRequest$1, a as ListBalancesResponse$1, Q as QueryBalancesRequest$1, s as QueryBalancesResponse$1, t as BalanceChangeBalanceRequest$1, c as ChangeBalanceResponse$1, U as RevertBalanceChangeRequest$1, d as RevertBalanceChangeResponse$1 } from './benefit-programs-v1-balance-balances.universal-qcbBfXdg.mjs';
+
+interface Balance {
+    /**
+     * Balance ID. This is the same as the associated pool's ID.
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    id?: string;
+    /**
+     * Revision number, which increments by 1 each time the balance is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the balance.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the balance was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the balance was updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Beneficiary of the associated pool.
+     * @readonly
+     * @immutable
+     */
+    beneficiary?: CommonIdentificationData;
+    /**
+     * Available credits.
+     * @readonly
+     */
+    amount?: BalanceAmount;
+    /**
+     * Associated pool information.
+     * @readonly
+     */
+    poolInfo?: PoolInfo;
+    /**
+     * Custom field data for the balance object.
+     * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
+     */
+    extendedFields?: ExtendedFields;
+    /**
+     * ID of the transaction associated with the most recent change to the balance.
+     * @format GUID
+     * @readonly
+     */
+    lastTransactionId?: string | null;
+}
+interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that hasn't logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site member.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user.
+     * @format GUID
+     */
+    wixUserId?: string;
+}
+/** @oneof */
+interface CommonIdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that hasn't logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site member.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user.
+     * @format GUID
+     */
+    wixUserId?: string;
+}
+interface BalanceAmount {
+    /**
+     * number of available credits.
+     * @decimalValue options { maxScale:4 }
+     * @readonly
+     */
+    available?: string;
+}
+interface PoolInfo {
+    /**
+     * Pool ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string;
+    /**
+     * ID of the pool definition the pool was created from.
+     * @format GUID
+     * @readonly
+     */
+    poolDefinitionId?: string | null;
+    /**
+     * ID of the program definition the pool was created from.
+     * @format GUID
+     * @readonly
+     */
+    programDefinitionId?: string | null;
+    /**
+     * ID of the program that contains the pool.
+     * @format GUID
+     * @readonly
+     */
+    programId?: string | null;
+    /**
+     * Available credits.
+     * @decimalValue options { gte:0, maxScale:4 }
+     */
+    creditAmount?: string | null;
+    /**
+     * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
+     * @minLength 1
+     * @maxLength 50
+     */
+    namespace?: string | null;
+}
+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.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+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 {
+    /** Retrieved balance. */
+    balance?: Balance;
+}
+interface ListBalancesRequest {
+    /**
+     * 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. */
+    cursorPaging?: CursorPaging;
+}
+interface CursorPaging {
+    /**
+     * Maximum number of items to return.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface ListBalancesResponse {
+    /**
+     * Retrieved balances.
+     * @maxSize 100
+     */
+    balances?: Balance[];
+    /** Metadata for paginated results. */
+    metadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface QueryBalancesRequest {
+    /** Filter, sort, and paging to apply to the query. */
+    query?: CursorQuery;
+}
+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;
+    /**
+     * Filter object.
+     * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
+     * for more information.
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * List of sort objects.
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+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 {
+    /**
+     * Field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /**
+     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `ASC`
+     */
+    order?: SortOrder;
+}
+declare enum SortOrder {
+    /** Ascending sort order. */
+    ASC = "ASC",
+    /** Descending sort order. */
+    DESC = "DESC"
+}
+interface QueryBalancesResponse {
+    /** List of retrieved balances. */
+    balances?: Balance[];
+    /** Metadata for the paginated results. */
+    metadata?: CursorPagingMetadata;
+}
+interface BalanceChangeBalanceRequest extends BalanceChangeBalanceRequestOperationOneOf {
+    /** Adjust the balance by a specific number of credits. */
+    adjustOptions?: AdjustOptions;
+    /** Set the balance to a specific number of credits. */
+    setOptions?: SetOptions;
+    /**
+     * ID of the pool associated with the balance to change. This is also the ID of the balance.
+     * @format GUID
+     */
+    poolId: string;
+    /**
+     * Unique identifier, generated by the client.
+     * Used to recognize repeated attempts to make the same request.
+     * @maxLength 200
+     */
+    idempotencyKey: string;
+    /** Identity changing the balance. */
+    instructingParty?: CommonIdentificationData;
+    /** Balance change type. */
+    type?: ChangeBalanceRequestType;
+    /** Details to send to the transaction created from this balance change. */
+    transactionDetails?: TransactionDetails;
+}
+/** @oneof */
+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 {
+    /** Unknown balance change type. */
+    UNKNOWN_OPERATION = "UNKNOWN_OPERATION",
+    /** Use with `adjustOptions`. */
+    ADJUST = "ADJUST",
+    /** Use with `setOptions`. */
+    SET = "SET"
+}
+interface AdjustOptions {
+    /**
+     * 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;
+    /** Beneficiary of the associated pool. */
+    beneficiary?: CommonIdentificationData;
+}
+interface SetOptions {
+    /**
+     * Amount to set the balance's available credits to.
+     *
+     * If this is the same as the current value, no transaction is created.
+     * @decimalValue options { maxScale:4 }
+     */
+    value?: string;
+    /** Beneficiary of the associated pool. */
+    beneficiary?: CommonIdentificationData;
+}
+interface TransactionDetails {
+    /**
+     * Item associated with the transaction.
+     * @readonly
+     */
+    item?: Item;
+    /** Amount of items associated with the transaction. */
+    itemCount?: number | null;
+    /**
+     * Date and time the transaction was created.
+     * @readonly
+     */
+    effectiveDate?: Date | null;
+    /**
+     * Reason for the transaction. For example, `Redemption`.
+     * @readonly
+     * @maxLength 256
+     */
+    reason?: string | null;
+}
+interface Item {
+    /**
+     * Item ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Item external ID.
+     * @format GUID
+     * @readonly
+     */
+    externalId?: string | null;
+    /**
+     * Item category.
+     * @maxLength 20
+     * @readonly
+     */
+    category?: string | null;
+    /**
+     * Item set ID.
+     * @format GUID
+     * @readonly
+     */
+    itemSetId?: string | null;
+    /**
+     * Item name.
+     * @maxLength 64
+     * @readonly
+     */
+    displayName?: string | null;
+}
+interface ChangeBalanceResponse {
+    /** Updated balance. */
+    balance?: Balance;
+    /**
+     * ID of the transaction associated with this change in balance.
+     * @format GUID
+     */
+    transactionId?: string | null;
+}
+interface RevertBalanceChangeRequest {
+    /**
+     * ID of the transaction associated with the balance change to revert.
+     * @format GUID
+     */
+    transactionId: string;
+    /**
+     * Unique identifier, generated by the client.
+     * Used to recognize repeated attempts to make the same request.
+     * @maxLength 200
+     */
+    idempotencyKey: string;
+    /** Identity reverting the balance change. */
+    instructingParty?: CommonIdentificationData;
+}
+interface RevertBalanceChangeResponse {
+    /**
+     * ID of the transaction associated with the balance reversion.
+     * @format GUID
+     */
+    transactionId?: string | null;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function getBalance(): __PublicMethodMetaInfo<'GET', {
+    poolId: string;
+}, GetBalanceRequest$1, GetBalanceRequest, GetBalanceResponse$1, GetBalanceResponse>;
+declare function listBalances(): __PublicMethodMetaInfo<'GET', {}, ListBalancesRequest$1, ListBalancesRequest, ListBalancesResponse$1, ListBalancesResponse>;
+declare function queryBalances(): __PublicMethodMetaInfo<'POST', {}, QueryBalancesRequest$1, QueryBalancesRequest, QueryBalancesResponse$1, QueryBalancesResponse>;
+declare function changeBalance(): __PublicMethodMetaInfo<'POST', {
+    poolId: string;
+}, BalanceChangeBalanceRequest$1, BalanceChangeBalanceRequest, ChangeBalanceResponse$1, ChangeBalanceResponse>;
+declare function revertBalanceChange(): __PublicMethodMetaInfo<'POST', {
+    transactionId: string;
+}, RevertBalanceChangeRequest$1, RevertBalanceChangeRequest, RevertBalanceChangeResponse$1, RevertBalanceChangeResponse>;
+
+export { type __PublicMethodMetaInfo, changeBalance, getBalance, listBalances, queryBalances, revertBalanceChange };