@revenuecat/purchases-js 0.4.0 → 0.6.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
@@ -394,6 +406,21 @@ export declare enum PeriodUnit {
     Day = "day"
 }
 
+/**
+ * Contains data about the context in which an offering was presented.
+ * @public
+ */
+export declare interface PresentedOfferingContext {
+    /**
+     * The identifier of the offering used to obtain this object.
+     */
+    readonly offeringIdentifier: string;
+    /**
+     * The targeting context used to obtain this object.
+     */
+    readonly targetingContext: TargetingContext | null;
+}
+
 /**
  * Price information for a product.
  * @public
@@ -475,8 +502,17 @@ export declare interface Product {
     readonly normalPeriodDuration: string | null;
     /**
      * The offering ID used to obtain this product.
+     * @deprecated - Use {@link Product.presentedOfferingContext} instead.
      */
     readonly presentedOfferingIdentifier: string;
+    /**
+     * 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.
@@ -503,6 +539,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;
 }
 
 /**
@@ -566,7 +606,7 @@ export declare class Purchases {
        * 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.
@@ -686,6 +726,21 @@ export declare class Purchases {
              readonly trial: PricingPhase | null;
          }
 
+         /**
+          * Contains information about the targeting context used to obtain an object.
+          * @public
+          */
+         export declare interface TargetingContext {
+             /**
+              * The rule id from the targeting used to obtain this object.
+              */
+             readonly ruleId: string;
+             /**
+              * The revision of the targeting used to obtain this object.
+              */
+             readonly revision: number;
+         }
+
          /**
           * Error indicating that the SDK was accessed before it was initialized.
           * @public