@revenuecat/purchases-js 1.53.1 → 1.55.0

package/dist/Purchases.es.d.ts

@@ -134,6 +134,20 @@ export declare interface CustomerInfo {
     };
 }
 
+/**
+ * Parameters for tracking an impression of a custom paywall.
+ *
+ * Pass the offering used to render the paywall to include its offering,
+ * placement, and targeting attribution in the event.
+ * @public
+ */
+export declare interface CustomPaywallImpressionParams {
+    /** An optional identifier for the custom paywall shown to the customer. */
+    paywallId?: string;
+    /** The offering used to render the custom paywall. */
+    offering?: Offering;
+}
+
 /**
  * Custom translations to be used in the purchase flow.
  * This class allows you to override the default translations used in the purchase flow.
@@ -539,6 +553,8 @@ declare enum LocalizationKeys {
     PlanCardNew = "plan_card.new",
     RefundForUnusedTimeTitle = "refund_for_unused_time.title",
     RefundForUnusedTimeMessage = "refund_for_unused_time.message",
+    CreditForUnusedTimeTitle = "credit_for_unused_time.title",
+    CreditForUnusedTimeMessage = "credit_for_unused_time.message",
     UpgradeConfirmPageTitle = "upgrade_confirm_page.title",
     UpgradeConfirmPageSubtitleImmediate = "upgrade_confirm_page.subtitle_immediate",
     UpgradeConfirmPageSubtitleDeferred = "upgrade_confirm_page.subtitle_deferred",
@@ -1424,7 +1440,9 @@ export declare interface PurchaseParams {
     showDiscountCodeField?: boolean;
     /**
      * @experimental
-     * Initial discount code to display as applied in the Web Billing checkout.
+     * Initial discount code to apply at checkout.
+     * For Web Billing this is displayed as applied in the checkout UI.
+     * For Paddle this is passed to Paddle Checkout as `discountCode`.
      * This is useful when the code originated outside of the checkout UI,
      * for example from a URL parameter.
      */
@@ -1501,6 +1519,7 @@ export declare class Purchases {
     /* Excluded from this release type: eventsTracker */
     /* Excluded from this release type: _platformInfo */
     /* Excluded from this release type: inMemoryCache */
+    /* Excluded from this release type: cachedCurrentOffering */
     /* Excluded from this release type: instance */
     /**
      * Set the log level. Logs of the given level and below will be printed
@@ -1576,6 +1595,20 @@ export declare class Purchases {
         * @param params - The parameters object to customise the offerings fetch. Check {@link GetOfferingsParams}
         */
        getOfferings(params?: GetOfferingsParams): Promise<Offerings>;
+       /**
+        * Tracks an impression for a custom paywall.
+        *
+        * Pass the offering used to render the paywall to preserve placement and
+        * targeting attribution. When no offering is passed, the most recently
+        * fetched current offering is used if available.
+        *
+        * Each call creates a separate impression event. Call this once per
+        * paywall presentation and avoid lifecycle callbacks that may run
+        * multiple times for the same display.
+        *
+        * @param params Parameters for the custom paywall impression event.
+        */
+       trackCustomPaywallImpression(params?: CustomPaywallImpressionParams): void;
        /**
         * Retrieves a specific offering by a placement identifier.
         * For more info see https://www.revenuecat.com/docs/tools/targeting
@@ -2079,7 +2112,12 @@ export declare class Purchases {
                 /**
                  * The Tenjin ID of the customer.
                  */
-                TenjinId = "$tenjinId"
+                TenjinId = "$tenjinId",
+                /**
+                 * The Singular Device ID (SDID) of the customer, generated by the Singular SDK.
+                 * Required by Singular's Event Endpoint V2.
+                 */
+                SingularDeviceId = "$singularDeviceId"
             }
 
             declare type SDKEventContextSource = "sdk" | "wpl" | string;