@revenuecat/purchases-js 0.16.0 → 0.17.0

package/dist/Purchases.es.d.ts

@@ -172,6 +172,18 @@ export declare enum ErrorCode {
     InvalidEmailError = 38
 }
 
+/**
+ * Flags used to enable or disable certain features in the sdk.
+ * @public
+ */
+export declare interface FlagsConfig {
+    /**
+     * If set to true, the SDK will automatically collect UTM parameters and store them as at the time of purchase.
+     * @defaultValue true
+     */
+    autoCollectUTMAsMetadata?: boolean;
+}
+
 /**
  * Parameters for the {@link Purchases.getOfferings} method.
  * @public
@@ -606,6 +618,13 @@ export declare enum ProductType {
     NonConsumable = "non_consumable"
 }
 
+/**
+ * Metadata that can be passed to the backend when making a purchase.
+ * They will propagate to the payment gateway (i.e. Stripe) and to RevenueCat.
+ * @public
+ */
+export declare type PurchaseMetadata = Record<string, string | null>;
+
 /**
  * Represents a possible option to purchase a product.
  * @public
@@ -651,6 +670,12 @@ export declare interface PurchaseParams {
      * Defaults to english.
      */
     defaultLocale?: string;
+    /**
+     * The purchase metadata to be passed to the backend.
+     * Any information provided here will be propagated to the payment gateway and
+     * to the RC transaction as metadata.
+     */
+    metadata?: PurchaseMetadata;
 }
 
 /**
@@ -699,9 +724,10 @@ export declare class Purchases {
       * @param apiKey - RevenueCat API Key. Can be obtained from the RevenueCat dashboard.
       * @param appUserId - Your unique id for identifying the user.
       * @param httpConfig - Advanced http configuration to customise the SDK usage {@link HttpConfig}.
+      * @param flags - Advanced functionality configuration {@link FlagsConfig}.
       * @throws {@link PurchasesError} if the API key or user id are invalid.
           */
-      static configure(apiKey: string, appUserId: string, httpConfig?: HttpConfig): Purchases;
+      static configure(apiKey: string, appUserId: string, httpConfig?: HttpConfig, flags?: FlagsConfig): Purchases;
       /**
        * Loads and caches some optional data in the Purchases SDK.
        * Currently only fetching branding information. You can call this method