@revenuecat/purchases-js 1.12.1 → 1.13.0

package/dist/Purchases.es.d.ts

@@ -978,6 +978,29 @@ export declare class Purchases {
              * @returns Whether the current user is anonymous.
              */
             isAnonymous(): boolean;
+            /**
+             * Fetches the virtual currencies for the current subscriber.
+             *
+             * @returns {Promise<VirtualCurrencies>} A VirtualCurrencies object containing the subscriber's virtual currencies.
+             */
+            getVirtualCurrencies(): Promise<VirtualCurrencies>;
+            /**
+             * The currently cached {@link VirtualCurrencies} if one is available.
+             * This value will remain null until virtual currencies have been fetched at
+             * least once with {@link Purchases.getVirtualCurrencies} or an equivalent function.
+             *
+             * @returns {VirtualCurrencies | null} A {@link VirtualCurrencies} object containing the subscriber's virtual currencies,
+             * or null if no cached data is available.
+             */
+            getCachedVirtualCurrencies(): VirtualCurrencies | null;
+            /**
+             * Invalidates the cache for virtual currencies.
+             *
+             * This is useful for cases where a virtual currency's balance might have been updated
+             * in a different part of your system, like if you decreased a user's balance from the user spending a virtual currency,
+             * or if you increased the balance from your backend using the server APIs.
+             */
+            invalidateVirtualCurrenciesCache(): void;
             /**
              * Closes the Purchases instance. You should never have to do this normally.
              */
@@ -1449,4 +1472,43 @@ export declare class Purchases {
                constructor();
            }
 
+           /**
+            * The VirtualCurrencies object contains all the virtual currencies associated to the user.
+            *
+            * @public
+            */
+           export declare interface VirtualCurrencies {
+               /**
+                * Map of all {@link VirtualCurrency} objects keyed by virtual currency code.
+                */
+               readonly all: {
+                   [key: string]: VirtualCurrency;
+               };
+           }
+
+           /**
+            * The VirtualCurrency object represents information about a virtual currency in the app.
+            * Use this object to access information about a virtual currency, such as its current balance.
+            *
+            * @public
+            */
+           export declare interface VirtualCurrency {
+               /**
+                * The virtual currency's balance.
+                */
+               readonly balance: number;
+               /**
+                * The virtual currency's name.
+                */
+               readonly name: string;
+               /**
+                * The virtual currency's code.
+                */
+               readonly code: string;
+               /**
+                * The virtual currency's description defined in the RevenueCat dashboard.
+                */
+               readonly serverDescription: string | null;
+           }
+
            export { }