@revenuecat/purchases-js 0.5.0 → 0.7.0

package/dist/Purchases.es.d.ts

@@ -170,6 +170,18 @@ export declare enum ErrorCode {
     InvalidEmailError = 38
 }
 
+/**
+ * Parameters for the {@link Purchases.getOfferings} method.
+ * @public
+ */
+export declare interface GetOfferingsParams {
+    /**
+     * The currency code in ISO 4217 to fetch the offerings for.
+     * If not specified, the default currency will be used.
+     */
+    readonly currency?: string;
+}
+
 /**
  * Parameters used to customise the http requests executed by purchases-js.
  * @public
@@ -415,9 +427,14 @@ export declare interface PresentedOfferingContext {
  */
 export declare interface Price {
     /**
-     * Price in full units of the currency.
+     * Price in cents of the currency.
+     * @deprecated - Use {@link Price.amountMicros} instead.
      */
     readonly amount: number;
+    /**
+     * Price in micro-units of the currency. For example, $9.99 is represented as 9990000.
+     */
+    readonly amountMicros: number;
     /**
      * Returns ISO 4217 currency code for price.
      * For example, if price is specified in British pounds sterling,
@@ -497,6 +514,10 @@ export declare interface Product {
      * The context from which this product was obtained.
      */
     readonly presentedOfferingContext: PresentedOfferingContext;
+    /**
+     * The default purchase option for this product.
+     */
+    readonly defaultPurchaseOption: PurchaseOption;
     /**
      * The default subscription option for this product. Null if no subscription
      * options are available like in the case of consumables and non-consumables.
@@ -523,6 +544,10 @@ export declare interface PurchaseOption {
      * The unique id for a purchase option
      */
     readonly id: string;
+    /**
+     * The public price id for this subscription option.
+     */
+    readonly priceId: string;
 }
 
 /**
@@ -582,11 +607,19 @@ export declare class Purchases {
       * @throws {@link PurchasesError} if the API key or user id are invalid.
           */
       static configure(apiKey: string, appUserId: string, httpConfig?: HttpConfig): Purchases;
+      /**
+       * Loads and caches some optional data in the Purchases SDK.
+       * Currently only fetching branding information. You can call this method
+       * after configuring the SDK to speed up the first call to
+       * {@link Purchases.purchase}.
+       */
+      preload(): Promise<void>;
+      private hasLoadedResources;
       /**
        * Fetch the configured offerings for this user. You can configure these
        * in the RevenueCat dashboard.
        */
-      getOfferings(): Promise<Offerings>;
+      getOfferings(params?: GetOfferingsParams): Promise<Offerings>;
       /**
        * Convenience method to check whether a user is entitled to a specific
        * entitlement. This will use {@link Purchases.getCustomerInfo} under the hood.