@braze/web-sdk 3.4.1 → 4.0.0

package/index.d.ts

@@ -1,19 +1,44 @@
 /*
-* Type definitions for appboy-web-sdk v3.4.1
-* Project: https://github.com/Appboy/appboy-web-sdk
-* (c) Braze, Inc. 2021 - http://braze.com
-* License available at https://github.com/Appboy/appboy-web-sdk/blob/master/LICENSE
+* Type definitions for @braze/web-sdk v4.0.0
+* Project: https://github.com/braze-inc/braze-web-sdk
+* (c) Braze, Inc. 2022 - http://braze.com
+* License available at https://github.com/braze-inc/braze-web-sdk/blob/master/LICENSE
 */
 
-declare namespace appboy {
-  /**
-   * Enum to represent the allowlistable set of device properties. By default, all properties are collected.
-   * See the `devicePropertyAllowlist` option of `appboy.initialize` for more info.
 
+  /**
+   * Enum to represent the accepted SDK Metadata tags. See `addSdkMetadata` for more info.
+   *
    * @readonly
    * @enum {string}
    */
-  class DeviceProperties {
+   export class BrazeSdkMetadata {
+    /** Automatically added when loading Braze via Google Tag Manager */
+    static readonly GOOGLE_TAG_MANAGER: string;
+    /** Automatically added when loading Braze via mParticle */
+    static readonly MPARTICLE: string;
+    /** Automatically added when loading Braze via Segment */
+    static readonly SEGMENT: string;
+    /** Automatically added when loading Braze via Tealium */
+    static readonly TEALIUM: string;
+    /** Automatically added when loading Braze via npm */
+    static readonly NPM: string;
+    /** Automatically added when loading Braze via Braze's CDN (js.appboycdn.com) */
+    static readonly CDN: string;
+    /** Automatically added when loading Braze via Shopify Integration */
+    static readonly SHOPIFY: string;
+    /** Use this tag if you have integrated or loaded the Braze Web SDK using none of the other methods */
+    static readonly MANUAL: string;
+  }
+
+  /**
+   * Enum to represent the allowlistable set of device properties. By default, all properties are collected.
+   * See the `devicePropertyAllowlist` option of `initialize` for more info.
+
+  * @readonly
+  * @enum {string}
+  */
+  export class DeviceProperties {
     /** The name of the browser - e.g. "Chrome" */
     static readonly BROWSER: string;
     /** The version of the browser - e.g. "59.234.1234" */
@@ -31,14 +56,16 @@ declare namespace appboy {
   }
 
   /**
-   * Abstract base for news feed cards. Use subclasses `ClassicCard`, `CaptionedImage`,
+   * Abstract base for news feed and Content Cards cards. Use subclasses `ClassicCard`, `CaptionedImage`,
    *   `Banner`, and `ControlCard`.
    */
-  class Card {
+  export class Card {
     /**
      * Call this method if you wish to programmatically remove the card from the feed and log a dismissal. This method
-     *   is meant to be used with the Braze UI. If you are using your own UI, you should use `appboy.logCardDismissal`
-     *   to log analytics.
+     *   is meant to be used with the Braze UI.
+     *
+     * If you are using your own UI, this method will have no effect. Instead, you should use `logCardDismissal` to
+     *   log analytics and then remove the card from the DOM manually.
      */
     dismissCard(): void;
 
@@ -94,12 +121,14 @@ declare namespace appboy {
 
     /** Whether to pin this card to the top of the view. */
     pinned: boolean;
+
+
   }
 
-  class Banner extends Card {
+  export class Banner extends Card {
     /**
-     * A card with only an image, which can be passed to `display.showFeed` or handled manually.
-     *  Subscribe to receive new cards via `appboy.subscribeToFeedUpdates`
+     * A card with only an image, which can be passed to `showFeed` or handled manually.
+     *  Subscribe to receive new cards via `subscribeToFeedUpdates`
      *
      * @param id - The id of the card. This will be reported back to Braze with events for analytics purposes.
      * @param viewed - Whether this card has been shown to the user.
@@ -111,7 +140,8 @@ declare namespace appboy {
      * @param expiresAt - When this card expires and should stop being shown to the user.
      * @param url - A url to open when this card is clicked.
      * @param linkText - The display text for the url.
-     * @param aspectRatio - The aspect ratio for this card's image.
+     * @param aspectRatio - The aspect ratio for this card's image. This field is meant to serve as a hint before
+     *   image loading completes. Note that the field may not be supplied in certain circumstances.
      * @param extras - Object of string/string key/value pairs.
      * @param pinned - Whether to pin this card to the top of the view.
      * @param dismissible - Whether to allow the user to dismiss this card, removing it from the view.
@@ -152,7 +182,10 @@ declare namespace appboy {
     /** The display text for the url. */
     linkText?: string;
 
-    /** The aspect ratio for this card's image. */
+    /**
+     * The aspect ratio for this card's image. This field is meant to serve as a hint before image loading completes.
+     * Note that the field may not be supplied in certain circumstances.
+     * */
     aspectRatio: number | null;
 
     /** Whether this card has been dismissed. */
@@ -165,10 +198,10 @@ declare namespace appboy {
     clicked: boolean;
   }
 
-  class CaptionedImage extends Card {
+  export class CaptionedImage extends Card {
     /**
-     * A card with a large image and descriptive text, which can be passed to `display.showFeed` or handled manually.
-     *    Subscribe to receive new cards via `appboy.subscribeToFeedUpdates`.
+     * A card with a large image and descriptive text, which can be passed to `showFeed` or handled manually.
+     *    Subscribe to receive new cards via `subscribeToFeedUpdates`.
      *
      * @param id - The id of the card. This will be reported back to Braze with events for analytics purposes.
      * @param viewed - Whether this card has been shown to the user.
@@ -182,7 +215,8 @@ declare namespace appboy {
      * @param expiresAt - When this card expires and should stop being shown to the user.
      * @param url - A url to open when this card is clicked.
      * @param linkText - The display text for the url.
-     * @param aspectRatio - The aspect ratio for this card's image.
+     * @param aspectRatio - The aspect ratio for this card's image. This field is meant to serve as a hint before
+     *   image loading completes. Note that the field may not be supplied in certain circumstances.
      * @param extras - Object of string/string key/value pairs.
      * @param pinned - Whether to pin this card to the top of the view.
      * @param dismissible - Whether to allow the user to dismiss this card, removing it from the view.
@@ -231,7 +265,10 @@ declare namespace appboy {
     /** The display text for the url. */
     linkText?: string;
 
-    /** The aspect ratio for this card's image. */
+    /**
+     * The aspect ratio for this card's image. This field is meant to serve as a hint before image loading completes.
+     * Note that the field may not be supplied in certain circumstances.
+     */
     aspectRatio: number | null;
 
     /** Whether this card has been dismissed. */
@@ -244,11 +281,11 @@ declare namespace appboy {
     clicked: boolean;
   }
 
-  class ClassicCard extends Card {
+  export class ClassicCard extends Card {
     /**
      * A card with a title, body, and optionally a small image, which can be passed to
-     *    `display.showFeed` or handled manually.
-     *    Subscribe to receive new cards via `appboy.subscribeToFeedUpdates`.
+     *    `showFeed` or handled manually.
+     *    Subscribe to receive new cards via `subscribeToFeedUpdates`.
      *
      * @param id - The id of the card. This will be reported back to Braze with events for analytics purposes.
      * @param viewed - Whether this card has been shown to the user.
@@ -262,7 +299,8 @@ declare namespace appboy {
      * @param expiresAt - When this card expires and should stop being shown to the user.
      * @param url - A url to open when this card is clicked.
      * @param linkText - The display text for the url.
-     * @param aspectRatio - The aspect ratio for this card's image.
+     * @param aspectRatio - The aspect ratio for this card's image. This field is meant to serve as a hint before
+     *   image loading completes. Note that the field may not be supplied in certain circumstances.
      * @param extras - Object of string/string key/value pairs.
      * @param pinned - Whether to pin this card to the top of the view.
      * @param dismissible - Whether to allow the user to dismiss this card, removing it from the view.
@@ -311,7 +349,10 @@ declare namespace appboy {
     /** The display text for the url. */
     linkText?: string;
 
-    /** The aspect ratio for this card's image. */
+    /**
+     * The aspect ratio for this card's image. This field is meant to serve as a hint before image loading completes.
+     * Note that the field may not be supplied in certain circumstances.
+     */
     aspectRatio: number | null;
 
     /** Whether this card has been dismissed. */
@@ -324,12 +365,12 @@ declare namespace appboy {
     clicked: boolean;
   }
 
-  class ControlCard extends Card {
+  export class ControlCard extends Card {
     /**
      * A card with no display that logs impressions, which can be passed to
-     *    `display.showFeed` or handled manually.
+     *    `showFeed` or handled manually.
      *    Not supported in legacy news feed.
-     *    Subscribe to receive new cards via `appboy.subscribeToFeedUpdates`.
+     *    Subscribe to receive new cards via `subscribeToFeedUpdates`.
      *
      * @param id - The id of the card. This will be reported back to Braze with events for analytics purposes.
      * @param viewed - Whether this card has been shown to the user.
@@ -348,15 +389,15 @@ declare namespace appboy {
     );
   }
 
-  class ContentCards {
+  export class ContentCards {
     /**
      *  A collection of `Card` descendents (`ClassicCard`, `CaptionedImage`, `Banner`).
-     *    If you use Appboy's display module to render content cards, you generally shouldn't need to
+     *    If you use Braze's UI to render content cards, you generally shouldn't need to
      *    interact with this class, but if you are building your own content cards class manually, use
-     *    `appboy.getCachedContentCards` to get the most recent ContentCards object.
+     *    `getCachedContentCards` to get the most recent ContentCards object.
      *
      * @param cards - Array of `Card` descendents (`ClassicCard`, `CaptionedImage`, `Banner`).
-     * @param lastUpdated - When this collection of cards was received from Appboy servers. If null, it means the
+     * @param lastUpdated - When this collection of cards was received from Braze servers. If null, it means the
      *    content cards are still being fetched for this user.
      */
     constructor(cards: Card[], lastUpdated: Date | null);
@@ -365,7 +406,7 @@ declare namespace appboy {
     cards: Card[];
 
     /**
-     * When this collection of cards was received from Appboy servers. If null, it means the
+     * When this collection of cards was received from Braze servers. If null, it means the
      *    content cards are still being fetched for this user.
      */
     lastUpdated: Date | null;
@@ -377,14 +418,14 @@ declare namespace appboy {
     getUnviewedCardCount(): number;
   }
 
-  class Feed {
+  export class Feed {
     /**
      *  A collection of `Card` descendents (`ClassicCard`, `CaptionedImage`, `Banner`).
-     *    Subscribe to receive feed updates via `appboy.subscribeToFeedUpdates`,
-     *    or get the currently cached feed with `appboy.getCachedFeed`.
+     *    Subscribe to receive feed updates via `subscribeToFeedUpdates`,
+     *    or get the currently cached feed with `getCachedFeed`.
      *
      * @param cards - Array of `Card` descendents (`ClassicCard`, `CaptionedImage`,
-     *   `Banner`). Can be passed directly to `display.showFeed`.
+     *   `Banner`). Can be passed directly to `showFeed`.
      * @param lastUpdated - When this collection of cards was received from Braze servers. If null, it means the
      *   feed has never been fetched for this user.
      */
@@ -392,12 +433,12 @@ declare namespace appboy {
 
     /**
      * Array of `Card` descendents (`ClassicCard`, `CaptionedImage`, `Banner`).
-     *    Can be passed directly to `display.showFeed`.
+     *    Can be passed directly to `showFeed`.
      */
     cards: Card[];
 
     /**
-     * When this collection of cards was received from Appboy servers. If null, it means the
+     * When this collection of cards was received from Braze servers. If null, it means the
      *    content cards are still being fetched for this user.
      */
     lastUpdated: Date | null;
@@ -405,16 +446,16 @@ declare namespace appboy {
     /**
      * Get the current unread card count. This is useful for powering badges on your control for showing the news feed.
      *    Note that Braze will not refresh news feed cards on new page loads (and so this function will return 0) until you
-     *    call `display.showFeed` or `appboy.requestFeedRefresh`. `ControlCard` cards do not count towards the
+     *    call `showFeed` or `requestFeedRefresh`. `ControlCard` cards do not count towards the
      *    unread count.
      */
     getUnreadCardCount(): number;
   }
 
-  class ControlMessage {
+  export class ControlMessage {
     /**
      *  A non-showing message placeholder that represents this user receiving the the control for a multivariate
-     *    test.  Can be passed to `display.showInAppMessage` to log the user's
+     *    test.  Can be passed to `showInAppMessage` to log the user's
      *    entrollment in the control or handled manually.
      *
      * @param triggerId - The id of the trigger that created this message. The SDK will report back this to
@@ -429,29 +470,35 @@ declare namespace appboy {
     triggerId?: string;
   }
 
-  namespace InAppMessage {
-    type SlideFrom = "TOP" | "BOTTOM";
+  
+  type SlideFrom = typeof InAppMessage.SlideFrom[keyof typeof InAppMessage.SlideFrom];
 
-    type ClickAction = "NEWS_FEED" | "URI" | "NONE";
+  
+  type ClickAction = typeof InAppMessage.ClickAction[keyof typeof InAppMessage.ClickAction];
 
-    type DismissType = "AUTO_DISMISS" | "SWIPE";
+  
+  type DismissType = typeof InAppMessage.DismissType[keyof typeof InAppMessage.DismissType];
 
-    type OpenTarget = "NONE" | "BLANK";
+  
+  type OpenTarget = typeof InAppMessage.OpenTarget[keyof typeof InAppMessage.OpenTarget];
 
-    type ImageStyle = "TOP" | "GRAPHIC";
+  
+  type ImageStyle = typeof InAppMessage.ImageStyle[keyof typeof InAppMessage.ImageStyle];
 
-    type Orientation = "PORTRAIT" | "LANDSCAPE";
+  
+  type Orientation = typeof InAppMessage.Orientation[keyof typeof InAppMessage.Orientation];
 
-    type TextAlignment = "START" | "CENTER" | "END";
+  
+  type TextAlignment = typeof InAppMessage.TextAlignment[keyof typeof InAppMessage.TextAlignment];
 
-    type CropType = "CENTER_CROP" | "FIT_CENTER";
-  }
+  
+  type CropType = typeof InAppMessage.CropType[keyof typeof InAppMessage.CropType];
 
   /**
    *  Abstract base for in-app messages. Use subclasses `SlideUpMessage`,
    *    `ModalMessage`, `FullScreenMessage`, and `HtmlMessage`.
    */
-  class InAppMessage {
+  export class InAppMessage {
     static SlideFrom: {
       TOP: "TOP";
       BOTTOM: "BOTTOM";
@@ -510,19 +557,19 @@ declare namespace appboy {
 
     /**
      * The id of the trigger that created this message. The SDK will report back this to
-     *    Appboy with in-app message analytics events.
+     *    Braze with in-app message analytics events.
      */
     triggerId?: string;
 
     /**
      * How the message is dismissed, via a timer or requiring interaction from the user.
-     *    See the `InAppMessage.DismissType` enum.
+     *    See the `DismissType` enum.
      */
-    dismissType: InAppMessage.DismissType;
+    dismissType: DismissType;
 
     /**
      * Length of time in milliseconds until auto-dismiss should occur. Only used when
-     *   dismissType is `InAppMessage.DismissType.AUTO_DISMISS`
+     *   dismissType is `DismissType`.AUTO_DISMISS
      */
     duration: number;
 
@@ -582,39 +629,35 @@ declare namespace appboy {
      */
     subscribeToDismissedEvent(subscriber: () => void): string;
 
-    static fromJson(jsonData: Record<string, unknown>): InAppMessage | undefined;
+
   }
 
-  class FullScreenMessage extends InAppMessage {
+  export class FullScreenMessage extends InAppMessage {
     /**
-     *  A modal in-app message object which can be passed to `display.showInAppMessage`
-     *    or handled manually. Subscribe to be notified when in-app messages are triggered via `appboy.subscribeToInAppMessage`.
+     *  A modal in-app message object which can be passed to `showInAppMessage`
+     *    or handled manually. Subscribe to be notified when in-app messages are triggered via `subscribeToInAppMessage`.
      *
      * @param message - The message to display to the user.
-     * @param messageAlignment - How to align message text. See the `InAppMessage.TextAlignment` enum.
+     * @param messageAlignment - How to align message text. See the `TextAlignment` enum.
      * @param extras - Object of string/string key/value pairs.
-     * @param campaignId - If the message comes with a campaign, this is the id of the campaign that the SDK
-     *    will report back to Appboy with in-app message analytics events.
-     * @param cardId - If the message comes with a card, this is the id of the card that the SDK
-     *    will report back to Appboy with in-app message analytics events.
      * @param triggerId - The id of the trigger that created this message. The SDK will report back this to
-     *    Appboy with in-app message analytics events.
+     *    Braze with in-app message analytics events.
      * @param clickAction - Where the user should be brought when clicking on this message. See the
-     *    `InAppMessage.ClickAction` enum.
-     * @param uri - If ```clickAction``` is `InAppMessage.ClickAction.URI`, the URI to follow when the
+     *    `ClickAction` enum.
+     * @param uri - If ```clickAction``` is `ClickAction`.URI, the URI to follow when the
      *    user clicks on this message.
-     * @param openTarget - If ```clickAction``` is `InAppMessage.ClickAction.URI`, whether to open clicks
-     *    in a new tab/window. See the `InAppMessage.OpenTarget` enum.
+     * @param openTarget - If ```clickAction``` is `ClickAction`.URI, whether to open clicks
+     *    in a new tab/window. See the `OpenTarget` enum.
      * @param dismissType  - How the message is dismissed, via a timer or requiring interaction from the user.
-     *    See the `InAppMessage.DismissType` enum.
+     *    See the `DismissType` enum.
      * @param duration - Length of time in milliseconds until auto-dismiss should occur. Only used when
-     *    dismissType is `InAppMessage.DismissType.AUTO_DISMISS`
+     *    dismissType is `DismissType`.AUTO_DISMISS
      * @param icon - A Font Awesome unicode string, e.g. "\uf042" to fa-adjust. See
      *    [the Font Awesome cheatsheet](http://fortawesome.github.io/Font-Awesome/cheatsheet/) for details.
      * @param imageUrl - Url of an image to include in this message. The message will only display an image *or*
      *    an icon, and will prioritize the image if present.
      * @param imageStyle - Whether the image should be shown as normal on the top of the in-app message or used
-     *    as the entire content of the message. See the `InAppMessage.ImageStyle` enum.
+     *    as the entire content of the message. See the `ImageStyle` enum.
      * @param iconColor - Color of icon. Hex value with opacity (e.g. 0xff00ff00 is opaque green).
      * @param iconBackgroundColor - Background color of icon. Hex value with opacity (e.g. 0xff00ff00
      *    is opaque green).
@@ -626,35 +669,33 @@ declare namespace appboy {
      *    opaque green).
      * @param animateIn - Whether to animate the showing of this message.
      * @param animateOut - Whether to animate the hiding of this message.
-     * @param header - Header text to display.
-     * @param headerAlignment - How to align header text. See the `InAppMessage.TextAlignment` enum.
+     * @param header - Header text to
+     * @param headerAlignment - How to align header text. See the `TextAlignment` enum.
      * @param headerTextColor - Color of header text. Hex value with opacity (e.g. 0xff00ff00 is
      *    opaque green).
      * @param frameColor - Color of the background frame which blocks page interaction while the
      *    message is showing.
      * @param buttons - Array of up to two `InAppMessageButton` objects.
-     * @param cropType - How to crop and fit images in the allowable space. See the `InAppMessage.CropType` enum.
+     * @param cropType - How to crop and fit images in the allowable space. See the `CropType` enum.
      * @param orientation - Whether to lay out this in-app message as a portrait or landscape. See the
-     *    `InAppMessage.Orientation` enum.
+     *    `Orientation` enum.
      * @param htmlId - The ID to give the parent HTML element that this message is rendered into.
      * @param css - Custom CSS to apply to the page while this element is shown. All selectors should be scoped
      *    to the htmlId of this message to prevent restyling elements outside of the message when it is shown.
      */
     constructor(
       message?: string,
-      messageAlignment?: InAppMessage.TextAlignment,
+      messageAlignment?: TextAlignment,
       extras?: Record<string, any>,
-      campaignId?: string,
-      cardId?: string,
       triggerId?: string,
-      clickAction?: InAppMessage.ClickAction,
+      clickAction?: ClickAction,
       uri?: string,
-      openTarget?: InAppMessage.OpenTarget,
-      dismissType?: InAppMessage.DismissType,
+      openTarget?: OpenTarget,
+      dismissType?: DismissType,
       duration?: number,
       icon?: string,
       imageUrl?: string,
-      imageStyle?: InAppMessage.ImageStyle,
+      imageStyle?: ImageStyle,
       iconColor?: number,
       iconBackgroundColor?: number,
       backgroundColor?: number,
@@ -663,36 +704,36 @@ declare namespace appboy {
       animateIn?: boolean,
       animateOut?: boolean,
       header?: string,
-      headerAlignment?: InAppMessage.TextAlignment,
+      headerAlignment?: TextAlignment,
       headerTextColor?: number,
       frameColor?: number,
       buttons?: InAppMessageButton[],
-      cropType?: InAppMessage.CropType,
-      orientation?: InAppMessage.Orientation,
+      cropType?: CropType,
+      orientation?: Orientation,
       htmlId?: string,
       css?: string
     );
 
-    /** How to align message text. See the `InAppMessage.TextAlignment` enum. */
-    messageAlignment: InAppMessage.TextAlignment;
+    /** How to align message text. See the `TextAlignment` enum. */
+    messageAlignment: TextAlignment;
 
     /**
      * Where the user should be brought when clicking on this message. See the
-     *    `InAppMessage.ClickAction` enum.
+     *    `ClickAction` enum.
      */
-    clickAction: InAppMessage.ClickAction;
+    clickAction: ClickAction;
 
     /**
-     * If ```clickAction``` is `InAppMessage.ClickAction.URI`, the URI to follow when the
+     * If ```clickAction``` is `ClickAction`.URI, the URI to follow when the
      *    user clicks on this message.
      */
     uri?: string;
 
     /**
-     * If ```clickAction``` is `InAppMessage.ClickAction.URI`, whether to open clicks
-     *    in a new tab/window. See the `InAppMessage.OpenTarget` enum.
+     * If ```clickAction``` is `ClickAction`.URI, whether to open clicks
+     *    in a new tab/window. See the `OpenTarget` enum.
      */
-    openTarget: InAppMessage.OpenTarget;
+    openTarget: OpenTarget;
 
     /**
      * A Font Awesome unicode string, e.g. "\uf042" to fa-adjust. See
@@ -708,9 +749,9 @@ declare namespace appboy {
 
     /**
      * Whether the image should be shown as normal on the top of the in-app message or used
-     *    as the entire content of the message. See the `InAppMessage.ImageStyle` enum.
+     *    as the entire content of the message. See the `ImageStyle` enum.
      */
-    imageStyle: InAppMessage.ImageStyle;
+    imageStyle: ImageStyle;
 
     /** Color of icon. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
     iconColor: number;
@@ -727,11 +768,11 @@ declare namespace appboy {
     /** Color of close button. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
     closeButtonColor: number;
 
-    /** Header text to display. */
+    /** Header text to  */
     header?: string;
 
-    /** How to align header text. See the `InAppMessage.TextAlignment` enum. */
-    headerAlignment: InAppMessage.TextAlignment;
+    /** How to align header text. See the `TextAlignment` enum. */
+    headerAlignment: TextAlignment;
 
     /** Color of header text. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
     headerTextColor: number;
@@ -742,46 +783,42 @@ declare namespace appboy {
     /** Array of up to two `InAppMessageButton` objects. */
     buttons: InAppMessageButton[];
 
-    /** How to crop and fit images in the allowable space. See the `InAppMessage.CropType` enum. */
-    cropType: InAppMessage.CropType;
+    /** How to crop and fit images in the allowable space. See the `CropType` enum. */
+    cropType: CropType;
 
     /**
      * Whether to lay out this in-app message as a portrait or landscape. See the
-     *    `InAppMessage.Orientation` enum.
+     *    `Orientation` enum.
      */
-    orientation: InAppMessage.Orientation;
+    orientation: Orientation;
   }
 
-  class ModalMessage extends InAppMessage {
+  export class ModalMessage extends InAppMessage {
     /**
-     *  A modal in-app message object which can be passed to `display.showInAppMessage`
-     *    or handled manually. Subscribe to be notified when in-app messages are triggered via `appboy.subscribeToInAppMessage`
+     *  A modal in-app message object which can be passed to `showInAppMessage`
+     *    or handled manually. Subscribe to be notified when in-app messages are triggered via `subscribeToInAppMessage`
      *
      * @param message - The message to display to the user.
-     * @param messageAlignment - How to align message text. See the `InAppMessage.TextAlignment` enum.
+     * @param messageAlignment - How to align message text. See the `TextAlignment` enum.
      * @param extras - Object of string/string key/value pairs.
-     * @param campaignId - If the message comes with a campaign, this is the id of the campaign that the SDK
-     *    will report back to Appboy with in-app message analytics events.
-     * @param cardId - If the message comes with a card, this is the id of the card that the SDK
-     *    will report back to Appboy with in-app message analytics events.
      * @param triggerId - The id of the trigger that created this message. The SDK will report back this to
-     *    Appboy with in-app message analytics events.
+     *    Braze with in-app message analytics events.
      * @param clickAction - Where the user should be brought when clicking on this message. See the
-     *    `InAppMessage.ClickAction` enum.
-     * @param uri - If ```clickAction``` is `InAppMessage.ClickAction.URI`, the URI to follow when the
+     *    `ClickAction` enum.
+     * @param uri - If ```clickAction``` is `ClickAction`.URI, the URI to follow when the
      *    user clicks on this message.
-     * @param openTarget - If ```clickAction``` is `InAppMessage.ClickAction.URI`, whether to open clicks
-     *    in a new tab/window. See the `InAppMessage.OpenTarget` enum.
+     * @param openTarget - If ```clickAction``` is `ClickAction`.URI, whether to open clicks
+     *    in a new tab/window. See the `OpenTarget` enum.
      * @param dismissType  - How the message is dismissed, via a timer or requiring interaction from the user.
-     *    See the `InAppMessage.DismissType` enum.
+     *    See the `DismissType` enum.
      * @param duration - Length of time in milliseconds until auto-dismiss should occur. Only used when
-     *    dismissType is `InAppMessage.DismissType.AUTO_DISMISS`
+     *    dismissType is `DismissType`.AUTO_DISMISS
      * @param icon - A Font Awesome unicode string, e.g. "\uf042" to fa-adjust. See
      *    [the Font Awesome cheatsheet](http://fortawesome.github.io/Font-Awesome/cheatsheet/) for details.
      * @param imageUrl - Url of an image to include in this message. The message will only display an image *or*
      *    an icon, and will prioritize the image if present.
      * @param imageStyle - Whether the image should be shown as normal on the top of the in-app message or used
-     *    as the entire content of the message. See the `InAppMessage.ImageStyle` enum.
+     *    as the entire content of the message. See the `ImageStyle` enum.
      * @param iconColor - Color of icon. Hex value with opacity (e.g. 0xff00ff00 is opaque green).
      * @param iconBackgroundColor - Background color of icon. Hex value with opacity (e.g. 0xff00ff00
      *    is opaque green).
@@ -793,33 +830,31 @@ declare namespace appboy {
      *    opaque green).
      * @param animateIn - Whether to animate the showing of this message.
      * @param animateOut - Whether to animate the hiding of this message.
-     * @param header - Header text to display.
-     * @param headerAlignment - How to align header text. See the `InAppMessage.TextAlignment` enum.
+     * @param header - Header text to
+     * @param headerAlignment - How to align header text. See the `TextAlignment` enum.
      * @param headerTextColor - Color of header text. Hex value with opacity (e.g. 0xff00ff00 is
      *    opaque green).
      * @param frameColor - Color of the background frame which blocks page interaction while the
      *    message is showing.
      * @param buttons - Array of up to two`InAppMessageButton` objects.
-     * @param cropType - How to crop and fit images in the allowable space. See the `InAppMessage.CropType` enum.
+     * @param cropType - How to crop and fit images in the allowable space. See the `CropType` enum.
      * @param htmlId - The ID to give the parent HTML element that this message is rendered into.
      * @param css - Custom CSS to apply to the page while this element is shown. All selectors should be scoped
      *    to the htmlId of this message to prevent restyling elements outside of the message when it is shown.
      */
     constructor(
       message?: string,
-      messageAlignment?: InAppMessage.TextAlignment,
+      messageAlignment?: TextAlignment,
       extras?: Record<string, any>,
-      campaignId?: string,
-      cardId?: string,
       triggerId?: string,
-      clickAction?: InAppMessage.ClickAction,
+      clickAction?: ClickAction,
       uri?: string,
-      openTarget?: InAppMessage.OpenTarget,
-      dismissType?: InAppMessage.DismissType,
+      openTarget?: OpenTarget,
+      dismissType?: DismissType,
       duration?: number,
       icon?: string,
       imageUrl?: string,
-      imageStyle?: InAppMessage.ImageStyle,
+      imageStyle?: ImageStyle,
       iconColor?: number,
       iconBackgroundColor?: number,
       backgroundColor?: number,
@@ -828,35 +863,35 @@ declare namespace appboy {
       animateIn?: boolean,
       animateOut?: boolean,
       header?: string,
-      headerAlignment?: InAppMessage.TextAlignment,
+      headerAlignment?: TextAlignment,
       headerTextColor?: number,
       frameColor?: number,
       buttons?: InAppMessageButton[],
-      cropType?: InAppMessage.CropType,
+      cropType?: CropType,
       htmlId?: string,
       css?: string
     );
 
-    /** How to align message text. See the `InAppMessage.TextAlignment` enum. */
-    messageAlignment: InAppMessage.TextAlignment;
+    /** How to align message text. See the `TextAlignment` enum. */
+    messageAlignment: TextAlignment;
 
     /**
      * Where the user should be brought when clicking on this message. See the
-     *    `InAppMessage.ClickAction` enum.
+     *    `ClickAction` enum.
      */
-    clickAction: InAppMessage.ClickAction;
+    clickAction: ClickAction;
 
     /**
-     * If ```clickAction``` is `InAppMessage.ClickAction.URI`, the URI to follow when the
+     * If ```clickAction``` is `ClickAction`.URI, the URI to follow when the
      *    user clicks on this message.
      */
     uri?: string;
 
     /**
-     * If ```clickAction``` is `InAppMessage.ClickAction.URI`, whether to open clicks
-     *    in a new tab/window. See the `InAppMessage.OpenTarget` enum.
+     * If ```clickAction``` is `ClickAction`.URI, whether to open clicks
+     *    in a new tab/window. See the `OpenTarget` enum.
      */
-    openTarget: InAppMessage.OpenTarget;
+    openTarget: OpenTarget;
 
     /**
      * A Font Awesome unicode string, e.g. "\uf042" to fa-adjust. See
@@ -872,9 +907,9 @@ declare namespace appboy {
 
     /**
      * Whether the image should be shown as normal on the top of the in-app message or used
-     *    as the entire content of the message. See the `InAppMessage.ImageStyle` enum.
+     *    as the entire content of the message. See the `ImageStyle` enum.
      */
-    imageStyle: InAppMessage.ImageStyle;
+    imageStyle: ImageStyle;
 
     /** Color of icon. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
     iconColor: number;
@@ -891,11 +926,11 @@ declare namespace appboy {
     /** Color of close button. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
     closeButtonColor: number;
 
-    /** Header text to display. */
+    /** Header text to  */
     header?: string;
 
-    /** How to align header text. See the `InAppMessage.TextAlignment` enum. */
-    headerAlignment: InAppMessage.TextAlignment;
+    /** How to align header text. See the `TextAlignment` enum. */
+    headerAlignment: TextAlignment;
 
     /** Color of header text. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
     headerTextColor: number;
@@ -906,27 +941,23 @@ declare namespace appboy {
     /** Array of up to two`InAppMessageButton` objects. */
     buttons: InAppMessageButton[];
 
-    /** How to crop and fit images in the allowable space. See the `InAppMessage.CropType` enum. */
-    cropType: InAppMessage.CropType;
+    /** How to crop and fit images in the allowable space. See the `CropType` enum. */
+    cropType: CropType;
   }
 
-  class HtmlMessage extends InAppMessage {
+  export class HtmlMessage extends InAppMessage {
     /**
-     *  An html-content in-app message object which can be passed to `display.showInAppMessage`
-     *    or handled manually. Subscribe to be notified when in-app messages are triggered via `appboy.subscribeToInAppMessage`
+     *  An html-content in-app message object which can be passed to `showInAppMessage`
+     *    or handled manually. Subscribe to be notified when in-app messages are triggered via `subscribeToInAppMessage`
      *
      * @param message - The html content to display to the user.
      * @param extras - Object of string/string key/value pairs.
-     * @param campaignId - If the message comes with a campaign, this is the id of the campaign that the SDK
-     *   will report back to Appboy with in-app message analytics events.
-     * @param cardId - If the message comes with a card, this is the id of the card that the SDK
-     *   will report back to Appboy with in-app message analytics events.
      * @param triggerId - The id of the trigger that created this message. The SDK will report back this to
-     *   Appboy with in-app message analytics events.
+     *   Braze with in-app message analytics events.
      * @param dismissType - How the message is dismissed, via a timer or requiring interaction from the user.
-     *     See the `InAppMessage.TextAlignment` enum.
+     *     See the `TextAlignment` enum.
      * @param duration - Length of time in milliseconds until auto-dismiss should occur. Only used when
-     *   dismissType is `InAppMessage.DismissType.AUTO_DISMISS`.
+     *   dismissType is `DismissType`.AUTO_DISMISS.
      * @param animateIn - Whether to animate the showing of this message.
      * @param animateOut - Whether to animate the hiding of this message.
      * @param frameColor - Color of the background frame which blocks page interaction while the message is showing.
@@ -938,10 +969,8 @@ declare namespace appboy {
     constructor(
       message: string,
       extras?: Record<string, any>,
-      campaignId?: string,
-      cardId?: string,
       triggerId?: string,
-      dismissType?: InAppMessage.DismissType,
+      dismissType?: DismissType,
       duration?: number,
       animateIn?: boolean,
       animateOut?: boolean,
@@ -959,34 +988,30 @@ declare namespace appboy {
   }
 
   /**
-   *  A slide-up in-app message object which can be passed to `display.showInAppMessage`
-   *    or handled manually. Subscribe to be notified when in-app messages are triggered via `appboy.subscribeToInAppMessage`
+   *  A slide-up in-app message object which can be passed to `showInAppMessage`
+   *    or handled manually. Subscribe to be notified when in-app messages are triggered via `subscribeToInAppMessage`
    */
-  class SlideUpMessage extends InAppMessage {
+  export class SlideUpMessage extends InAppMessage {
     /**
-     *  A slide-up in-app message object which can be passed to `display.showInAppMessage`
-     *    or handled manually. Subscribe to be notified when in-app messages are triggered via `appboy.subscribeToInAppMessage`
+     *  A slide-up in-app message object which can be passed to `showInAppMessage`
+     *    or handled manually. Subscribe to be notified when in-app messages are triggered via `subscribeToInAppMessage`
      *
      * @param message - The message to display to the user.
-     * @param messageAlignment - How to align message text. See the `InAppMessage.TextAlignment` enum.
-     * @param slideFrom - Where the message should slide in from. See the `InAppMessage.SlideFrom` enum.
+     * @param messageAlignment - How to align message text. See the `TextAlignment` enum.
+     * @param slideFrom - Where the message should slide in from. See the `SlideFrom` enum.
      * @param extras - Object of string/string key/value pairs.
-     * @param campaignId - If the message comes with a campaign, this is the id of the campaign that the SDK
-     *    will report back to Appboy with in-app message analytics events.
-     * @param cardId - If the message comes with a card, this is the id of the card that the SDK
-     *    will report back to Appboy with in-app message analytics events.
      * @param triggerId - The id of the trigger that created this message. The SDK will report back this to
-     *    Appboy with in-app message analytics events.
+     *    Braze with in-app message analytics events.
      * @param clickAction - Where the user should be brought when clicking on this message. See the
-     *    `InAppMessage.ClickAction` enum.
-     * @param uri - If ```clickAction``` is `InAppMessage.ClickAction.URI`, the URI to follow when the
+     *    `ClickAction` enum.
+     * @param uri - If ```clickAction``` is `ClickAction`.URI, the URI to follow when the
      *    user clicks on this message.
-     * @param openTarget - If ```clickAction``` is `InAppMessage.ClickAction.URI`, whether to open clicks
-     *    in a new tab/window. See the `InAppMessage.OpenTarget` enum.
+     * @param openTarget - If ```clickAction``` is `ClickAction`.URI, whether to open clicks
+     *    in a new tab/window. See the `OpenTarget` enum.
      * @param dismissType  - How the message is dismissed, via a timer or requiring interaction from the user.
-     *    See the `InAppMessage.DismissType` enum.
+     *    See the `DismissType` enum.
      * @param duration - Length of time in milliseconds until auto-dismiss should occur. Only used when
-     *    dismissType is `InAppMessage.DismissType.AUTO_DISMISS`
+     *    dismissType is `DismissType`.AUTO_DISMISS
      * @param icon - A Font Awesome unicode string, e.g. "\uf042" to fa-adjust. See
      *    [the Font Awesome cheatsheet](http://fortawesome.github.io/Font-Awesome/cheatsheet/) for details.
      * @param imageUrl - Url of an image to include in this message. The message will only display an image *or*
@@ -1008,16 +1033,14 @@ declare namespace appboy {
      */
     constructor(
       message: string,
-      messageAlignment?: InAppMessage.TextAlignment,
-      slideFrom?: InAppMessage.SlideFrom,
+      messageAlignment?: TextAlignment,
+      slideFrom?: SlideFrom,
       extras?: Record<string, any>,
-      campaignId?: string,
-      cardId?: string,
       triggerId?: string,
-      clickAction?: InAppMessage.ClickAction,
+      clickAction?: ClickAction,
       uri?: string,
-      openTarget?: InAppMessage.OpenTarget,
-      dismissType?: InAppMessage.DismissType,
+      openTarget?: OpenTarget,
+      dismissType?: DismissType,
       duration?: number,
       icon?: string,
       imageUrl?: string,
@@ -1032,29 +1055,29 @@ declare namespace appboy {
       css?: string
     );
 
-    /** How to align message text. See the `InAppMessage.TextAlignment` enum. */
-    messageAlignment: InAppMessage.TextAlignment;
+    /** How to align message text. See the `TextAlignment` enum. */
+    messageAlignment: TextAlignment;
 
-    /** Where the message should slide in from. See the `InAppMessage.SlideFrom` enum. */
-    slideFrom: InAppMessage.SlideFrom;
+    /** Where the message should slide in from. See the `SlideFrom` enum. */
+    slideFrom: SlideFrom;
 
     /**
      * Where the user should be brought when clicking on this message. See the
-     *    `InAppMessage.ClickAction` enum.
+     *    `ClickAction` enum.
      */
-    clickAction: InAppMessage.ClickAction;
+    clickAction: ClickAction;
 
     /**
-     * If ```clickAction``` is `InAppMessage.ClickAction.URI`, the URI to follow when the
+     * If ```clickAction``` is `ClickAction`.URI, the URI to follow when the
      *    user clicks on this message.
      */
     uri?: string;
 
     /**
-     * If ```clickAction``` is `InAppMessage.ClickAction.URI`, whether to open clicks
-     *    in a new tab/window. See the `InAppMessage.OpenTarget` enum.
+     * If ```clickAction``` is `ClickAction`.URI, whether to open clicks
+     *    in a new tab/window. See the `OpenTarget` enum.
      */
-    openTarget: InAppMessage.OpenTarget;
+    openTarget: OpenTarget;
 
     /**
      * A Font Awesome unicode string, e.g. "\uf042" to fa-adjust. See
@@ -1084,20 +1107,21 @@ declare namespace appboy {
     closeButtonColor: number;
   }
 
-  namespace User {
-    type Genders = "m" | "f" | "o" | "u" | "n" | "p";
-    type NotificationSubscriptionTypes = "opted_in" | "subscribed" | "unsubscribed";
-  }
+  
+  type Genders = typeof User.Genders[keyof typeof User.Genders];
+
+  
+  type NotificationSubscriptionTypes = typeof User.NotificationSubscriptionTypes[keyof typeof User.NotificationSubscriptionTypes];
 
   /**
-   * Do not construct directly - use `appboy.getUser` to get the user object.
+   * Do not construct directly - use `getUser` to get the user object.
    *   User provides an object which lets you update the attributes stored by Braze for your user.
    *
    * This class has been designed to provide fire and forget semantics and to not impact the performance or lifecycle of
    *   calling code. As such, changes made to an User are enqueued locally and flushed to Braze's servers
    *   asynchronously.
    */
-  class User {
+  export class User {
     /** Enum to represent valid genders. */
     static Genders: {
       MALE: "m";
@@ -1153,7 +1177,7 @@ declare namespace appboy {
      * For example:
      *
      * ```
-     * appboy.getUser().getUserId(function(userId) {
+     * braze.getUser().getUserId(function(userId) {
      *    console.log('The user is ' + userId);
      * });
      * ```
@@ -1196,17 +1220,7 @@ declare namespace appboy {
      *
      * @returns Whether the update was successfully enqueued.
      */
-     removeFromSubscriptionGroup(subscriptionGroupId: string): boolean;
-
-    /**
-     * Sets the url for the avatar image for the user, which will be displayed on the user profile
-     * and throughout the Braze dashboard.
-     *
-     * @param avatarImageUrl
-     *
-     * @returns Whether the update was successfully enqueued.
-     */
-    setAvatarImageUrl(avatarImageUrl: string): boolean;
+    removeFromSubscriptionGroup(subscriptionGroupId: string): boolean;
 
     /**
      * Sets the country for the user.
@@ -1282,12 +1296,12 @@ declare namespace appboy {
      * Sets whether the user should be sent email campaigns.
      *
      * @param notificationSubscriptionType - Notification setting (explicitly opted-in, subscribed, or unsubscribed).
-     *    See the `User.NotificationSubscriptionTypes` enum.
+     *    See the `NotificationSubscriptionTypes` enum.
      *
      * @returns Whether the update was successfully enqueued.
      */
     setEmailNotificationSubscriptionType(
-      notificationSubscriptionType: User.NotificationSubscriptionTypes
+      notificationSubscriptionType: NotificationSubscriptionTypes
     ): boolean;
 
     /**
@@ -1302,12 +1316,12 @@ declare namespace appboy {
     /**
      * Sets the gender of the user.
      *
-     * @param gender - Generally 'm' or 'f'. Accepts an explicit null value to null out attribute. Use `User.Genders`
+     * @param gender - Generally 'm' or 'f'. Accepts an explicit null value to null out attribute. Use `Genders`
      *    enum when setting this value.
      *
      * @returns Whether the update was successfully enqueued.
      */
-    setGender(gender: User.Genders | null): boolean;
+    setGender(gender: Genders | null): boolean;
 
     /**
      * Sets the home city for the user.
@@ -1374,16 +1388,16 @@ declare namespace appboy {
      * Sets whether the user should be sent push campaigns.
      *
      * @param notificationSubscriptionType - Notification setting (explicitly opted-in, subscribed, or unsubscribed).
-     *    See the `User.NotificationSubscriptionTypes` enum.
+     *    See the `NotificationSubscriptionTypes` enum.
      *
      * @returns Whether the update was successfully enqueued.
      */
     setPushNotificationSubscriptionType(
-      notificationSubscriptionType: User.NotificationSubscriptionTypes
+      notificationSubscriptionType: NotificationSubscriptionTypes
     ): boolean;
   }
 
-  class InAppMessageButton {
+  export class InAppMessageButton {
     /**
      *  Represents a button on an `ModalMessage` or `FullScreenMessage`.
      *
@@ -1395,8 +1409,8 @@ declare namespace appboy {
      * @param borderColor - The color for the border of this button. Hex value with opacity (e.g.
      *    0xff00ff00 is opaque green).
      * @param clickAction - Where the user should be brought when clicking on this button. See the
-     *    `InAppMessage.ClickAction` enum.
-     * @param uri - If ```clickAction``` is `InAppMessage.ClickAction.URI`, the URI to follow when the
+     *    `ClickAction` enum.
+     * @param uri - If ```clickAction``` is `ClickAction`.URI, the URI to follow when the
      *  user clicks on this button.
      * @param id - The id for this button. Used for analytics.
      */
@@ -1405,7 +1419,7 @@ declare namespace appboy {
       backgroundColor?: number,
       textColor?: number,
       borderColor?: number,
-      clickAction?: InAppMessage.ClickAction,
+      clickAction?: ClickAction,
       uri?: string,
       id?: number
     );
@@ -1433,12 +1447,12 @@ declare namespace appboy {
 
     /**
      * Where the user should be brought when clicking on this button. See the
-     *    `InAppMessage.ClickAction` enum.
+     *    `ClickAction` enum.
      */
-    clickAction: InAppMessage.ClickAction;
+    clickAction: ClickAction;
 
     /**
-     * If ```clickAction``` is `InAppMessage.ClickAction.URI`, the URI to follow when the
+     * If ```clickAction``` is `ClickAction`.URI, the URI to follow when the
      *  user clicks on this button.
      */
     uri?: string;
@@ -1471,131 +1485,125 @@ declare namespace appboy {
   }
 
   /**
-   * appboy.display is the public class for the UI portions of Braze's Web SDK. It is only available in
-   *    `https://js.appboycdn.com/web-sdk-develop/3.4/appboy.min.js` and is stripped from the more minimal
-   *    `https://js.appboycdn.com/web-sdk-develop/3.4/appboy.core.min.js`.
+   * Automatically display in-app messages when they are triggered. This method should be called before
+   *   calling `openSession`.
+   *
+   * @returns The identifier of the subscription created. This can be passed to
+   *    `removeSubscription` to cancel the subscription.
    */
-  namespace display {
-    /**
-     * Automatically display new in-app messages when they come in from the server.
-     *
-     * @returns The identifier of the subscription created. This can be passed to
-     *    'appboy.removeSubscription` to cancel the subscription.
-     */
-    function automaticallyShowNewInAppMessages(): string;
+  export function automaticallyShowInAppMessages(): string;
 
-    /**
-     * Destroy any Braze news feed currently showing. This method will appropriately clean up any retained resources
-     *    and also display the hiding animation, and so should be used instead of manually removing feed html from the
-     *    DOM.
-     */
-    function destroyFeed(): void;
+  /**
+   * Destroy any Braze news feed currently showing. This method will appropriately clean up any retained resources
+   *    and also display the hiding animation, and so should be used instead of manually removing feed html from the
+   *    DOM.
+   */
+  export function destroyFeed(): void;
 
-    /**
-     * Hide any Braze content cards currently showing in the parent node, or if none is provided, any content cards in the page.
-     *    This method will appropriately clean up any retained resources and also display the hiding animation, and so should be
-     *    used instead of manually removing content cards HTML from the DOM.
-     *
-     * @param parentNode - The HTML node that denotes the parent of the content cards to be hidden. If null/undefined, all content
-     *    cards on the page will be hidden.
-     */
-    function hideContentCards(parentNode?: Element | null): void;
+  /**
+   * Hide any Braze content cards currently showing in the parent node, or if none is provided, any content cards in the page.
+   *    This method will appropriately clean up any retained resources and also display the hiding animation, and so should be
+   *    used instead of manually removing content cards HTML from the DOM.
+   *
+   * @param parentNode - The HTML node that denotes the parent of the content cards to be hidden. If null/undefined, all content
+   *    cards on the page will be hidden.
+   */
+  export function hideContentCards(parentNode?: Element | null): void;
 
-    /**
-     * Display the user's content cards.
-     *
-     * @param parentNode - The HTML node to render the content cards into. If null/undefined, the content
-     *    cards will be rendered in fixed position over the right-hand side of the page and appended to the `<body>`
-     *    node. If the parent node already has a Braze content cards view as a direct descendant, the existing content
-     *    cards will be replaced.
-     * @param filterFunction - A filter/sort function for cards displayed in this view. Invoked with the
-     *    array of `Card` objects, sorted by {pinned, date}. Expected to return an array of sorted
-     *    `Card` objects to render for this user. If omitted, all cards will be displayed.
-     */
-    function showContentCards(
-      parentNode?: Element | null,
-      filterFunction?: (cards: appboy.Card[]) => appboy.Card[]
-    ): void;
+  /**
+   * Display the user's content cards.
+   *
+   * @param parentNode - The HTML node to render the content cards into. If null/undefined, the content
+   *    cards will be rendered in fixed position over the right-hand side of the page and appended to the `<body>`
+   *    node. If the parent node already has a Braze content cards view as a direct descendant, the existing content
+   *    cards will be replaced.
+   * @param filterFunction - A filter/sort function for cards displayed in this view. Invoked with the
+   *    array of `Card` objects, sorted by {pinned, date}. Expected to return an array of sorted
+   *    `Card` objects to render for this user. If omitted, all cards will be displayed.
+   */
+  export function showContentCards(
+    parentNode?: Element | null,
+    filterFunction?: (cards: Card[]) => Card[]
+  ): void;
 
-    /**
-     * Display the user's news feed.
-     *
-     * @param parentNode - The HTML node to render the news feed into. If null/undefined, the feed will be
-     *    rendered in fixed position over the right-hand side of the page and appended to the `<body>` node. If the
-     *    parent node already has an Braze news feed as a direct descendant, the existing feed will be replaced.
-     * @param cards - A static set of cards to display. Each item in this Array should be a `Card`
-     *    descendant. If this parameter is null/undefined, all unexpired cards from the last news feed refresh will be
-     *    used automatically, a feed refresh will be kicked off automatically if the cached cards are more than 1 minute
-     *    old, and the feed will automatically update when new cards are received while it is still showing. If you
-     *    provide an explicit set of cards by using this parameter, no action will be taken when new cards are received,
-     *    and you must subscribe to feed updates yourself with `appboy.subscribeToFeedUpdates` and request updates with
-     *    `appboy.requestFeedRefresh` if you want to update this feed with new cards.
-     * @param allowedCategories - A set of categories to filter cards to. Each item in this Array should be a
-     *    card category as set in the Braze dashboard. If omitted, all cards will be displayed.
-     */
-    function showFeed(
-      parentNode?: Element | null,
-      cards?: appboy.Card[] | null,
-      allowedCategories?: string[]
-    ): void;
+  /**
+   * Display the user's news feed.
+   *
+   * @param parentNode - The HTML node to render the news feed into. If null/undefined, the feed will be
+   *    rendered in fixed position over the right-hand side of the page and appended to the `<body>` node. If the
+   *    parent node already has an Braze news feed as a direct descendant, the existing feed will be replaced.
+   * @param cards - A static set of cards to  Each item in this Array should be a `Card`
+   *    descendant. If this parameter is null/undefined, all unexpired cards from the last news feed refresh will be
+   *    used automatically, a feed refresh will be kicked off automatically if the cached cards are more than 1 minute
+   *    old, and the feed will automatically update when new cards are received while it is still showing. If you
+   *    provide an explicit set of cards by using this parameter, no action will be taken when new cards are received,
+   *    and you must subscribe to feed updates yourself with `subscribeToFeedUpdates` and request updates with
+   *    `requestFeedRefresh` if you want to update this feed with new cards.
+   * @param allowedCategories - A set of categories to filter cards to. Each item in this Array should be a
+   *    card category as set in the Braze dashboard. If omitted, all cards will be displayed.
+   */
+  export function showFeed(
+    parentNode?: Element | null,
+    cards?: Card[] | null,
+    allowedCategories?: string[]
+  ): void;
 
-    /**
-     * Display a given in-app message.
-     *
-     * @param inAppMessage - The message to display.
-     * @param parentNode - The HTML node to render the in-app message into. If null/undefined, the message
-     *    will be rendered appended within the `<body>` node.
-     * @param onDisplayCallback - Optional callback to invoke once the message is on the screen.
-     *
-     * @returns Whether or not the message was displayed (or, in the case of control messages, logged to
-     *    Braze servers).
-     */
-    function showInAppMessage(
-      inAppMessage: appboy.InAppMessage | appboy.ControlMessage,
-      parentNode?: Element | null,
-      onDisplayCallback?: () => void
-    ): boolean;
+  /**
+   * Display a given in-app message.
+   *
+   * @param inAppMessage - The message to
+   * @param parentNode - The HTML node to render the in-app message into. If null/undefined, the message
+   *    will be rendered appended within the `<body>` node.
+   * @param onDisplayCallback - Optional callback to invoke once the message is on the screen.
+   *
+   * @returns Whether or not the message was displayed (or, in the case of control messages, logged to
+   *    Braze servers).
+   */
+  export function showInAppMessage(
+    inAppMessage: InAppMessage | ControlMessage,
+    parentNode?: Element | null,
+    onDisplayCallback?: () => void
+  ): boolean;
 
-    /**
-     * Toggle the display of Braze content cards, showing them if they are not shown, and hiding them if they are. If you
-     *    wish to display multiple content cards feeds on a page simultaneously, you should use `showContentCards` and `hideContentCards`
-     *    to show/hide each feed individually instead of this method.
-     *
-     * @param parentNode - The HTML node to render the content cards into. If null/undefined, the content
-     *    cards will be rendered in fixed position over the right-hand side of the page and appended to the `<body>`
-     *    node. If the parent node already has a Braze content cards view as a direct descendant, the existing content
-     *    cards will be replaced.
-     * @param filterFunction - A filter/sort function for cards displayed in this view. Invoked with the
-     *    array of `Card` objects, sorted by {pinned, date}. Expected to return an array of sorted
-     *    `Card` objects to render for this user. If omitted, all cards will be displayed.
-     */
-    function toggleContentCards(
-      parentNode?: Element | null,
-      filterFunction?: (cards: appboy.Card[]) => appboy.Card[]
-    ): void;
-
-    /**
-     * Toggle the Braze news feed, creating it if it does not exist, and destroying it if it does.
-     *
-     * @param parentNode - The HTML node to render the news feed into. If null/undefined, the feed will be
-     *    rendered in fixed position over the right-hand side of the page and appended to the `<body>` node. If the
-     *    parent node already has an Braze news feed as a direct descendant, the existing feed will be replaced.
-     * @param cards - A static set of cards to display. Each item in this Array should be a `Card`
-     *    descendant. If this parameter is null/undefined, all unexpired cards from the last news feed refresh will be
-     *    used automatically, a feed refresh will be kicked off automatically if the cached cards are more than 1 minute
-     *    old, and the feed will automatically update when new cards are received while it is still showing. If you
-     *    provide an explicit set of cards by using this parameter, no action will be taken when new cards are received,
-     *    and you must subscribe to feed updates yourself with `appboy.subscribeToFeedUpdates` and request updates with
-     *   `appboy.requestFeedRefresh` if you want to update this feed with new cards.
-     * @param allowedCategories - A set of categories to filter cards to. Each item in this Array should be a
-     *    card category as set in the Braze dashboard. If omitted, all cards will be displayed.
-     */
-    function toggleFeed(
-      parentNode?: Element | null,
-      cards?: appboy.Card[] | null,
-      allowedCategories?: string[]
-    ): void;
-  }
+  /**
+   * Toggle the display of Braze content cards, showing them if they are not shown, and hiding them if they are. If you
+   *    wish to display multiple content cards feeds on a page simultaneously, you should use `showContentCards` and `hideContentCards`
+   *    to show/hide each feed individually instead of this method.
+   *
+   * @param parentNode - The HTML node to render the content cards into. If null/undefined, the content
+   *    cards will be rendered in fixed position over the right-hand side of the page and appended to the `<body>`
+   *    node. If the parent node already has a Braze content cards view as a direct descendant, the existing content
+   *    cards will be replaced.
+   * @param filterFunction - A filter/sort function for cards displayed in this view. Invoked with the
+   *    array of `Card` objects, sorted by {pinned, date}. Expected to return an array of sorted
+   *    `Card` objects to render for this user. If omitted, all cards will be displayed.
+   */
+  export function toggleContentCards(
+    parentNode?: Element | null,
+    filterFunction?: (cards: Card[]) => Card[]
+  ): void;
+
+  /**
+   * Toggle the Braze news feed, creating it if it does not exist, and destroying it if it does.
+   *
+   * @param parentNode - The HTML node to render the news feed into. If null/undefined, the feed will be
+   *    rendered in fixed position over the right-hand side of the page and appended to the `<body>` node. If the
+   *    parent node already has an Braze news feed as a direct descendant, the existing feed will be replaced.
+   * @param cards - A static set of cards to  Each item in this Array should be a `Card`
+   *    descendant. If this parameter is null/undefined, all unexpired cards from the last news feed refresh will be
+   *    used automatically, a feed refresh will be kicked off automatically if the cached cards are more than 1 minute
+   *    old, and the feed will automatically update when new cards are received while it is still showing. If you
+   *    provide an explicit set of cards by using this parameter, no action will be taken when new cards are received,
+   *    and you must subscribe to feed updates yourself with `subscribeToFeedUpdates` and request updates with
+   *   `requestFeedRefresh` if you want to update this feed with new cards.
+   * @param allowedCategories - A set of categories to filter cards to. Each item in this Array should be a
+   *    card category as set in the Braze dashboard. If omitted, all cards will be displayed.
+   */
+  export function toggleFeed(
+    parentNode?: Element | null,
+    cards?: Card[] | null,
+    allowedCategories?: string[]
+  ): void;
 
   /**
    * When a user first uses Braze on a device they are considered "anonymous". Use this method to identify a user
@@ -1629,17 +1637,18 @@ declare namespace appboy {
    *    to target while logged out and switching back to that user ID as part of your app's logout process.
    *
    * @param userId - A unique identifier for this user. Limit 997 bytes.
+   *   These User IDs should be private and not easily guessable (e.g. not a plain email address or username).
    * @param signature - An encrypted signature to be used to authenticate the current user. You can update the signature
    *   using the `setSdkAuthenticationSignature` method. This signature will only have an effect if the `enableSdkAuthentication`
    *   initialization option is set to true.
    */
-  function changeUser(userId: string, signature?: string): void;
+  export function changeUser(userId: string, signature?: string): void;
 
   /**
-   * Destroys this appboy instance, destroying all subscription callbacks and releasing member variables which
+   * Destroys this `braze` instance, destroying all subscription callbacks and releasing member variables which
    *    retain memory.
    */
-  function destroy(): void;
+  export function destroy(): void;
 
   /**
    * Get all currently available cards from the last content cards refresh.
@@ -1647,7 +1656,7 @@ declare namespace appboy {
    * @returns - A `ContentCards` object which includes all currently available
    *    `Card` objects from the last content cards refresh.
    */
-  function getCachedContentCards(): appboy.ContentCards;
+  export function getCachedContentCards(): ContentCards;
 
   /**
    * Get all unexpired cards from the last news feed refresh.
@@ -1655,88 +1664,74 @@ declare namespace appboy {
    * @returns - A `Feed` object which includes all unexpired `Card` objects from the last
    *    news feed refresh.
    */
-  function getCachedFeed(): appboy.Feed;
+  export function getCachedFeed(): Feed;
 
   /**
    * Asynchronously retrieves the 'device id,' a randomly generated ID that is stored on the browser.
    *    This ID resets for private browsing sessions and when website data is cleared. For example:
    *
    * ```
-   * appboy.getDeviceId(function(deviceId) {
+   * braze.getDeviceId(function(deviceId) {
    *    console.log('The device id is ' + deviceId);
    * });
    * ```
    *
    * @param callback - Asynchronous callback - this will be invoked with the deviceId.
    */
-  function getDeviceId(callback: (deviceId: string) => void): void;
+  export function getDeviceId(callback: (deviceId: string) => void): void;
 
   /**
    * @returns The user currently being tracked by Braze, used for querying the tracked user id and setting
-   *    user attributes. Should only be accessed via the `getUser` function.
+   *    user attributes. Should only be accessed via the `getUser` function. Returns undefined if the
+   *    SDK has not been initialized.
    */
-  function getUser(): appboy.User;
+  export function getUser(): User | undefined;
 
   /**
-   * Initializes this `appboy` instance with your API key. This method must be called before other Braze methods are
+   * Initializes this `braze` instance with your API key. This method must be called before other Braze methods are
    *    invoked, and is part of the default loading snippets. Subsequent calls will be ignored until 'destroy`
    *    is called.
    *
    * @param apiKey - Your app's Braze API Key. Your API keys can be found
-   *    [here](https://dashboard.appboy.com/app_settings/app_settings).
+   *    [here](https://dashboard.braze.com/app_settings/app_settings).
    * @param options - Configuration options. See `InitializationOptions` for supported options.
    *
-   * @returns - Whether or not the `appboy` instance has been successfully initialized.
+   * @returns - Whether or not the `braze` instance has been successfully initialized.
    *    Reasons for returning false include a missing API key/base URL, user opt out, and ignored crawler bot activity.
    */
-  function initialize(apiKey: string, options: InitializationOptions): boolean;
+  export function initialize(apiKey: string, options: InitializationOptions): boolean;
 
   /**
    * @returns Whether or not the user has blocked push. If the user has blocked push, they cannot be
-   *      prompted to register again, and must manually remove the block in order to receive push.
-   */
-  function isPushBlocked(): boolean;
-
-  /**
-   * DEPRECATED - Tests whether the user has given this browser push permission (they may still be unsubscribed from
-   *    push via `User.setPushNotificationSubscriptionType`). A true value essentially means that
-   *    `appboy.registerAppboyPushMessages` may be called without the user being prompted. Useful for migrating existing
-   *    non-Braze push registrations to appboy.
-   *
-   * @deprecated This function inappropriately reports whether or not the browser *currently* has an active
-   *      registered push subscription, and does not answer the intended permissions question of whether the user has
-   *      granted the browser push permissions.
-   *      Please use `appboy.isPushPermissionGranted` instead. This WILL BE REMOVED.
-   *
-   * @param yesCallback - Invoked if the user has granted push access on this browser
-   * @param noCallback - Invoked if the user has not granted push access on this browser
+   *    prompted to register again, and must manually remove the block in order to receive push.
+   *    Returns undefined if the SDK has not been initialized.
    */
-  function isPushGranted(yesCallback: () => void, noCallback: () => void): void;
+  export function isPushBlocked(): boolean | undefined;
 
   /**
    * Tests whether the user has given this browser push permission (they may still be unsubscribed from push via
    *    `User.setPushNotificationSubscriptionType`). A true value essentially means that
-   *    `appboy.registerAppboyPushMessages` may be called without the
-   *    user being prompted. Useful for migrating existing non-Braze push registrations to appboy.
+   *    `requestPushPermission` may be called without the user being prompted. Useful for migrating existing
+   *    non-Braze push registrations to Braze.
    *
    * @returns Whether or not the user has granted push permission. If this returns true,
-   *    `appboy.registerAppboyPushMessages` may be called without the user being prompted. If this returns false,
-   *    `appboy.registerAppboyPushMessages` may prompt the user (if `appboy.isPushSupported` returns true) or do
-   *    nothing (if `appboy.isPushSupported` returns false)
+   *    `requestPushPermission` may be called without the user being prompted. If this returns false,
+   *    `requestPushPermission` may prompt the user (if `isPushSupported` returns true) or do
+   *    nothing (if `isPushSupported` returns false). Returns undefined if the SDK has not been initialized.
    */
-  function isPushPermissionGranted(): boolean;
+  export function isPushPermissionGranted(): boolean | undefined;
 
   /**
    * The [W3C Push API](https://developer.mozilla.org/en-US/docs/Web/API/Push_API) is partially supported
    *      across the browser landscape. This method allows you to programmatically determine whether push is supported
    *      in the current browser, and whether to show push-related user class elements to the user.
    *
-   * @returns Whether or not push is supported in this environment.
+   * @returns Whether or not push is supported in this environment. Returns undefined if the SDK has not been initialized.
    */
-  function isPushSupported(): boolean;
+  export function isPushSupported(): boolean | undefined;
 
   /**
-   * Logs that the user clicked the given card. This is done automatically when you use Appboy's display module
+   * Logs that the user clicked the given card. This is done automatically when you use Braze's display module
    *    and should only be called if you're bypassing that and manually building the DOM for displaying the cards in
    *    your own code.
    *
@@ -1745,10 +1740,10 @@ declare namespace appboy {
    *
    * @returns Whether or not the event was successfully logged (to be flushed later).
    */
-  function logCardClick(card: appboy.Card, forContentCards?: boolean): boolean;
+  export function logCardClick(card: Card, forContentCards?: boolean): boolean;
 
   /**
-   * Logs that the user dismissed the given card. This is done automatically when you use Appboy's display module
+   * Logs that the user dismissed the given card. This is done automatically when you use Braze's display module
    *    and should only be called if you're bypassing that and manually building the DOM for displaying the cards in
    *    your own code.
    *
@@ -1756,10 +1751,10 @@ declare namespace appboy {
    *
    * @returns Whether or not the event was successfully logged (to be flushed later).
    */
-  function logCardDismissal(card: appboy.Card): boolean;
+  export function logCardDismissal(card: Card): boolean;
 
   /**
-   * Logs that the user saw the given cards. This is done automatically when you use Appboy's display module
+   * Logs that the user saw the given cards. This is done automatically when you use Braze's display module
    *    and should only be called if you're bypassing that and manually building the DOM for displaying the cards in
    *    your own code.
    *
@@ -1768,25 +1763,23 @@ declare namespace appboy {
    *
    * @returns Whether or not the event was successfully logged (to be flushed later).
    */
-  function logCardImpressions(
-    cards: appboy.Card[],
+  export function logCardImpressions(
+    cards: Card[],
     forContentCards?: boolean
   ): boolean;
 
   /**
-   * Logs that the content cards were displayed. This is done automatically when you use Appboy's
-   *    display module and should only be called if you're bypassing that and manually building
+   * Logs that the content cards were displayed. This is done automatically when you use Braze's
+   *    UI and should only be called if you're bypassing that and manually building
    *    the class for displaying the cards in your own code.
    */
-  function logContentCardsDisplayed(): boolean;
+  export function logContentCardsDisplayed(): boolean;
 
   /**
    * Reports that the current user performed a custom named event.
    *
-   * @param eventName - The identifier for the event to track. Best practice is to track generic events
-   *      useful for segmenting, instead of specific user actions (i.e. track watched_sports_video instead of
-   *      watched_video_adrian_peterson_td_mnf). Value is limited to 255 characters in length, cannot begin with a $,
-   *      and can only contain alphanumeric characters and punctuation.
+   * @param eventName - The identifier for the event to track. Value is limited to 255 characters in length,
+   *      cannot begin with a $, and can only contain alphanumeric characters and punctuation.
    * @param eventProperties - Hash of properties for this event. Keys are limited to 255 characters in length, cannot begin
    *      with a $, and can only contain alphanumeric characters and punctuation. Values can be numeric, boolean, Date objects,
    *      strings 255 characters or shorter, or nested objects whose values can be numeric, boolean, Date objects, arrays, strings,
@@ -1794,18 +1787,18 @@ declare namespace appboy {
    *
    * @returns Whether or not the event was successfully logged (to be flushed later).
    */
-  function logCustomEvent(eventName: string, eventProperties?: object): boolean;
+  export function logCustomEvent(eventName: string, eventProperties?: object): boolean;
 
   /**
-   * Logs that the news feed was displayed. This is done automatically when you use Appboy's
-   *    display module and should only be called if you're bypassing that and manually building
+   * Logs that the news feed was displayed. This is done automatically when you use Braze's
+   *    UI and should only be called if you're bypassing that and manually building
    *    the class for displaying the cards in your own code.
    */
-  function logFeedDisplayed(): void;
+  export function logFeedDisplayed(): void;
 
   /**
    * Logs that the user clicked the given in-app message button. This is done automatically when the user clicks on
-   *    a button in a message generated by `display.showInAppMessage`,
+   *    a button in a message generated by `showInAppMessage`,
    *    and should only be called if you're bypassing that method and manually displaying the message in your own
    *    code.
    *
@@ -1814,25 +1807,25 @@ declare namespace appboy {
    *
    * @returns Whether or not the event was successfully logged (to be flushed later).
    */
-  function logInAppMessageButtonClick(
-    button: appboy.InAppMessageButton,
-    inAppMessage: appboy.InAppMessage
+  export function logInAppMessageButtonClick(
+    button: InAppMessageButton,
+    inAppMessage: InAppMessage
   ): boolean;
 
   /**
    * Logs that the user clicked the given in-app message. This is done automatically when the user clicks on a
-   *    message generated by `display.showInAppMessage`, and should
+   *    message generated by `showInAppMessage`, and should
    *    only be called if you're bypassing that method and manually displaying the message in your own code.
    *
    * @param inAppMessage
    *
    * @returns Whether or not the event was successfully logged (to be flushed later).
    */
-  function logInAppMessageClick(inAppMessage: appboy.InAppMessage): boolean;
+  export function logInAppMessageClick(inAppMessage: InAppMessage): boolean;
 
   /**
    * Logs that the user clicked on a link in an html in-app message. This is done automatically when the user clicks
-   *    on a message generated by `display.showInAppMessage`, and should
+   *    on a message generated by `showInAppMessage`, and should
    *    only be called if you're bypassing that method and manually displaying the message in your own code.
    *
    * @param inAppMessage - The message that was clicked
@@ -1841,22 +1834,22 @@ declare namespace appboy {
    *
    * @returns Whether or not the event was successfully logged (to be flushed later).
    */
-  function logInAppMessageHtmlClick(
-    inAppMessage: appboy.HtmlMessage,
+  export function logInAppMessageHtmlClick(
+    inAppMessage: HtmlMessage,
     buttonId?: string,
     url?: string
   ): boolean;
 
   /**
-   * Logs that the user saw the given in-app message. This is performed automatically when you use `display.showInAppMessage`,
+   * Logs that the user saw the given in-app message. This is performed automatically when you use `showInAppMessage`,
    *    and should only be called if you're bypassing that method and manually displaying the message in your own code.
    *
    * @param inAppMessage
    *
    * @returns Whether or not the event was successfully logged (to be flushed later).
    */
-  function logInAppMessageImpression(
-    inAppMessage: appboy.InAppMessage | appboy.ControlMessage
+  export function logInAppMessageImpression(
+    inAppMessage: InAppMessage | ControlMessage
   ): boolean;
 
   /**
@@ -1887,7 +1880,7 @@ declare namespace appboy {
    *
    * @returns Whether or not the purchase was successfully attached to the session (to be flushed later).
    */
-  function logPurchase(
+  export function logPurchase(
     productId: string,
     price: number,
     currencyCode?: string,
@@ -1900,12 +1893,12 @@ declare namespace appboy {
    *    When a new session is opened, syncs triggered In-App Messages and Content Cards. If the user has previously
    *    granted the site permission to send push, automatically sends the push registration to the Braze backend.
    */
-  function openSession(): void;
+  export function openSession(): void;
 
   /**
    * Register this browser environment to receive web push for this user. Supports browsers which implement the
    *      [W3C Push API](https://developer.mozilla.org/en-US/docs/Web/API/Push_API) (browsers in which
-   *      `appboy.isPushSupported` returns true). If push is supported and the user is not already subscribed,
+   *      `isPushSupported` returns true). If push is supported and the user is not already subscribed,
    *      this method will cause the browser to immediately request push permission from the user.
    *
    * In order to properly use this feature, there are some integration steps required on your end:
@@ -1914,10 +1907,10 @@ declare namespace appboy {
    * - Create a `service-worker.js` file with the content below and place it in the root directory of your website:
    *
    * ```
-   * self.importScripts('https://js.appboycdn.com/web-sdk-develop/3.4/service-worker.js');
+   * self.importScripts('https://js.appboycdn.com/web-sdk-develop/4.0/service-worker.js');
    * ```
    *
-   * For more details, see [Our Product Documentation](https://www.appboy.com/docs/developer_guide/platform_integration_guides/web/push_notifications/integration).
+   * For more details, see [Our Product Documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/push_notifications/integration).
    *
    * @param successCallback - When the user subscribes to push successfully this callback will be
    *    invoked with the user's endpoint, public key, and user auth key (endpoint, publicKey, userAuth).
@@ -1925,7 +1918,7 @@ declare namespace appboy {
    *    is temporary, it will be invoked with a parameter of `true` - otherwise it will be invoked with a parameter
    *    of `false`.
    */
-  function registerAppboyPushMessages(
+  export function requestPushPermission(
     successCallback?: (
       endpoint: string,
       publicKey: string,
@@ -1937,7 +1930,7 @@ declare namespace appboy {
   /**
    * Remove all event subscriptions.
    */
-  function removeAllSubscriptions(): void;
+  export function removeAllSubscriptions(): void;
 
   /**
    * Remove an event subscription that you previously subscribed to.
@@ -1945,10 +1938,10 @@ declare namespace appboy {
    * @param subscriptionGuid - The identifier of the subscription you wish to remove, returned by the method
    *    you initially used to create it.
    */
-  function removeSubscription(subscriptionGuid: string): void;
+  export function removeSubscription(subscriptionGuid: string): void;
 
   /**
-   * Requests an immediate refresh of content cards from Appboy servers. By default, content cards are refreshed when
+   * Requests an immediate refresh of content cards from Braze servers. By default, content cards are refreshed when
    *    a new session opens (see  'openSession` for more details), and when the user refreshes content cards manually via
    *    the refresh button. If you want to refresh content cards from the server at another time you must call this function.
    *
@@ -1957,16 +1950,16 @@ declare namespace appboy {
    *   a request has completed regardless of whether new cards were returned.
    * @param errorCallback - Callback that is invoked when an error occurs during the refresh.
    */
-  function requestContentCardsRefresh(successCallback?: () => void, errorCallback?: () => void): void;
+  export function requestContentCardsRefresh(successCallback?: () => void, errorCallback?: () => void): void;
 
   /**
    * Requests an immediate refresh of the news feed from Braze servers. By default, the news feed is refreshed on
-   *    `display.showFeed` (when stale - see
-   *    `display.showFeed` for details). If you want to refresh the feed from the
+   *    `showFeed` (when stale - see
+   *    `showFeed` for details). If you want to refresh the feed from the
    *    server at another time you must call this function. Results of this refresh are reported asynchronously to
    *    subscriptions created via  'subscribeToFeedUpdates` .
    */
-  function requestFeedRefresh(): void;
+  export function requestFeedRefresh(): void;
 
   /**
    * By default, data logged to Braze through the SDK is queued locally (in HTML 5 localStorage when available, and
@@ -1978,15 +1971,20 @@ declare namespace appboy {
    *    whether or not the flush was successful. If the flush is unsuccessful, pending data will be
    *    flushed during the next successful flush.
    */
-  function requestImmediateDataFlush(
+  export function requestImmediateDataFlush(
     callback?: (success: boolean) => void
   ): void;
 
   /**
-   * Removes the cookie set by `stopWebTracking`, causing subsequent calls to the Braze Web SDK to function. You must
+   * Removes the cookie set by `disableSDK`, causing subsequent calls to the Braze Web SDK to function. You must
    *    call `initialize` after calling this method before calling subsequent methods.
    */
-  function resumeWebTracking(): void;
+  export function enableSDK(): void;
+
+  /**
+   * Getter method to determine if the SDK is disabled based on whether the cookie set by `disableSdk` exists
+   */
+  export function isDisabled(): boolean;
 
   /**
    * By default, Braze logs to the browser console. Call this method to set a custom log action and enable debug-level log statements.
@@ -1994,7 +1992,7 @@ declare namespace appboy {
    * @param loggerFunction - A function to invoke with log messages. Should accept a single string
    *    parameter for message.
    */
-  function setLogger(loggerFunction: (message: string) => void): void;
+  export function setLogger(loggerFunction: (message: string) => void): void;
 
   /**
    * Sets the signature to be used to authenticate the current user. You can also set the signature when calling `changeUser`.
@@ -2004,7 +2002,16 @@ declare namespace appboy {
    *
    * @returns Whether or not the signature is valid.
    */
-  function setSdkAuthenticationSignature(signature: string): boolean;
+  export function setSdkAuthenticationSignature(signature: string): boolean;
+
+  /**
+   * Adds SDK Metadata. This method is automatically called based on the integration method.
+   *
+   * @param sdkMetadata - An array of metadata values from `BrazeSdkMetadata`.
+   *
+   * @returns Whether or not the array of metadata is valid.
+   */
+  export function addSdkMetadata(sdkMetadata: string[]): boolean;
 
   /**
    * Sets a cookie that causes all subsequent calls to the Braze Web SDK to be ignored
@@ -2012,10 +2019,11 @@ declare namespace appboy {
    * If you have multiple subdomains, this method MUST be called from the same subdomain that push was registered from to work properly.
    * This is useful for customer opt-outs. If the customer clears website data, tracking will resume.
    */
-  function stopWebTracking(): void;
+  export function disableSDK(): void;
 
   /**
-   * Subscribe to content cards updates. The subscriber callback will be called whenever content cards are updated.
+   * Subscribe to content cards updates. The subscriber callback will be called whenever content cards are updated. This method
+   *   should be called before calling `openSession`.
    *
    * @param subscriber - The callback function to handle new cards. This function will be called with a `ContentCards`
    *   object which includes all currently available `Card` objects. If you want to be notified when a refresh has completed
@@ -2023,8 +2031,8 @@ declare namespace appboy {
    *
    * @returns The identifier of the subscription created. This can be passed to `removeSubscription` to cancel the subscription.
    */
-  function subscribeToContentCardsUpdates(
-    subscriber: (cards: appboy.ContentCards) => void
+  export function subscribeToContentCardsUpdates(
+    subscriber: (cards: ContentCards) => void
   ): string;
 
   /**
@@ -2033,61 +2041,36 @@ declare namespace appboy {
    * @param subscriber - The callback function to handle new cards. This function will be
    *    called with a `Feed`object which includes all `Card` objects currently in the feed.
    *
-   * @returns The identifier of the subscription created. This can be passed to
-   *    `removeSubscription` to cancel the subscription.
+   * @returns The identifier of the subscription created. This can be passed to `removeSubscription` to cancel
+   *    the subscription. Returns undefined if the SDK has not been initialized.
    */
-  function subscribeToFeedUpdates(
-    subscriber: (feed: appboy.Feed) => void
-  ): string;
+  export function subscribeToFeedUpdates(
+    subscriber: (feed: Feed) => void
+  ): string | undefined;
 
   /**
    * Subscribe to receive in-app messages. The subscriber callback will be called whenever a new in-app message is
-   *    triggered. If you are using the build of Braze's library with UI, the most basic usage of this would be
+   *    triggered. This method should be called before calling `openSession`. If you are using the build of Braze's
+   *    library with UI, the most basic usage of this would be
+   *
    * ```
-   * appboy.subscribeToInAppMessage(function(inAppMessage) {
-   *   appboy.display.showInAppMessage(inAppMessage);
+   * braze.subscribeToInAppMessage(function(inAppMessage) {
+   *   braze.showInAppMessage(inAppMessage);
    * });
    * ```
    * @param callback - The callback function to handle the in-app message. This function will be
    *    called with an `InAppMessage` or a `ControlMessage` object. If you are using the build
-   *    of Braze's library with UI, you may wish to call `display.showInAppMessage`
+   *    of Braze's library with UI, you may wish to call `showInAppMessage`
    *    with the provided message.
    *
-   * @returns The identifier of the subscription created. This can be passed to
-   *    'removeSubscription` to cancel the subscription.
-   */
-  function subscribeToInAppMessage(
-    callback: (
-      inAppMessage: appboy.InAppMessage | appboy.ControlMessage
-    ) => void
-  ): string;
-
-  /**
-   * DEPRECATED - Subscribe to receive in-app messages. The subscriber callback will be called whenever new in-app messages are
-   *    triggered. If you are using the build of Braze's library with UI, the most basic usage of this would be
-   * ```
-   * appboy.subscribeToNewInAppMessages(function(inAppMessages) {
-   *   appboy.display.showInAppMessage(inAppMessages[0]);
-   *   return inAppMessages.slice(1);
-   * });
-   * ```
-   * @deprecated Since Web SDK 2.4.0, this function has been replaced by `appboy.subscribeToInAppMessage`,
-   *      which has a simpler interface. This function will be removed in a future release.
-   *
-   * @param subscriber - The callback function to handle new in-app messages. This function will be
-   *    called with an array of all currently unhandled `InAppMessage` or `ControlMessage` objects.
-   *    If you are using the build of Braze's library with UI, you may wish to call `display.showInAppMessage`
-   *    with one or more messages. This function should return an array of any messages that you wish to remain
-   *    unhandled and retained until the next time subscriber is called.
-   *
-   * @returns The identifier of the subscription created. This can be passed to
-   *    'removeSubscription` to cancel the subscription.
+   * @returns The identifier of the subscription created. This can be passed to 'removeSubscription` to cancel
+   *    the subscription. Returns undefined if the SDK has not been initialized.
    */
-  function subscribeToNewInAppMessages(
+  export function subscribeToInAppMessage(
     callback: (
-      inAppMessage: Array<appboy.InAppMessage | appboy.ControlMessage>
+      inAppMessage: InAppMessage | ControlMessage
     ) => void
-  ): string;
+  ): string | undefined;
 
   /**
    * Subscribe to be notified of network request failures that occured due to an SDK Authentication error. This
@@ -2098,33 +2081,23 @@ declare namespace appboy {
    *   invoked with an object containing the `errorCode`, `reason` for the error, the `userId` of the request (if the
    *   user is not anonymous), and the authentication `signature` that caused the error.
    *
-   * @returns The identifier of the subscription created. This can be passed to
-   *    'removeSubscription` to cancel the subscription.
+   * @returns The identifier of the subscription created. This can be passed to 'removeSubscription` to cancel
+   *    the subscription. Returns undefined if the SDK has not been initialized.
    */
-  function subscribeToSdkAuthenticationFailures(subscriber: (
+  export function subscribeToSdkAuthenticationFailures(subscriber: (
     error: {
       errorCode: string,
       reason?: string,
       userId?: string,
       signature?: string
     }
-  ) => void): string;
+  ) => void): string | undefined;
 
   /**
    * By default, Braze silences its logging to prevent spamming production js consoles. Call this method to
    *    toggle logging.
    */
-  function toggleAppboyLogging(): void;
-
-  /**
-   * Causes the Braze Web SDK to begin continuously collecting the user's location while your website is visible in
-   *    the foreground of their browser, for the duration of this page load. This will cause the browser to request
-   *    permission from the user if they have not already granted or denied it.
-   *
-   * @deprecated This method has been deprecated in favor of using the native [Geolocation API](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation_API)
-   *   and passing the location data to `User.setLastKnownLocation`.
-   */
-  function trackLocation(): void;
+  export function toggleLogging(): void;
 
   /**
    * Unregisters push notifications on this browser.
@@ -2135,7 +2108,7 @@ declare namespace appboy {
    *    callback will be invoked.
    * @param errorCallback - If the unsubscribe fails for unknown reasons, this callback will be invoked.
    */
-  function unregisterAppboyPushMessages(
+  export function unregisterPush(
     successCallback?: () => void,
     errorCallback?: () => void
   ): void;
@@ -2143,13 +2116,20 @@ declare namespace appboy {
   /**
    * Removes all locally stored SDK data, causing the user to be seen in subsequent calls as a new anonymous user on a new device.
    */
-  function wipeData(): void;
+  export function wipeData(): void;
+
+  /**
+   * Handle links from within a message. This method will redirect valid links, or will parse and handle valid Braze Click Actions (brazeActions://).
+   * @param url - a valid URL, or a valid brazeActions URL with scheme brazeActions://v{versionInt}/{base64string}
+   * @param openLinkInNewTab - Whether the URL should be opened in a new tab. Defaults to false.
+   */
+  export function handleBrazeAction(url: string, openLinkInNewTab?: boolean): void;
 
   /**
    * Supported initialization options
    *
    */
-  type InitializationOptions = {
+  export type InitializationOptions = {
     /**
      * By default, the Braze Web SDK ignores activity from known spiders or web crawlers, such as Google, based
      *   on the user agent string. This saves data points, makes analytics more accurate, and may improve page rank.
@@ -2171,7 +2151,7 @@ declare namespace appboy {
     /**
      * This option is required to configure the Braze Web SDK to use the appropriate endpoint for your integration - for example:
      *  ```
-     *    appboy.initialize('YOUR-API-KEY-HERE', { baseUrl: 'sdk.iad-03.appboy.com' })
+     *    braze.initialize('YOUR-API-KEY-HERE', { baseUrl: 'sdk.iad-03.braze.com' })
      *  ```
      */
     baseUrl: string;
@@ -2190,11 +2170,7 @@ declare namespace appboy {
      */
     devicePropertyAllowlist?: string[];
     /**
-     * @deprecated This initialization option is deprecated in favor of `devicePropertyAllowlist`, which has the same functionality.
-     */
-    devicePropertyWhitelist?: string[];
-    /**
-     * By default, users who have already granted web push permission (e.g. through `appboy.registerAppboyPushMessages` or from
+     * By default, users who have already granted web push permission (e.g. through `requestPushPermission` or from
      *   a prior push provider) will sync their push token with the Braze backend automatically on new session to ensure deliverability.
      *   To disable this behavior, set this option to true.
      */
@@ -2216,7 +2192,7 @@ declare namespace appboy {
     enableHtmlInAppMessages?: boolean;
     /**
      * Set to true to enable logging by default. Note that this will cause Braze to log to the javascript console, which is visible
-     *   to all users! You should probably remove this or provide an alternate logger with `appboy.setLogger` before you release
+     *   to all users! You should probably remove this or provide an alternate logger with `setLogger` before you release
      *   your page to production.
      */
     enableLogging?: boolean;
@@ -2226,8 +2202,8 @@ declare namespace appboy {
      */
     enableSdkAuthentication?: boolean
     /**
-     * By default, the Braze SDK will show In-App Messages with a z-index of 1040 for the screen overlay, 1050 for the actual in-app message,
-     *   and 1060 for the message's close button. Provide a value for this option to override these default z-indexes. The value provided
+     * By default, the Braze SDK will show In-App Messages with a z-index of 9001 for the screen overlay, 9011 for the actual in-app message,
+     *   and 9021 for the message's close button. Provide a value for this option to override these default z-indexes. The value provided
      *   will be used for the backdrop, `value + 1` will be used for the in-app message, and `value + 2` will be used for the close button.
      */
     inAppMessageZIndex?: number
@@ -2240,12 +2216,12 @@ declare namespace appboy {
      */
     localization?: string;
     /**
-     * By default, `appboy.registerAppboyPushMessages`/`appboy.unregisterAppboyPushMessages` assume that they control and can
+     * By default, `requestPushPermission`/`unregisterPush` assume that they control and can
      *   register and unregister the site's service worker. If you have your own service worker that you register and control the
      *   lifecycle of, set this option to true and the Braze SDK will not register or unregister a service worker. If you set this
      *   option to true, in order for push to function correctly you must register the service worker yourself BEFORE calling
-     *   `appboy.registerAppboyPushMessages`, and ensure that it contains Braze's service worker code, either with
-     *   `self.importScripts('https://js.appboycdn.com/web-sdk-develop/3.4/service-worker.js');` or by including the content
+     *   `requestPushPermission`, and ensure that it contains Braze's service worker code, either with
+     *   `self.importScripts('https://js.appboycdn.com/web-sdk-develop/4.0/service-worker.js');` or by including the content
      *   of that file directly. When this option is true, the `serviceWorkerLocation` option is irrelevant and is ignored.
      */
     manageServiceWorkerExternally?: boolean;
@@ -2288,7 +2264,7 @@ declare namespace appboy {
      *   root directory of your web server at `/service-worker.js`. If you want to host your service worker at a different path
      *   on that server, provide a value for this option that is the absolute path to the file, e.g. `/mycustompath/my-worker.js`.
      *   VERY IMPORTANT: setting a value here limits the scope of push notifications on your site. For instance, in the above
-     *   example, because the service worker file is located within the `/mycustompath/` directory, `appboy.registerAppboyPushMessages`
+     *   example, because the service worker file is located within the `/mycustompath/` directory, `requestPushPermission`
      *   MAY ONLY BE CALLED from web pages that start with `http://yoursite.com/mycustompath/`.
      */
     serviceWorkerLocation?: string;
@@ -2298,6 +2274,7 @@ declare namespace appboy {
      */
     sessionTimeoutInSeconds?: number;
   };
-}
 
-export default appboy;
+
+
+