@braze/web-sdk 4.8.3 → 4.10.0

package/index.d.ts

@@ -1,2425 +1,2601 @@
 /*
-* Type definitions for @braze/web-sdk v4.8.3
+* Type definitions for @braze/web-sdk v4.10.0
 * Project: https://github.com/braze-inc/braze-web-sdk
 * (c) Braze, Inc. 2023 - http://braze.com
 * License available at https://github.com/braze-inc/braze-web-sdk/blob/master/LICENSE
 */
 
-
-  /**
-   * Enum to represent the accepted SDK Metadata tags. See `addSdkMetadata` for more info.
-   *
-   * @readonly
-   * @enum {string}
-   */
-   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;
-  }
-
-  /**
+/* eslint-disable no-unused-vars, no-use-before-define */
+
+/**
+ * Enum to represent the accepted SDK Metadata tags. See `addSdkMetadata` for more info.
+ *
+ * @readonly
+ * @enum {string}
+ */
+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" */
-    static readonly BROWSER_VERSION: string;
-    /** The name of the operating system - e.g. "Android" */
-    static readonly OS: string;
-    /** The screen resolution of the device - e.g. "1024x768" */
-    static readonly RESOLUTION: string;
-    /** The language the browser is set to use - e.g. "en-us" */
-    static readonly LANGUAGE: string;
-    /** The time zone of the device - e.g. "America/New_York" */
-    static readonly TIME_ZONE: string;
-    /** The user agent string of the browser - see [this link](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent) for more info */
-    static readonly USER_AGENT: string;
-  }
-
-  /**
-   * Abstract base for news feed and Content Cards cards. Use subclasses `ClassicCard`, `CaptionedImage`,
-   *   `Banner`, and `ControlCard`.
-   */
-  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, 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;
-
-    /** Remove all event subscriptions from this message. */
-    removeAllSubscriptions(): void;
-
-    /**
-     * Remove an event subscription that you previously subscribed to.
-     *
-     * @param subscriptionGuid - The identifier of the subscription you wish to remove, returned by the method
-     *    you initially used to create it.
-     */
-    removeSubscription(subscriptionGuid: string): void;
-
-    /**
-     * Subscribe to receive click events. The subscriber callback will be called whenever this card is clicked by the
-     *    user.
-     *
-     * @param subscriber - The callback function to receive click events. This function will be invoked with
-     *    no arguments when this card records a click.
-     *
-     * @returns The identifier of the subscription created. This can be passed to `Card.removeSubscription`
-     *    to cancel the subscription. Returns null if the subscriber passed is not a function.
-     */
-    subscribeToClickedEvent(subscriber: () => void): string | null;
-
-    /**
-     * Subscribe to receive dismissed events. The subscriber callback will be called whenever this card is dismissed by the
-     *    user.
-     *
-     * @param subscriber - The callback function to receive dismissed events. This function will be invoked with
-     *    no arguments when this card records a dismissal.
-     *
-     * @returns The identifier of the subscription created. This can be passed to `Card.removeSubscription`
-     *    to cancel the subscription. Returns null if the subscriber passed is not a function.
-     */
-    subscribeToDismissedEvent(subscriber: () => void): string | null;
-
-    /** The id of the card. This will be reported back to Braze with events for analytics purposes. */
-    id?: 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" */
+  static readonly BROWSER_VERSION: string;
+  /** The name of the operating system - e.g. "Android" */
+  static readonly OS: string;
+  /** The screen resolution of the device - e.g. "1024x768" */
+  static readonly RESOLUTION: string;
+  /** The language the browser is set to use - e.g. "en-us" */
+  static readonly LANGUAGE: string;
+  /** The time zone of the device - e.g. "America/New_York" */
+  static readonly TIME_ZONE: string;
+  /** The user agent string of the browser - see [this link](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent) for more info */
+  static readonly USER_AGENT: string;
+}
+
+/**
+ * Abstract base for news feed and Content Cards cards. Use subclasses `ClassicCard`, `CaptionedImage`,
+ *   `ImageOnly`, and `ControlCard`.
+ */
+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, 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;
 
-    /** Whether this card has been shown to the user. */
-    viewed: boolean;
+  /** Remove all event subscriptions from this message. */
+  removeAllSubscriptions(): void;
 
-    /** When this card was last modified. */
-    updated: Date | null;
+  /**
+   * Remove an event subscription that you previously subscribed to.
+   *
+   * @param subscriptionGuid - The identifier of the subscription you wish to remove, returned by the method
+   *    you initially used to create it.
+   */
+  removeSubscription(subscriptionGuid: string): void;
 
-    /** When this card expires and should stop being shown to the user. */
-    expiresAt: Date | null;
+  /**
+   * Subscribe to receive click events. The subscriber callback will be called whenever this card is clicked by the
+   *    user.
+   *
+   * @param subscriber - The callback function to receive click events. This function will be invoked with
+   *    no arguments when this card records a click.
+   *
+   * @returns The identifier of the subscription created. This can be passed to `Card.removeSubscription`
+   *    to cancel the subscription. Returns null if the subscriber passed is not a function.
+   */
+  subscribeToClickedEvent(subscriber: () => void): string | null;
 
-    /** Object of string/string key/value pairs. Defaults to empty object {}. */
-    extras: Record<string, string>;
+  /**
+   * Subscribe to receive dismissed events. The subscriber callback will be called whenever this card is dismissed by the
+   *    user.
+   *
+   * @param subscriber - The callback function to receive dismissed events. This function will be invoked with
+   *    no arguments when this card records a dismissal.
+   *
+   * @returns The identifier of the subscription created. This can be passed to `Card.removeSubscription`
+   *    to cancel the subscription. Returns null if the subscriber passed is not a function.
+   */
+  subscribeToDismissedEvent(subscriber: () => void): string | null;
 
-    /** Whether to pin this card to the top of the view. */
-    pinned: boolean;
+  /** The id of the card. This will be reported back to Braze with events for analytics purposes. */
+  id?: string;
 
-    /** Whether this card is a ControlCard. */
-    isControl: boolean;
+  /** Whether this card has been shown to the user. */
+  viewed: boolean;
 
+  /** When this card was last modified. */
+  updated: Date | null;
 
-  }
+  /** When this card expires and should stop being shown to the user. */
+  expiresAt: Date | null;
 
-  export class Banner extends Card {
-    /**
-     * 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.
-     * @param imageUrl - The url for this card's image.
-     * @param created - When this card was created.
-     * @param updated - When this card was last modified.
-     * @param categories - Purely for organization in your custom implementation, these categories can be set in
-     *   the dashboard composer.
-     * @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. 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.
-     * @param clicked - Whether this card has ever been clicked on this device.
-     */
-    constructor(
-      id?: string,
-      viewed?: boolean,
-      imageUrl?: string,
-      created?: Date,
-      updated?: Date,
-      categories?: string[],
-      expiresAt?: Date,
-      url?: string,
-      linkText?: string,
-      aspectRatio?: number,
-      extras?: Record<string, string>,
-      pinned?: boolean,
-      dismissible?: boolean,
-      clicked?: boolean
-    );
-
-    /** The url for this card's image. */
-    imageUrl?: string;
-
-    /** When this card was created. */
-    created: Date | null;
+  /** Object of string/string key/value pairs. Defaults to empty object {}. */
+  extras: Record<string, string>;
 
-    /**
-     * Purely for organization in your custom implementation, these categories can be set in
-     *   the dashboard composer.
-     */
-    categories: string[];
+  /** Whether to pin this card to the top of the view. */
+  pinned: boolean;
 
-    /** A url to open when this card is clicked. */
-    url?: string;
+  /** Whether this card is a ControlCard. */
+  isControl: boolean;
 
-    /** The display text for the url. */
-    linkText?: string;
 
-    /**
-     * 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. */
-    dismissed: boolean;
+/**
+ * @deprecated This class has been deprecated in favor of `ImageOnly`.
+ */
+export class Banner extends Card {
+  /**
+   * 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.
+   * @param imageUrl - The url for this card's image.
+   * @param created - When this card was created.
+   * @param updated - When this card was last modified.
+   * @param categories - Purely for organization in your custom implementation, these categories can be set in
+   *   the dashboard composer.
+   * @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. 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.
+   * @param clicked - Whether this card has ever been clicked on this device.
+   */
+  constructor(
+    id?: string,
+    viewed?: boolean,
+    imageUrl?: string,
+    created?: Date,
+    updated?: Date,
+    categories?: string[],
+    expiresAt?: Date,
+    url?: string,
+    linkText?: string,
+    aspectRatio?: number,
+    extras?: Record<string, string>,
+    pinned?: boolean,
+    dismissible?: boolean,
+    clicked?: boolean,
+  );
+
+  /** The url for this card's image. */
+  imageUrl?: string;
+
+  /** When this card was created. */
+  created: Date | null;
 
-    /** Whether to allow the user to dismiss this card, removing it from the view. */
-    dismissible: boolean;
+  /**
+   * Purely for organization in your custom implementation, these categories can be set in
+   *   the dashboard composer.
+   */
+  categories: string[];
 
-    /** Whether this card has ever been clicked on this device. */
-    clicked: boolean;
-  }
+  /** A url to open when this card is clicked. */
+  url?: string;
 
-  export class CaptionedImage extends Card {
-    /**
-     * 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.
-     * @param title - The title text for this card.
-     * @param imageUrl - The url for this card's image.
-     * @param description - The body text for this card.
-     * @param created - When this card was created.
-     * @param updated - When this card was last modified.
-     * @param categories - Purely for organization in your custom implementation, these categories can be set in
-     *   the dashboard composer.
-     * @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. 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.
-     * @param clicked - Whether this card has ever been clicked on this device.
-     */
-    constructor(
-      id?: string,
-      viewed?: boolean,
-      title?: string,
-      imageUrl?: string,
-      description?: string,
-      created?: Date,
-      updated?: Date,
-      categories?: string[],
-      expiresAt?: Date,
-      url?: string,
-      linkText?: string,
-      aspectRatio?: number,
-      extras?: Record<string, string>,
-      pinned?: boolean,
-      dismissible?: boolean,
-      clicked?: boolean
-    );
-
-    /** The title text for this card. */
-    title: string;
-
-    /** The url for this card's image. */
-    imageUrl?: string;
-
-    /** The body text for this card. */
-    description: string;
-
-    /** When this card was created. */
-    created: Date | null;
+  /** The display text for the url. */
+  linkText?: string;
 
-    /**
-     * Purely for organization in your custom implementation, these categories can be set in
-     *   the dashboard composer.
-     */
-    categories: string[];
+  /**
+   * 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;
 
-    /** A url to open when this card is clicked. */
-    url?: string;
+  /** Whether this card has been dismissed. */
+  dismissed: boolean;
 
-    /** The display text for the url. */
-    linkText?: string;
+  /** Whether to allow the user to dismiss this card, removing it from the view. */
+  dismissible: boolean;
 
-    /**
-     * 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 ever been clicked on this device. */
+  clicked: boolean;
+}
 
-    /** Whether this card has been dismissed. */
-    dismissed: boolean;
+export class ImageOnly extends Card {
+  /**
+   * 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.
+   * @param imageUrl - The url for this card's image.
+   * @param created - When this card was created.
+   * @param updated - When this card was last modified.
+   * @param categories - Purely for organization in your custom implementation, these categories can be set in
+   *   the dashboard composer.
+   * @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. 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.
+   * @param clicked - Whether this card has ever been clicked on this device.
+   */
+  constructor(
+    id?: string,
+    viewed?: boolean,
+    imageUrl?: string,
+    created?: Date,
+    updated?: Date,
+    categories?: string[],
+    expiresAt?: Date,
+    url?: string,
+    linkText?: string,
+    aspectRatio?: number,
+    extras?: Record<string, string>,
+    pinned?: boolean,
+    dismissible?: boolean,
+    clicked?: boolean,
+  );
+
+  /** The url for this card's image. */
+  imageUrl?: string;
+
+  /** When this card was created. */
+  created: Date | null;
 
-    /** Whether to allow the user to dismiss this card, removing it from the view. */
-    dismissible: boolean;
+  /**
+   * Purely for organization in your custom implementation, these categories can be set in
+   *   the dashboard composer.
+   */
+  categories: string[];
 
-    /** Whether this card has ever been clicked on this device. */
-    clicked: boolean;
-  }
+  /** A url to open when this card is clicked. */
+  url?: string;
 
-  export class ClassicCard extends Card {
-    /**
-     * A card with a title, body, and optionally a small 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.
-     * @param title - The title text for this card.
-     * @param imageUrl - The url for this card's image.
-     * @param description - The body text for this card.
-     * @param created - When this card was created.
-     * @param updated - When this card was last modified.
-     * @param categories - Purely for organization in your custom implementation, these categories can be set in
-     *   the dashboard composer.
-     * @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. 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.
-     * @param clicked - Whether this card has ever been clicked on this device.
-     */
-    constructor(
-      id?: string,
-      viewed?: boolean,
-      title?: string,
-      imageUrl?: string,
-      description?: string,
-      created?: Date,
-      updated?: Date,
-      categories?: string[],
-      expiresAt?: Date,
-      url?: string,
-      linkText?: string,
-      aspectRatio?: number,
-      extras?: Record<string, string>,
-      pinned?: boolean,
-      dismissible?: boolean,
-      clicked?: boolean
-    );
-
-    /** The title text for this card. */
-    title: string;
-
-    /** The url for this card's image. */
-    imageUrl?: string;
-
-    /** The body text for this card. */
-    description: string;
-
-    /** When this card was created. */
-    created: Date | null;
+  /** The display text for the url. */
+  linkText?: string;
 
-    /**
-     * Purely for organization in your custom implementation, these categories can be set in
-     *   the dashboard composer.
-     */
-    categories: string[];
+  /**
+   * 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;
 
-    /** A url to open when this card is clicked. */
-    url?: string;
+  /** Whether this card has been dismissed. */
+  dismissed: boolean;
 
-    /** The display text for the url. */
-    linkText?: string;
+  /** Whether to allow the user to dismiss this card, removing it from the view. */
+  dismissible: boolean;
 
-    /**
-     * 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 ever been clicked on this device. */
+  clicked: boolean;
+}
 
-    /** Whether this card has been dismissed. */
-    dismissed: boolean;
+export class CaptionedImage extends Card {
+  /**
+   * 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.
+   * @param title - The title text for this card.
+   * @param imageUrl - The url for this card's image.
+   * @param description - The body text for this card.
+   * @param created - When this card was created.
+   * @param updated - When this card was last modified.
+   * @param categories - Purely for organization in your custom implementation, these categories can be set in
+   *   the dashboard composer.
+   * @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. 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.
+   * @param clicked - Whether this card has ever been clicked on this device.
+   */
+  constructor(
+    id?: string,
+    viewed?: boolean,
+    title?: string,
+    imageUrl?: string,
+    description?: string,
+    created?: Date,
+    updated?: Date,
+    categories?: string[],
+    expiresAt?: Date,
+    url?: string,
+    linkText?: string,
+    aspectRatio?: number,
+    extras?: Record<string, string>,
+    pinned?: boolean,
+    dismissible?: boolean,
+    clicked?: boolean,
+  );
+
+  /** The title text for this card. */
+  title: string;
+
+  /** The url for this card's image. */
+  imageUrl?: string;
+
+  /** The body text for this card. */
+  description: string;
+
+  /** When this card was created. */
+  created: Date | null;
 
-    /** Whether to allow the user to dismiss this card, removing it from the view. */
-    dismissible: boolean;
+  /**
+   * Purely for organization in your custom implementation, these categories can be set in
+   *   the dashboard composer.
+   */
+  categories: string[];
 
-    /** Whether this card has ever been clicked on this device. */
-    clicked: boolean;
-  }
+  /** A url to open when this card is clicked. */
+  url?: string;
 
-  export class ControlCard extends Card {
-    /**
-     * A card with no display that logs impressions, which can be passed to
-     *    `showFeed` or handled manually.
-     *    Not supported in legacy news feed.
-     *    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.
-     * @param updated - When this card was last modified.
-     * @param expiresAt - When this card expires and should stop being shown to the user.
-     * @param extras - Object of string/string key/value pairs.
-     * @param pinned - Whether to pin this card to the top of the view.
-     */
-    constructor(
-      id?: string,
-      viewed?: boolean,
-      updated?: Date,
-      expiresAt?: Date,
-      extras?: Record<string, string>,
-      pinned?: boolean
-    );
-
-    /** Whether this card is a ControlCard. */
-    isControl: true;
-  }
-
-  export class ContentCards {
-    /**
-     *  A collection of `Card` descendents (`ClassicCard`, `CaptionedImage`, `Banner`).
-     *    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
-     *    `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 Braze servers. If null, it means the
-     *    content cards are still being fetched for this user.
-     */
-    constructor(cards: Card[], lastUpdated: Date | null);
+  /** The display text for the url. */
+  linkText?: string;
 
-    /** Array of `Card` descendents (`ClassicCard`, `CaptionedImage`, `Banner`). */
-    cards: Card[];
+  /**
+   * 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;
 
-    /**
-     * 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;
+  /** Whether this card has been dismissed. */
+  dismissed: boolean;
 
-    /**
-     * Get the current unviewed card count. This is useful for powering badges on your control for showing the content cards.
-     *    `ControlCard` cards do not count towards the unviewed count.
-     */
-    getUnviewedCardCount(): number;
-  }
+  /** Whether to allow the user to dismiss this card, removing it from the view. */
+  dismissible: boolean;
 
-  export class Feed {
-    /**
-     *  A collection of `Card` descendents (`ClassicCard`, `CaptionedImage`, `Banner`).
-     *    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 `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.
-     */
-    constructor(cards: Card[], lastUpdated: Date | null);
+  /** Whether this card has ever been clicked on this device. */
+  clicked: boolean;
+}
 
-    /**
-     * Array of `Card` descendents (`ClassicCard`, `CaptionedImage`, `Banner`).
-     *    Can be passed directly to `showFeed`.
-     */
-    cards: Card[];
+export class ClassicCard extends Card {
+  /**
+   * A card with a title, body, and optionally a small 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.
+   * @param title - The title text for this card.
+   * @param imageUrl - The url for this card's image.
+   * @param description - The body text for this card.
+   * @param created - When this card was created.
+   * @param updated - When this card was last modified.
+   * @param categories - Purely for organization in your custom implementation, these categories can be set in
+   *   the dashboard composer.
+   * @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. 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.
+   * @param clicked - Whether this card has ever been clicked on this device.
+   */
+  constructor(
+    id?: string,
+    viewed?: boolean,
+    title?: string,
+    imageUrl?: string,
+    description?: string,
+    created?: Date,
+    updated?: Date,
+    categories?: string[],
+    expiresAt?: Date,
+    url?: string,
+    linkText?: string,
+    aspectRatio?: number,
+    extras?: Record<string, string>,
+    pinned?: boolean,
+    dismissible?: boolean,
+    clicked?: boolean,
+  );
+
+  /** The title text for this card. */
+  title: string;
+
+  /** The url for this card's image. */
+  imageUrl?: string;
+
+  /** The body text for this card. */
+  description: string;
+
+  /** When this card was created. */
+  created: Date | null;
 
-    /**
-     * 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;
+  /**
+   * Purely for organization in your custom implementation, these categories can be set in
+   *   the dashboard composer.
+   */
+  categories: string[];
 
-    /**
-     * 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 `showFeed` or `requestFeedRefresh`. `ControlCard` cards do not count towards the
-     *    unread count.
-     */
-    getUnreadCardCount(): number;
-  }
+  /** A url to open when this card is clicked. */
+  url?: string;
 
-  export class ControlMessage {
-    /**
-     *  A non-showing message placeholder that represents this user receiving the the control for a multivariate
-     *    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
-     *   Braze with in-app message analytics events.
-     */
-    constructor(triggerId?: string);
+  /** The display text for the url. */
+  linkText?: string;
 
-    /**
-     * The id of the trigger that created this message. The SDK will report back this to
-     *   Braze with in-app message analytics events.
-     */
-    triggerId?: string;
+  /**
+   * 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;
 
-    /** Object of string/string key/value pairs. */
-    extras: Record<string, string>;
+  /** Whether this card has been dismissed. */
+  dismissed: boolean;
 
-    /** Whether this message is a ControlMessage. */
-    isControl: true;
-  }
+  /** Whether to allow the user to dismiss this card, removing it from the view. */
+  dismissible: boolean;
 
-  
-  type SlideFrom = typeof InAppMessage.SlideFrom[keyof typeof InAppMessage.SlideFrom];
+  /** Whether this card has ever been clicked on this device. */
+  clicked: boolean;
+}
 
-  
-  type ClickAction = typeof InAppMessage.ClickAction[keyof typeof InAppMessage.ClickAction];
+export class ControlCard extends Card {
+  /**
+   * A card with no display that logs impressions, which can be passed to
+   *    `showFeed` or handled manually.
+   *    Not supported in legacy news feed.
+   *    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.
+   * @param updated - When this card was last modified.
+   * @param expiresAt - When this card expires and should stop being shown to the user.
+   * @param extras - Object of string/string key/value pairs.
+   * @param pinned - Whether to pin this card to the top of the view.
+   */
+  constructor(
+    id?: string,
+    viewed?: boolean,
+    updated?: Date,
+    expiresAt?: Date,
+    extras?: Record<string, string>,
+    pinned?: boolean,
+  );
+
+  /** Whether this card is a ControlCard. */
+  isControl: true;
+}
+
+export class ContentCards {
+  /**
+   *  A collection of `Card` descendents (`ClassicCard`, `CaptionedImage`, `Banner`).
+   *    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
+   *    `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 Braze servers. If null, it means the
+   *    content cards are still being fetched for this user.
+   */
+  constructor(cards: Card[], lastUpdated: Date | null);
 
-  
-  type DismissType = typeof InAppMessage.DismissType[keyof typeof InAppMessage.DismissType];
+  /** Array of `Card` descendents (`ClassicCard`, `CaptionedImage`, `Banner`). */
+  cards: Card[];
 
-  
-  type OpenTarget = typeof InAppMessage.OpenTarget[keyof typeof InAppMessage.OpenTarget];
+  /**
+   * 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;
 
-  
-  type ImageStyle = typeof InAppMessage.ImageStyle[keyof typeof InAppMessage.ImageStyle];
+  /**
+   * Get the current unviewed card count. This is useful for powering badges on your control for showing the content cards.
+   *    `ControlCard` cards do not count towards the unviewed count.
+   */
+  getUnviewedCardCount(): number;
+}
 
-  
-  type Orientation = typeof InAppMessage.Orientation[keyof typeof InAppMessage.Orientation];
+export class Feed {
+  /**
+   *  A collection of `Card` descendents (`ClassicCard`, `CaptionedImage`, `Banner`).
+   *    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 `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.
+   */
+  constructor(cards: Card[], lastUpdated: Date | null);
 
-  
-  type TextAlignment = typeof InAppMessage.TextAlignment[keyof typeof InAppMessage.TextAlignment];
+  /**
+   * Array of `Card` descendents (`ClassicCard`, `CaptionedImage`, `Banner`).
+   *    Can be passed directly to `showFeed`.
+   */
+  cards: Card[];
 
-  
-  type CropType = typeof InAppMessage.CropType[keyof typeof InAppMessage.CropType];
+  /**
+   * 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;
 
   /**
-   *  Abstract base for in-app messages. Use subclasses `SlideUpMessage`,
-   *    `ModalMessage`, `FullScreenMessage`, and `HtmlMessage`.
+   * 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 `showFeed` or `requestFeedRefresh`. `ControlCard` cards do not count towards the
+   *    unread count.
    */
-  export class InAppMessage {
-    static SlideFrom: {
-      TOP: "TOP";
-      BOTTOM: "BOTTOM";
-    };
+  getUnreadCardCount(): number;
+}
 
-    static ClickAction: {
-      NEWS_FEED: "NEWS_FEED";
-      URI: "URI";
-      NONE: "NONE";
-    };
+export class ControlMessage {
+  /**
+   *  A non-showing message placeholder that represents this user receiving the the control for a multivariate
+   *    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
+   *   Braze with in-app message analytics events.
+   */
+  constructor(triggerId?: string);
 
-    static DismissType: {
-      AUTO_DISMISS: "AUTO_DISMISS";
-      MANUAL: "SWIPE";
-    };
+  /**
+   * The id of the trigger that created this message. The SDK will report back this to
+   *   Braze with in-app message analytics events.
+   */
+  triggerId?: string;
 
-    static OpenTarget: {
-      NONE: "NONE";
-      BLANK: "BLANK";
-    };
+  /** Object of string/string key/value pairs. */
+  extras: Record<string, string>;
 
-    static ImageStyle: {
-      TOP: "TOP";
-      GRAPHIC: "GRAPHIC";
-    };
+  /** Whether this message is a ControlMessage. */
+  isControl: true;
+}
 
-    static Orientation: {
-      PORTRAIT: "PORTRAIT";
-      LANDSCAPE: "LANDSCAPE";
-    };
 
-    static TextAlignment: {
-      START: "START";
-      CENTER: "CENTER";
-      END: "END";
-    };
+type SlideFrom =
+  (typeof InAppMessage.SlideFrom)[keyof typeof InAppMessage.SlideFrom];
 
-    static CropType: {
-      /**
-       * Centers the image in the available space and crops any overflowing edges.
-       */
-      CENTER_CROP: "CENTER_CROP";
 
-      /**
-       * Fits the image within the available space, causing blank space on the shorter
-       *    axis (e.g. tall images will have bars of blank space on the left/right)
-       */
-      FIT_CENTER: "FIT_CENTER";
-    };
+type ClickAction =
+  (typeof InAppMessage.ClickAction)[keyof typeof InAppMessage.ClickAction];
 
-    /** The message to display to the user. */
-    message?: string;
 
-    /** Object of string/string key/value pairs. */
-    extras: Record<string, string>;
+type DismissType =
+  (typeof InAppMessage.DismissType)[keyof typeof InAppMessage.DismissType];
 
-    /**
-     * The id of the trigger that created this message. The SDK will report back this to
-     *    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 `DismissType` enum.
-     */
-    dismissType: DismissType;
+type OpenTarget =
+  (typeof InAppMessage.OpenTarget)[keyof typeof InAppMessage.OpenTarget];
 
-    /**
-     * Length of time in milliseconds until auto-dismiss should occur. Only used when
-     *   dismissType is `DismissType`.AUTO_DISMISS
-     */
-    duration: number;
 
-    /** Whether to animate the showing of this message. */
-    animateIn: boolean;
+type ImageStyle =
+  (typeof InAppMessage.ImageStyle)[keyof typeof InAppMessage.ImageStyle];
 
-    /** Whether to animate the hiding of this message. */
-    animateOut: boolean;
 
-    /** The ID to give the parent HTML element that this message is rendered into. */
-    htmlId?: string;
+type Orientation =
+  (typeof InAppMessage.Orientation)[keyof typeof InAppMessage.Orientation];
 
-    /**
-     * 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.
-     */
-    css?: string;
 
-    /** Whether this message is a ControlMessage. */
-    isControl: false;
+type TextAlignment =
+  (typeof InAppMessage.TextAlignment)[keyof typeof InAppMessage.TextAlignment];
 
-    /**
-     * Call this method if you wish to programmatically remove the message from the DOM. This method will only
-     *   work with the Braze UI.
-     */
-    closeMessage(): void;
 
-    /** Remove all event subscriptions from this message. */
-    removeAllSubscriptions(): void;
-
-    /**
-     * Remove an event subscription that you previously subscribed to.
-     *
-     * @param subscriptionGuid - The identifier of the subscription you wish to remove, returned by the method
-     *    you initially used to create it.
-     */
-    removeSubscription(subscriptionGuid: string): void;
-
-    /**
-     * Subscribe to receive click events. The subscriber callback will be called whenever this message is clicked by the
-     *    user.
-     *
-     * @param subscriber - The callback function to receive click events. This function will be invoked with
-     *    no arguments when this message records a click.
-     *
-     * @returns The identifier of the subscription created. This can be passed to `removeSubscription`
-     *    to cancel the subscription. Returns null if the subscriber passed is not a function.
-     */
-    subscribeToClickedEvent(subscriber: () => void): string | null;
-
-    /**
-     * Subscribe to receive dismissed events. The subscriber callback will be called whenever this message is closed
-     *    by the user, or when it's dismissed automatically (depending on the dismissType).
-     *
-     * @param subscriber - The callback function to receive dismissed events. This function will be invoked with
-     *    no arguments when this message records a dismissal.
-     *
-     * @returns The identifier of the subscription created. This can be passed to `removeSubscription`
-     *    to cancel the subscription. Returns null if the subscriber passed is not a function.
-     */
-    subscribeToDismissedEvent(subscriber: () => void): string | null;
+type CropType =
+  (typeof InAppMessage.CropType)[keyof typeof InAppMessage.CropType];
 
+/**
+ *  Abstract base for in-app messages. Use subclasses `SlideUpMessage`,
+ *    `ModalMessage`, `FullScreenMessage`, and `HtmlMessage`.
+ */
+export class InAppMessage {
+  static SlideFrom: {
+    TOP: "TOP";
+    BOTTOM: "BOTTOM";
+  };
 
-  }
+  static ClickAction: {
+    NEWS_FEED: "NEWS_FEED";
+    URI: "URI";
+    NONE: "NONE";
+  };
 
-  export class FullScreenMessage extends InAppMessage {
-    /**
-     *  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 `TextAlignment` enum.
-     * @param extras - Object of string/string key/value pairs.
-     * @param triggerId - The id of the trigger that created this message. The SDK will report back this to
-     *    Braze with in-app message analytics events.
-     * @param clickAction - Where the user should be brought when clicking on this message. See 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 `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 `DismissType` enum.
-     * @param duration - Length of time in milliseconds until auto-dismiss should occur. Only used when
-     *    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 `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).
-     * @param backgroundColor - Background color of entire message. Hex value with opacity (e.g.
-     *    0xff00ff00 is opaque green).
-     * @param textColor - Text color of message. Hex value with opacity (e.g. 0xff00ff00 is opaque
-     *    green).
-     * @param closeButtonColor - Color of close button. Hex value with opacity (e.g. 0xff00ff00 is
-     *    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
-     * @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 `CropType` enum.
-     * @param orientation - Whether to lay out this in-app message as a portrait or landscape. See the
-     *    `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?: TextAlignment,
-      extras?: Record<string, string>,
-      triggerId?: string,
-      clickAction?: ClickAction,
-      uri?: string,
-      openTarget?: OpenTarget,
-      dismissType?: DismissType,
-      duration?: number,
-      icon?: string,
-      imageUrl?: string,
-      imageStyle?: ImageStyle,
-      iconColor?: number,
-      iconBackgroundColor?: number,
-      backgroundColor?: number,
-      textColor?: number,
-      closeButtonColor?: number,
-      animateIn?: boolean,
-      animateOut?: boolean,
-      header?: string,
-      headerAlignment?: TextAlignment,
-      headerTextColor?: number,
-      frameColor?: number,
-      buttons?: InAppMessageButton[],
-      cropType?: CropType,
-      orientation?: Orientation,
-      htmlId?: string,
-      css?: string
-    );
-
-    /** How to align message text. See the `TextAlignment` enum. */
-    messageAlignment: TextAlignment;
+  static DismissType: {
+    AUTO_DISMISS: "AUTO_DISMISS";
+    MANUAL: "SWIPE";
+  };
 
-    /**
-     * Where the user should be brought when clicking on this message. See the
-     *    `ClickAction` enum.
-     */
-    clickAction: ClickAction;
+  static OpenTarget: {
+    NONE: "NONE";
+    BLANK: "BLANK";
+  };
 
-    /**
-     * If ```clickAction``` is `ClickAction`.URI, the URI to follow when the
-     *    user clicks on this message.
-     */
-    uri?: string;
+  static ImageStyle: {
+    TOP: "TOP";
+    GRAPHIC: "GRAPHIC";
+  };
 
-    /**
-     * If ```clickAction``` is `ClickAction`.URI, whether to open clicks
-     *    in a new tab/window. See the `OpenTarget` enum.
-     */
-    openTarget: OpenTarget;
+  static Orientation: {
+    PORTRAIT: "PORTRAIT";
+    LANDSCAPE: "LANDSCAPE";
+  };
 
-    /**
-     * 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.
-     */
-    icon?: string;
+  static TextAlignment: {
+    START: "START";
+    CENTER: "CENTER";
+    END: "END";
+  };
 
+  static CropType: {
     /**
-     * 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.
+     * Centers the image in the available space and crops any overflowing edges.
      */
-    imageUrl?: string;
+    CENTER_CROP: "CENTER_CROP";
 
     /**
-     * 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 `ImageStyle` enum.
+     * Fits the image within the available space, causing blank space on the shorter
+     *    axis (e.g. tall images will have bars of blank space on the left/right)
      */
-    imageStyle: ImageStyle;
-
-    /** Color of icon. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
-    iconColor: number;
-
-    /** Background color of icon. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
-    iconBackgroundColor: number;
-
-    /** Background color of entire message. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
-    backgroundColor: number;
-
-    /** Text color of message. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
-    textColor: number;
-
-    /** Color of close button. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
-    closeButtonColor: number;
-
-    /** Header text to  */
-    header?: string;
+    FIT_CENTER: "FIT_CENTER";
+  };
 
-    /** How to align header text. See the `TextAlignment` enum. */
-    headerAlignment: TextAlignment;
+  /** The message to display to the user. */
+  message?: string;
 
-    /** Color of header text. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
-    headerTextColor: number;
+  /** Object of string/string key/value pairs. */
+  extras: Record<string, string>;
 
-    /** Color of the background frame which blocks page interaction while the message is showing. */
-    frameColor: number;
+  /**
+   * The id of the trigger that created this message. The SDK will report back this to
+   *    Braze with in-app message analytics events.
+   */
+  triggerId?: string;
 
-    /** Array of up to two `InAppMessageButton` objects. */
-    buttons: InAppMessageButton[];
+  /**
+   * How the message is dismissed, via a timer or requiring interaction from the user.
+   *    See the `DismissType` enum.
+   */
+  dismissType: DismissType;
 
-    /** How to crop and fit images in the allowable space. See the `CropType` enum. */
-    cropType: CropType;
+  /**
+   * Length of time in milliseconds until auto-dismiss should occur. Only used when
+   *   dismissType is `DismissType`.AUTO_DISMISS
+   */
+  duration: number;
 
-    /**
-     * Whether to lay out this in-app message as a portrait or landscape. See the
-     *    `Orientation` enum.
-     */
-    orientation: Orientation;
-  }
+  /** Whether to animate the showing of this message. */
+  animateIn: boolean;
 
-  export class ModalMessage extends InAppMessage {
-    /**
-     *  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 `TextAlignment` enum.
-     * @param extras - Object of string/string key/value pairs.
-     * @param triggerId - The id of the trigger that created this message. The SDK will report back this to
-     *    Braze with in-app message analytics events.
-     * @param clickAction - Where the user should be brought when clicking on this message. See 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 `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 `DismissType` enum.
-     * @param duration - Length of time in milliseconds until auto-dismiss should occur. Only used when
-     *    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 `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).
-     * @param backgroundColor - Background color of entire message. Hex value with opacity (e.g.
-     *    0xff00ff00 is opaque green).
-     * @param textColor - Text color of message. Hex value with opacity (e.g. 0xff00ff00 is opaque
-     *    green).
-     * @param closeButtonColor - Color of close button. Hex value with opacity (e.g. 0xff00ff00 is
-     *    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
-     * @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 `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?: TextAlignment,
-      extras?: Record<string, string>,
-      triggerId?: string,
-      clickAction?: ClickAction,
-      uri?: string,
-      openTarget?: OpenTarget,
-      dismissType?: DismissType,
-      duration?: number,
-      icon?: string,
-      imageUrl?: string,
-      imageStyle?: ImageStyle,
-      iconColor?: number,
-      iconBackgroundColor?: number,
-      backgroundColor?: number,
-      textColor?: number,
-      closeButtonColor?: number,
-      animateIn?: boolean,
-      animateOut?: boolean,
-      header?: string,
-      headerAlignment?: TextAlignment,
-      headerTextColor?: number,
-      frameColor?: number,
-      buttons?: InAppMessageButton[],
-      cropType?: CropType,
-      htmlId?: string,
-      css?: string
-    );
-
-    /** How to align message text. See the `TextAlignment` enum. */
-    messageAlignment: TextAlignment;
+  /** Whether to animate the hiding of this message. */
+  animateOut: boolean;
 
-    /**
-     * Where the user should be brought when clicking on this message. See the
-     *    `ClickAction` enum.
-     */
-    clickAction: ClickAction;
+  /** The ID to give the parent HTML element that this message is rendered into. */
+  htmlId?: string;
 
-    /**
-     * If ```clickAction``` is `ClickAction`.URI, the URI to follow when the
-     *    user clicks on this message.
-     */
-    uri?: string;
-
-    /**
-     * If ```clickAction``` is `ClickAction`.URI, whether to open clicks
-     *    in a new tab/window. See the `OpenTarget` enum.
-     */
-    openTarget: OpenTarget;
+  /**
+   * 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.
+   */
+  css?: string;
 
-    /**
-     * 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.
-     */
-    icon?: string;
+  /** Whether this message is a ControlMessage. */
+  isControl: false;
 
-    /**
-     * 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.
-     */
-    imageUrl?: string;
-
-    /**
-     * 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 `ImageStyle` enum.
-     */
-    imageStyle: ImageStyle;
+  /**
+   * Call this method if you wish to programmatically remove the message from the DOM. This method will only
+   *   work with the Braze UI.
+   */
+  closeMessage(): void;
 
-    /** Color of icon. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
-    iconColor: number;
+  /** Remove all event subscriptions from this message. */
+  removeAllSubscriptions(): void;
 
-    /** Background color of icon. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
-    iconBackgroundColor: number;
+  /**
+   * Remove an event subscription that you previously subscribed to.
+   *
+   * @param subscriptionGuid - The identifier of the subscription you wish to remove, returned by the method
+   *    you initially used to create it.
+   */
+  removeSubscription(subscriptionGuid: string): void;
 
-    /** Background color of entire message. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
-    backgroundColor: number;
+  /**
+   * Subscribe to receive click events. The subscriber callback will be called whenever this message is clicked by the
+   *    user.
+   *
+   * @param subscriber - The callback function to receive click events. This function will be invoked with
+   *    no arguments when this message records a click.
+   *
+   * @returns The identifier of the subscription created. This can be passed to `removeSubscription`
+   *    to cancel the subscription. Returns null if the subscriber passed is not a function.
+   */
+  subscribeToClickedEvent(subscriber: () => void): string | null;
 
-    /** Text color of message. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
-    textColor: number;
+  /**
+   * Subscribe to receive dismissed events. The subscriber callback will be called whenever this message is closed
+   *    by the user, or when it's dismissed automatically (depending on the dismissType).
+   *
+   * @param subscriber - The callback function to receive dismissed events. This function will be invoked with
+   *    no arguments when this message records a dismissal.
+   *
+   * @returns The identifier of the subscription created. This can be passed to `removeSubscription`
+   *    to cancel the subscription. Returns null if the subscriber passed is not a function.
+   */
+  subscribeToDismissedEvent(subscriber: () => void): string | null;
 
-    /** Color of close button. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
-    closeButtonColor: number;
 
-    /** Header text to  */
-    header?: string;
+}
 
-    /** How to align header text. See the `TextAlignment` enum. */
-    headerAlignment: TextAlignment;
+export class FullScreenMessage extends InAppMessage {
+  /**
+   *  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 `TextAlignment` enum.
+   * @param extras - Object of string/string key/value pairs.
+   * @param triggerId - The id of the trigger that created this message. The SDK will report back this to
+   *    Braze with in-app message analytics events.
+   * @param clickAction - Where the user should be brought when clicking on this message. See 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 `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 `DismissType` enum.
+   * @param duration - Length of time in milliseconds until auto-dismiss should occur. Only used when
+   *    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 `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).
+   * @param backgroundColor - Background color of entire message. Hex value with opacity (e.g.
+   *    0xff00ff00 is opaque green).
+   * @param textColor - Text color of message. Hex value with opacity (e.g. 0xff00ff00 is opaque
+   *    green).
+   * @param closeButtonColor - Color of close button. Hex value with opacity (e.g. 0xff00ff00 is
+   *    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
+   * @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 `CropType` enum.
+   * @param orientation - Whether to lay out this in-app message as a portrait or landscape. See the
+   *    `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?: TextAlignment,
+    extras?: Record<string, string>,
+    triggerId?: string,
+    clickAction?: ClickAction,
+    uri?: string,
+    openTarget?: OpenTarget,
+    dismissType?: DismissType,
+    duration?: number,
+    icon?: string,
+    imageUrl?: string,
+    imageStyle?: ImageStyle,
+    iconColor?: number,
+    iconBackgroundColor?: number,
+    backgroundColor?: number,
+    textColor?: number,
+    closeButtonColor?: number,
+    animateIn?: boolean,
+    animateOut?: boolean,
+    header?: string,
+    headerAlignment?: TextAlignment,
+    headerTextColor?: number,
+    frameColor?: number,
+    buttons?: InAppMessageButton[],
+    cropType?: CropType,
+    orientation?: Orientation,
+    htmlId?: string,
+    css?: string,
+  );
+
+  /** How to align message text. See the `TextAlignment` enum. */
+  messageAlignment: TextAlignment;
 
-    /** Color of header text. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
-    headerTextColor: number;
+  /**
+   * Where the user should be brought when clicking on this message. See the
+   *    `ClickAction` enum.
+   */
+  clickAction: ClickAction;
 
-    /** Color of the background frame which blocks page interaction while the message is showing. */
-    frameColor: number;
+  /**
+   * If ```clickAction``` is `ClickAction`.URI, the URI to follow when the
+   *    user clicks on this message.
+   */
+  uri?: string;
 
-    /** Array of up to two`InAppMessageButton` objects. */
-    buttons: InAppMessageButton[];
+  /**
+   * If ```clickAction``` is `ClickAction`.URI, whether to open clicks
+   *    in a new tab/window. See the `OpenTarget` enum.
+   */
+  openTarget: OpenTarget;
 
-    /** How to crop and fit images in the allowable space. See the `CropType` enum. */
-    cropType: CropType;
-  }
+  /**
+   * 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.
+   */
+  icon?: string;
 
-  export class HtmlMessage extends InAppMessage {
-    /**
-     *  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 triggerId - The id of the trigger that created this message. The SDK will report back this to
-     *   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 `TextAlignment` enum.
-     * @param duration - Length of time in milliseconds until auto-dismiss should occur. Only used when
-     *   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.
-     * @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.
-     * @param messageFields - Structured data provided by the Braze backend.
-     */
-    constructor(
-      message: string,
-      extras?: Record<string, string>,
-      triggerId?: string,
-      dismissType?: DismissType,
-      duration?: number,
-      animateIn?: boolean,
-      animateOut?: boolean,
-      frameColor?: number,
-      htmlId?: string,
-      css?: string,
-      messageFields?: Record<string, any>
-    );
-
-    /** Color of the background frame which blocks page interaction while the message is showing. */
-    frameColor: number;
-
-    /** Structured data provided by the Braze backend. */
-    messageFields?: Record<string, any>;
-  }
+  /**
+   * 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.
+   */
+  imageUrl?: string;
 
   /**
-   *  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`
+   * 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 `ImageStyle` enum.
    */
-  export class SlideUpMessage extends InAppMessage {
-    /**
-     *  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 `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 triggerId - The id of the trigger that created this message. The SDK will report back this to
-     *    Braze with in-app message analytics events.
-     * @param clickAction - Where the user should be brought when clicking on this message. See 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 `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 `DismissType` enum.
-     * @param duration - Length of time in milliseconds until auto-dismiss should occur. Only used when
-     *    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 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).
-     * @param backgroundColor - Background color of entire message. Hex value with opacity (e.g.
-     *    0xff00ff00 is opaque green).
-     * @param textColor - Text color of message. Hex value with opacity (e.g. 0xff00ff00 is opaque
-     *    green).
-     * @param closeButtonColor - Color of close button. Hex value with opacity (e.g. 0xff00ff00 is
-     *    opaque green).
-     * @param animateIn - Whether to animate the showing of this message.
-     * @param animateOut - Whether to animate the hiding of this message.
-     * @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?: TextAlignment,
-      slideFrom?: SlideFrom,
-      extras?: Record<string, string>,
-      triggerId?: string,
-      clickAction?: ClickAction,
-      uri?: string,
-      openTarget?: OpenTarget,
-      dismissType?: DismissType,
-      duration?: number,
-      icon?: string,
-      imageUrl?: string,
-      iconColor?: number,
-      iconBackgroundColor?: number,
-      backgroundColor?: number,
-      textColor?: number,
-      closeButtonColor?: number,
-      animateIn?: boolean,
-      animateOut?: boolean,
-      htmlId?: string,
-      css?: string
-    );
-
-    /** How to align message text. See the `TextAlignment` enum. */
-    messageAlignment: TextAlignment;
-
-    /** Where the message should slide in from. See the `SlideFrom` enum. */
-    slideFrom: SlideFrom;
+  imageStyle: ImageStyle;
 
-    /**
-     * Where the user should be brought when clicking on this message. See the
-     *    `ClickAction` enum.
-     */
-    clickAction: ClickAction;
+  /** Color of icon. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
+  iconColor: number;
 
-    /**
-     * If ```clickAction``` is `ClickAction`.URI, the URI to follow when the
-     *    user clicks on this message.
-     */
-    uri?: string;
+  /** Background color of icon. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
+  iconBackgroundColor: number;
 
-    /**
-     * If ```clickAction``` is `ClickAction`.URI, whether to open clicks
-     *    in a new tab/window. See the `OpenTarget` enum.
-     */
-    openTarget: OpenTarget;
+  /** Background color of entire message. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
+  backgroundColor: number;
 
-    /**
-     * 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.
-     */
-    icon?: string;
+  /** Text color of message. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
+  textColor: number;
 
-    /**
-     * 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.
-     */
-    imageUrl?: string;
+  /** Color of close button. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
+  closeButtonColor: number;
 
-    /** Color of icon. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
-    iconColor: number;
+  /** Header text to  */
+  header?: string;
 
-    /** Background color of icon. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
-    iconBackgroundColor: number;
+  /** How to align header text. See the `TextAlignment` enum. */
+  headerAlignment: TextAlignment;
 
-    /** Background color of entire message. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
-    backgroundColor: number;
+  /** Color of header text. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
+  headerTextColor: number;
 
-    /** Text color of message. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
-    textColor: number;
+  /** Color of the background frame which blocks page interaction while the message is showing. */
+  frameColor: number;
 
-    /** Color of close button. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
-    closeButtonColor: number;
-  }
+  /** Array of up to two `InAppMessageButton` objects. */
+  buttons: InAppMessageButton[];
 
-  
-  type Genders = typeof User.Genders[keyof typeof User.Genders];
+  /** How to crop and fit images in the allowable space. See the `CropType` enum. */
+  cropType: CropType;
 
-  
-  type NotificationSubscriptionTypes = typeof User.NotificationSubscriptionTypes[keyof typeof User.NotificationSubscriptionTypes];
+  /**
+   * Whether to lay out this in-app message as a portrait or landscape. See the
+   *    `Orientation` enum.
+   */
+  orientation: Orientation;
+}
 
+export class ModalMessage extends InAppMessage {
   /**
-   * 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.
+   *  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`
    *
-   * 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.
+   * @param message - The message to display to the user.
+   * @param messageAlignment - How to align message text. See the `TextAlignment` enum.
+   * @param extras - Object of string/string key/value pairs.
+   * @param triggerId - The id of the trigger that created this message. The SDK will report back this to
+   *    Braze with in-app message analytics events.
+   * @param clickAction - Where the user should be brought when clicking on this message. See 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 `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 `DismissType` enum.
+   * @param duration - Length of time in milliseconds until auto-dismiss should occur. Only used when
+   *    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 `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).
+   * @param backgroundColor - Background color of entire message. Hex value with opacity (e.g.
+   *    0xff00ff00 is opaque green).
+   * @param textColor - Text color of message. Hex value with opacity (e.g. 0xff00ff00 is opaque
+   *    green).
+   * @param closeButtonColor - Color of close button. Hex value with opacity (e.g. 0xff00ff00 is
+   *    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
+   * @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 `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.
    */
-  export class User {
-    /** Enum to represent valid genders. */
-    static Genders: {
-      MALE: "m";
-      FEMALE: "f";
-      OTHER: "o";
-      UNKNOWN: "u";
-      NOT_APPLICABLE: "n";
-      PREFER_NOT_TO_SAY: "p";
-    };
-
-    /** Enum to represent notification status for email and push notifications. */
-    static NotificationSubscriptionTypes: {
-      OPTED_IN: "opted_in";
-      SUBSCRIBED: "subscribed";
-      UNSUBSCRIBED: "unsubscribed";
-    };
-
-    /**
-     * Adds an an alias for the user.  (alias, label) pairs can exist on one and only one user.
-     *   If a different user already has this alias or external user id, the alias attempt will be rejected
-     *   on the server.
-     *
-     * @param alias - An identifier for this user.
-     * @param label - A label for the alias.  e.g. the source of the alias, like "internal_id"
-     *
-     * @returns Whether the update was successfully enqueued.
-     */
-    addAlias(alias: string, label: string): boolean;
-
-    /**
-     * Adds a string to a custom attribute string array, or creates that array if one doesn't exist.
-     *
-     * @param key - The identifier of the custom attribute. Limited to 255 characters in length, cannot begin with
-     *    a $, and can only contain alphanumeric characters and punctuation.
-     * @param value - The string to be added to the array. Strings are limited to 255 characters in length, cannot
-     *    begin with a $, and can only contain alphanumeric characters and punctuation.
-     *
-     * @returns Whether the update was successfully enqueued.
-     */
-    addToCustomAttributeArray(key: string, value: string): boolean;
-
-    /**
-     * Adds a user to an email or SMS subscription group.
-     *
-     * @param subscriptionGroupId - The unique identifier of the subscription group.
-     *
-     * @returns Whether the update was successfully enqueued.
-     */
-    addToSubscriptionGroup(subscriptionGroupId: string): boolean;
-
-    /**
-     * Asynchronously retrieves the current user's id, or null if the user is anonymous / has not been identified.
-     * For example:
-     *
-     * ```
-     * braze.getUser().getUserId(function(userId) {
-     *    console.log('The user is ' + userId);
-     * });
-     * ```
-     *
-     * @param callback - Asynchronous callback - this will be invoked with the userId.
-     */
-    getUserId(callback: (userId: string | null) => void): void;
-
-    /**
-     * Increment/decrement the value of a custom attribute. Only numeric custom attributes
-     *   can be incremented. Attempts to increment a custom attribute that is not numeric
-     *   will be ignored. If you increment a custom attribute that has not previously been
-     *   set, a custom attribute will be created and assigned the value of incrementValue.
-     *   To decrement the value of a custom attribute, use a negative incrementValue.
-     *
-     * @param key - The identifier of the custom attribute. Limited to 255 characters in length, cannot begin with
-     *    a $, and can only contain alphanumeric characters and punctuation.
-     * @param incrementValue - Default 1. May be negative to decrement.
-     *
-     * @returns Whether the update was successfully enqueued.
-     */
-    incrementCustomUserAttribute(key: string, incrementValue?: number): boolean;
-
-    /**
-     * Removes a string from a custom attribute string array.
-     *
-     * @param key - The identifier of the custom attribute. Limited to 255 characters in length, cannot begin with
-     *    a $, and can only contain alphanumeric characters and punctuation.
-     * @param value - The string to be removed from the array. Strings are limited to 255 characters in length,
-     *    cannot begin with a $, and can only contain alphanumeric characters and punctuation.
-     *
-     * @returns Whether the update was successfully enqueued.
-     */
-    removeFromCustomAttributeArray(key: string, value: string): boolean;
+  constructor(
+    message?: string,
+    messageAlignment?: TextAlignment,
+    extras?: Record<string, string>,
+    triggerId?: string,
+    clickAction?: ClickAction,
+    uri?: string,
+    openTarget?: OpenTarget,
+    dismissType?: DismissType,
+    duration?: number,
+    icon?: string,
+    imageUrl?: string,
+    imageStyle?: ImageStyle,
+    iconColor?: number,
+    iconBackgroundColor?: number,
+    backgroundColor?: number,
+    textColor?: number,
+    closeButtonColor?: number,
+    animateIn?: boolean,
+    animateOut?: boolean,
+    header?: string,
+    headerAlignment?: TextAlignment,
+    headerTextColor?: number,
+    frameColor?: number,
+    buttons?: InAppMessageButton[],
+    cropType?: CropType,
+    htmlId?: string,
+    css?: string,
+  );
+
+  /** How to align message text. See the `TextAlignment` enum. */
+  messageAlignment: TextAlignment;
 
-    /**
-     * Removes a user from an email or SMS subscription group.
-     *
-     * @param subscriptionGroupId - The unique identifier of the subscription group.
-     *
-     * @returns Whether the update was successfully enqueued.
-     */
-    removeFromSubscriptionGroup(subscriptionGroupId: string): boolean;
+  /**
+   * Where the user should be brought when clicking on this message. See the
+   *    `ClickAction` enum.
+   */
+  clickAction: ClickAction;
 
-    /**
-     * Sets the country for the user.
-     *
-     * @param country - Limited to 255 characters in length. Accepts an explicit null value to null out attribute.
-     *
-     * @returns Whether the update was successfully enqueued.
-     */
-    setCountry(country: string | null): boolean;
+  /**
+   * If ```clickAction``` is `ClickAction`.URI, the URI to follow when the
+   *    user clicks on this message.
+   */
+  uri?: string;
 
-    /**
-     * Sets a custom user location attribute.
-     *
-     * @param key - The identifier of the custom location attribute. Limited to 255 characters in length, cannot begin with
-     *   a $, and can only contain alphanumeric characters and punctuation.
-     * @param latitude - The latitude of the user's location in (valid values are between -90 to 90 degrees). Passing a null
-     *   value for both latitude and longitude will remove this custom attribute from the user.
-     * @param longitude - The longitude of the user's location (valid values are between -180 to 180 degrees). Passing a null
-     *   value for both latitude and longitude will remove this custom attribute from the user.
-     *
-     * @returns Whether the update was successfully enqueued.
-     */
-    setCustomLocationAttribute(
-      key: string,
-      latitude: number | null,
-      longitude: number | null
-    ): boolean;
+  /**
+   * If ```clickAction``` is `ClickAction`.URI, whether to open clicks
+   *    in a new tab/window. See the `OpenTarget` enum.
+   */
+  openTarget: OpenTarget;
 
-    /**
-     * Sets a custom user attribute. This can be any key/value pair and is used to collect extra
-     * information about the user.
-     *
-     * @param key - The identifier of the custom attribute. Limited to 255 characters in length, cannot begin with
-     *    a $, and can only contain alphanumeric characters and punctuation.
-     * @param value - Can be numeric, boolean, a Date object, a string, or an array of strings. Strings are limited to
-     *    255 characters in length, cannot begin with a $, and can only contain alphanumeric characters and punctuation.
-     *    Passing a null value will remove this custom attribute from the user.
-     * @param merge - Whether the value should be merged with the existing value on the backend. If `false` (default), any existing
-     *    attribute will be overwritten. If `true`, existing objects and arrays of objects will be merged. To update an array of objects,
-     *    follow the guidelines in our
-     *    [public docs](https://www.braze.com/docs/user_guide/data_and_analytics/custom_data/custom_attributes/array_of_objects/#usage-examples).
-     *
-     * @returns {boolean} Whether the update was successfully enqueued.
-     */
-    setCustomUserAttribute(
-      key: string,
-      value: number | boolean | Date | string | string[] | object | object[] | null,
-      merge?: boolean
-    ): boolean;
+  /**
+   * 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.
+   */
+  icon?: string;
 
-    /**
-     * Sets the date of birth of the user. Alternatively takes in null values for all parameters
-     *   to set date of birth to null.
-     *
-     * @param year
-     * @param month - 1-12
-     * @param day
-     *
-     * @returns Whether the update was successfully enqueued.
-     */
-    setDateOfBirth(
-      year: number | null,
-      month: number | null,
-      day: number | null
-    ): boolean;
+  /**
+   * 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.
+   */
+  imageUrl?: string;
 
-    /**
-     * Sets the email address of the user.
-     *
-     * @param email - Must pass RFC-5322 email address validation. Accepts an explicit null value to
-     *   null out attribute.
-     *
-     * @returns Whether the update was successfully enqueued.
-     */
-    setEmail(email: string | null): boolean;
+  /**
+   * 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 `ImageStyle` enum.
+   */
+  imageStyle: ImageStyle;
 
-    /**
-     * Sets whether the user should be sent email campaigns.
-     *
-     * @param notificationSubscriptionType - Notification setting (explicitly opted-in, subscribed, or unsubscribed).
-     *    See the `NotificationSubscriptionTypes` enum.
-     *
-     * @returns Whether the update was successfully enqueued.
-     */
-    setEmailNotificationSubscriptionType(
-      notificationSubscriptionType: NotificationSubscriptionTypes
-    ): boolean;
+  /** Color of icon. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
+  iconColor: number;
 
-    /**
-     * Sets the first name of the user.
-     *
-     * @param firstName - Limited to 255 characters in length. Accepts an explicit null value to null out attribute.
-     *
-     * @returns Whether the update was successfully enqueued.
-     */
-    setFirstName(firstName: string | null): boolean;
+  /** Background color of icon. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
+  iconBackgroundColor: number;
 
-    /**
-     * Sets the gender of the user.
-     *
-     * @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: Genders | null): boolean;
+  /** Background color of entire message. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
+  backgroundColor: number;
 
-    /**
-     * Sets the home city for the user.
-     *
-     * @param homeCity - Limited to 255 characters in length. Accepts an explicit null value to null out attribute.
-     *
-     * @returns Whether the update was successfully enqueued.
-     */
-    setHomeCity(homeCity: string | null): boolean;
+  /** Text color of message. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
+  textColor: number;
 
-    /**
-     * Sets the language for this user. By default, the user's language is detected automatically
-     * from the browser. If you call this method, Braze will ignore the detected language and use
-     * the language you have provided instead.
-     *
-     * @param language - An [ISO 639-1 Language Code](https://www.w3schools.com/tags/ref_language_codes.asp).
-     *   Accepts an explicit null value to null out attribute.
-     *
-     * @returns {boolean} Whether the update was successfully enqueued.
-     */
-    setLanguage(language: string | null): boolean;
+  /** Color of close button. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
+  closeButtonColor: number;
 
-    /**
-     * Sets the last known location for the user.
-     *
-     * @param latitude - The latitude of the user's location in (valid values are between -90 to 90 degrees)
-     * @param longitude - The longitude of the user's location (valid values are between -180 to 180 degrees)
-     * @param accuracy - The accuracy of the user's lat/long in meters.
-     * @param altitude - The altitude of the user's location in meters above or below the WGS 84 reference
-     *    ellipsoid.
-     * @param altitudeAccuracy - The accuracy of the user's altitude in meters.
-     *
-     * @returns Whether the update was successfully enqueued.
-     */
-    setLastKnownLocation(
-      latitude: number,
-      longitude: number,
-      accuracy?: number,
-      altitude?: number,
-      altitudeAccuracy?: number
-    ): boolean;
+  /** Header text to  */
+  header?: string;
 
-    /**
-     * Sets the last name of the user.
-     *
-     * @param lastName - Limited to 255 characters in length. Accepts an explicit null value to null out attribute.
-     *
-     * @returns Whether the update was successfully enqueued.
-     */
-    setLastName(lastName: string | null): boolean;
+  /** How to align header text. See the `TextAlignment` enum. */
+  headerAlignment: TextAlignment;
 
-    /**
-     * Sets the phone number of the user.
-     *
-     * @param phoneNumber - A phone number is considered valid if it is no more than 255 characters in length and
-     *   contains only numbers, whitespace, and the following special characters +.-() Accepts an explicit null value to
-     *   null out attribute.
-     *
-     * @returns Whether the update was successfully enqueued.
-     */
-    setPhoneNumber(phoneNumber: string | null): boolean;
+  /** Color of header text. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
+  headerTextColor: number;
 
-    /**
-     * Sets whether the user should be sent push campaigns.
-     *
-     * @param notificationSubscriptionType - Notification setting (explicitly opted-in, subscribed, or unsubscribed).
-     *    See the `NotificationSubscriptionTypes` enum.
-     *
-     * @returns Whether the update was successfully enqueued.
-     */
-    setPushNotificationSubscriptionType(
-      notificationSubscriptionType: NotificationSubscriptionTypes
-    ): boolean;
-  }
+  /** Color of the background frame which blocks page interaction while the message is showing. */
+  frameColor: number;
 
-  export class InAppMessageButton {
-    /**
-     *  Represents a button on an `ModalMessage` or `FullScreenMessage`.
-     *
-     * @param text - The text to display on this button
-     * @param backgroundColor - The background color for this button. Hex value with opacity (e.g.
-     *    0xff00ff00 is opaque green).
-     * @param textColor - The color for the text of this button. Hex value with opacity (e.g.
-     *    0xff00ff00 is opaque green).
-     * @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
-     *    `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.
-     */
-    constructor(
-      text: string,
-      backgroundColor?: number,
-      textColor?: number,
-      borderColor?: number,
-      clickAction?: ClickAction,
-      uri?: string,
-      id?: number
-    );
-
-    /** The text to display on this button */
-    text: string;
+  /** Array of up to two`InAppMessageButton` objects. */
+  buttons: InAppMessageButton[];
 
-    /**
-     * The background color for this button. Hex value with opacity (e.g.
-     *    0xff00ff00 is opaque green).
-     */
-    backgroundColor: number;
+  /** How to crop and fit images in the allowable space. See the `CropType` enum. */
+  cropType: CropType;
+}
 
-    /**
-     * The color for the text of this button. Hex value with opacity (e.g.
-     *    0xff00ff00 is opaque green).
-     */
-    textColor: number;
+export class HtmlMessage extends InAppMessage {
+  /**
+   *  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 triggerId - The id of the trigger that created this message. The SDK will report back this to
+   *   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 `TextAlignment` enum.
+   * @param duration - Length of time in milliseconds until auto-dismiss should occur. Only used when
+   *   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.
+   * @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.
+   * @param messageFields - Structured data provided by the Braze backend.
+   */
+  constructor(
+    message: string,
+    extras?: Record<string, string>,
+    triggerId?: string,
+    dismissType?: DismissType,
+    duration?: number,
+    animateIn?: boolean,
+    animateOut?: boolean,
+    frameColor?: number,
+    htmlId?: string,
+    css?: string,
+    messageFields?: Record<string, any>,
+  );
+
+  /** Color of the background frame which blocks page interaction while the message is showing. */
+  frameColor: number;
+
+  /** Structured data provided by the Braze backend. */
+  messageFields?: Record<string, any>;
+}
+
+/**
+ *  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`
+ */
+export class SlideUpMessage extends InAppMessage {
+  /**
+   *  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 `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 triggerId - The id of the trigger that created this message. The SDK will report back this to
+   *    Braze with in-app message analytics events.
+   * @param clickAction - Where the user should be brought when clicking on this message. See 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 `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 `DismissType` enum.
+   * @param duration - Length of time in milliseconds until auto-dismiss should occur. Only used when
+   *    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 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).
+   * @param backgroundColor - Background color of entire message. Hex value with opacity (e.g.
+   *    0xff00ff00 is opaque green).
+   * @param textColor - Text color of message. Hex value with opacity (e.g. 0xff00ff00 is opaque
+   *    green).
+   * @param closeButtonColor - Color of close button. Hex value with opacity (e.g. 0xff00ff00 is
+   *    opaque green).
+   * @param animateIn - Whether to animate the showing of this message.
+   * @param animateOut - Whether to animate the hiding of this message.
+   * @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?: TextAlignment,
+    slideFrom?: SlideFrom,
+    extras?: Record<string, string>,
+    triggerId?: string,
+    clickAction?: ClickAction,
+    uri?: string,
+    openTarget?: OpenTarget,
+    dismissType?: DismissType,
+    duration?: number,
+    icon?: string,
+    imageUrl?: string,
+    iconColor?: number,
+    iconBackgroundColor?: number,
+    backgroundColor?: number,
+    textColor?: number,
+    closeButtonColor?: number,
+    animateIn?: boolean,
+    animateOut?: boolean,
+    htmlId?: string,
+    css?: string,
+  );
+
+  /** How to align message text. See the `TextAlignment` enum. */
+  messageAlignment: TextAlignment;
+
+  /** Where the message should slide in from. See the `SlideFrom` enum. */
+  slideFrom: SlideFrom;
 
-    /**
-     * The color for the border of this button. Hex value with opacity (e.g.
-     *    0xff00ff00 is opaque green).
-     */
-    borderColor: number;
+  /**
+   * Where the user should be brought when clicking on this message. See the
+   *    `ClickAction` enum.
+   */
+  clickAction: ClickAction;
 
-    /**
-     * Where the user should be brought when clicking on this button. See the
-     *    `ClickAction` enum.
-     */
-    clickAction: ClickAction;
+  /**
+   * If ```clickAction``` is `ClickAction`.URI, the URI to follow when the
+   *    user clicks on this message.
+   */
+  uri?: string;
 
-    /**
-     * If ```clickAction``` is `ClickAction`.URI, the URI to follow when the
-     *  user clicks on this button.
-     */
-    uri?: string;
+  /**
+   * If ```clickAction``` is `ClickAction`.URI, whether to open clicks
+   *    in a new tab/window. See the `OpenTarget` enum.
+   */
+  openTarget: OpenTarget;
 
-    /** The id for this button. Used for analytics. */
-    id?: number;
+  /**
+   * 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.
+   */
+  icon?: string;
 
-    /** Remove all event subscriptions from this button. */
-    removeAllSubscriptions(): void;
+  /**
+   * 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.
+   */
+  imageUrl?: string;
 
-    /**
-     * Remove an event subscription that you previously subscribed to.
-     *
-     * @param subscriptionGuid - The identifier of the subscription you wish to remove, returned by the method
-     *    you initially used to create it.
-     */
-    removeSubscription(subscriptionGuid: string): void;
+  /** Color of icon. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
+  iconColor: number;
 
-    /**
-     * Subscribe to receive click events on this button. The subscriber callback will be called whenever this button is
-     *  clicked by the user.
-     *
-     * @param subscriber - The callback function to receive click events. This function will be invoked with
-     *    no arguments when this button records a click.
-     *
-     * @returns The identifier of the subscription created. This can be passed to `removeSubscription`
-     *    to cancel the subscription. Returns null if the subscriber passed is not a function.
-     */
-    subscribeToClickedEvent(subscriber: () => void): string | null;
-  }
+  /** Background color of icon. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
+  iconBackgroundColor: number;
 
-  export interface FeatureFlagStringProperty {
-    type: "string";
-    value: string;
-  }
+  /** Background color of entire message. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
+  backgroundColor: number;
 
-  export interface FeatureFlagNumberProperty {
-    type: "number";
-    value: number;
-  }
+  /** Text color of message. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
+  textColor: number;
 
-  export interface FeatureFlagBooleanProperty {
-    type: "boolean";
-    value: boolean;
-  }
+  /** Color of close button. Hex value with opacity (e.g. 0xff00ff00 is opaque green). */
+  closeButtonColor: number;
+}
 
-  export class FeatureFlag {
-    /** Indicates whether or not this feature flag is enabled. */
-    enabled: boolean;
 
-    /** Properties of this feature flag, listed as key-value pairs. */
-    properties: Partial<Record<string, FeatureFlagStringProperty | FeatureFlagNumberProperty | FeatureFlagBooleanProperty>>;
+type Genders = (typeof User.Genders)[keyof typeof User.Genders];
 
-    /** The ID for this feature flag. */
-    id: string;
 
-    /**
-     * Get value of a feature flag property of type string.
-     *
-     * @param key - The key of the property.
-     *
-     * @returns The value of the property if the key is found and is of type string.
-     *    If the key is not found or if there is a type mismatch, this method will return a null.
-     */
-    getStringProperty(key: string): string | null;
+type NotificationSubscriptionTypes =
+  (typeof User.NotificationSubscriptionTypes)[keyof typeof User.NotificationSubscriptionTypes];
 
-    /**
-     * Get value of a feature flag property of type number.
-     *
-     * @param key - The key of the property.
-     *
-     * @returns The value of the property if the key is found and is of type number.
-     *    If the key is not found or if there is a type mismatch, this method will return a null.
-     */
-    getNumberProperty(key: string): number | null;
+/**
+ * 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.
+ */
+export class User {
+  /** Enum to represent valid genders. */
+  static Genders: {
+    MALE: "m";
+    FEMALE: "f";
+    OTHER: "o";
+    UNKNOWN: "u";
+    NOT_APPLICABLE: "n";
+    PREFER_NOT_TO_SAY: "p";
+  };
 
-    /**
-     * Get value of a feature flag property of type boolean.
-     *
-     * @param key - The key of the property.
-     *
-     * @returns The value of the property if the key is found and is of type boolean.
-     *    If the key is not found or if there is a type mismatch, this method will return a null.
-     */
-    getBooleanProperty(key: string): boolean | null;
-  }
+  /** Enum to represent notification status for email and push notifications. */
+  static NotificationSubscriptionTypes: {
+    OPTED_IN: "opted_in";
+    SUBSCRIBED: "subscribed";
+    UNSUBSCRIBED: "unsubscribed";
+  };
 
   /**
-   * Automatically display in-app messages when they are triggered. This method should be called before
-   *   calling `openSession`.
+   * Adds an an alias for the user.  (alias, label) pairs can exist on one and only one user.
+   *   If a different user already has this alias or external user id, the alias attempt will be rejected
+   *   on the server.
+   *
+   * @param alias - An identifier for this user.
+   * @param label - A label for the alias.  e.g. the source of the alias, like "internal_id"
    *
-   * @returns The identifier of the subscription created. This can be passed to
-   *    `removeSubscription` to cancel the subscription.
+   * @returns Whether the update was successfully enqueued.
    */
-  export function automaticallyShowInAppMessages(): string;
+  addAlias(alias: string, label: string): boolean;
 
   /**
-   * 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.
+   * Adds a string to a custom attribute string array, or creates that array if one doesn't exist.
+   *
+   * @param key - The identifier of the custom attribute. Limited to 255 characters in length, cannot begin with
+   *    a $, and can only contain alphanumeric characters and punctuation.
+   * @param value - The string to be added to the array. Strings are limited to 255 characters in length, cannot
+   *    begin with a $, and can only contain alphanumeric characters and punctuation.
+   *
+   * @returns Whether the update was successfully enqueued.
    */
-  export function destroyFeed(): void;
+  addToCustomAttributeArray(key: string, value: string): boolean;
 
   /**
-   * 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.
+   * Adds a user to an email or SMS subscription group.
    *
-   * @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.
+   * @param subscriptionGroupId - The unique identifier of the subscription group.
+   *
+   * @returns Whether the update was successfully enqueued.
    */
-  export function hideContentCards(parentNode?: Element | null): void;
+  addToSubscriptionGroup(subscriptionGroupId: string): boolean;
 
   /**
-   * Display the user's content cards.
+   * Asynchronously retrieves the current user's id, or null if the user is anonymous / has not been identified.
+   * For example:
    *
-   * @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.
+   * ```
+   * braze.getUser().getUserId(function(userId) {
+   *    console.log('The user is ' + userId);
+   * });
+   * ```
+   * @deprecated - The getUserId callback is deprecated. Access the method's return value directly instead.
+   * @param callback - Asynchronous callback - this will be invoked with the userId.
    */
-  export function showContentCards(
-    parentNode?: Element | null,
-    filterFunction?: (cards: Card[]) => Card[]
-  ): void;
-
+  getUserId(callback: (userId: string | null) => void): void;
   /**
-   * Display the user's news feed.
+   * Retrieves the current user's id, or null if the user is anonymous / has not been identified.
+   * For example:
    *
-   * @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.
+   * ```
+   * console.log('The user is ' + braze.getUser().getUserId());
+   * ```
    */
-  export function showFeed(
-    parentNode?: Element | null,
-    cards?: Card[] | null,
-    allowedCategories?: string[]
-  ): void;
-
+  getUserId(): string | null | undefined;
   /**
-   * Display a given in-app message.
+   * Increment/decrement the value of a custom attribute. Only numeric custom attributes
+   *   can be incremented. Attempts to increment a custom attribute that is not numeric
+   *   will be ignored. If you increment a custom attribute that has not previously been
+   *   set, a custom attribute will be created and assigned the value of incrementValue.
+   *   To decrement the value of a custom attribute, use a negative incrementValue.
    *
-   * @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.
+   * @param key - The identifier of the custom attribute. Limited to 255 characters in length, cannot begin with
+   *    a $, and can only contain alphanumeric characters and punctuation.
+   * @param incrementValue - Default 1. May be negative to decrement.
    *
-   * @returns Whether or not the message was displayed (or, in the case of control messages, logged to
-   *    Braze servers).
+   * @returns Whether the update was successfully enqueued.
    */
-  export function showInAppMessage(
-    inAppMessage: InAppMessage | ControlMessage,
-    parentNode?: Element | null,
-    onDisplayCallback?: () => void
-  ): boolean;
+  incrementCustomUserAttribute(key: string, incrementValue?: number): 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.
+   * Removes a string from a custom attribute string array.
    *
-   * @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.
+   * @param key - The identifier of the custom attribute. Limited to 255 characters in length, cannot begin with
+   *    a $, and can only contain alphanumeric characters and punctuation.
+   * @param value - The string to be removed from the array. Strings are limited to 255 characters in length,
+   *    cannot begin with a $, and can only contain alphanumeric characters and punctuation.
+   *
+   * @returns Whether the update was successfully enqueued.
    */
-  export function toggleContentCards(
-    parentNode?: Element | null,
-    filterFunction?: (cards: Card[]) => Card[]
-  ): void;
+  removeFromCustomAttributeArray(key: string, value: string): boolean;
 
   /**
-   * Toggle the Braze news feed, creating it if it does not exist, and destroying it if it does.
+   * Removes a user from an email or SMS subscription group.
+   *
+   * @param subscriptionGroupId - The unique identifier of the subscription group.
    *
-   * @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.
+   * @returns Whether the update was successfully enqueued.
    */
-  export function toggleFeed(
-    parentNode?: Element | null,
-    cards?: Card[] | null,
-    allowedCategories?: string[]
-  ): void;
+  removeFromSubscriptionGroup(subscriptionGroupId: string): boolean;
 
   /**
-   * When a user first uses Braze on a device they are considered "anonymous". Use this method to identify a user
-   *    with a unique ID, which enables the following:
+   * Sets the country for the user.
    *
-   *    - If the same user is identified on another device, their user profile, usage history and event history will
-   *        be shared across devices.
-   *    - If your app is used on the same browser by multiple people, you can assign each of them a unique identifier
-   *        to track them separately. Only the most recent user on a particular browser will receive push
-   *        notifications and in-app messages.
+   * @param country - Limited to 255 characters in length. Accepts an explicit null value to null out attribute.
    *
-   * When you request a user switch (which is any call to changeUser where the new user ID is not the same as the
-   *    existing user ID), the current session for the previous user (anonymous or not) is automatically ended and
-   *    a new session is started. Similarly, following a call to changeUser, any events which fire are guaranteed to
-   *    be for the new user -- if an in-flight server request completes for the old user after the user switch no
-   *    events will fire, so you do not need to worry about filtering out events from Braze for old users.
-   *
-   * Additionally, if you identify a user which has never been identified on another device, the entire history of
-   *    that user as an "anonymous" user on this device will be preserved and associated with the newly identified
-   *    user. However, if you identify a user which *has* been identified in another app, any history which was
-   *    already flushed to the server for the anonymous user on this device will become orphaned and will not be
-   *    associated with any future users. These orphaned users are not considered in your user counts and will not
-   *    be messaged.
+   * @returns Whether the update was successfully enqueued.
+   */
+  setCountry(country: string | null): boolean;
+
+  /**
+   * Sets a custom user location attribute.
    *
-   * Note: Once you identify a user, you cannot revert to the "anonymous" user. The transition from anonymous to
-   *    identified tracking is only allowed once because the initial anonymous user receives special treatment to
-   *    allow for preservation of their history. As a result, we recommend against changing the user ID just because
-   *    your app has entered a "logged out" state because it makes you unable to target the previously logged out user
-   *    with re-engagement campaigns. If you anticipate multiple users on the same device, but only want to target one
-   *    of them when your app is in a logged out state, we recommend separately keeping track of the user ID you want
-   *    to target while logged out and switching back to that user ID as part of your app's logout process.
+   * @param key - The identifier of the custom location attribute. Limited to 255 characters in length, cannot begin with
+   *   a $, and can only contain alphanumeric characters and punctuation.
+   * @param latitude - The latitude of the user's location in (valid values are between -90 to 90 degrees). Passing a null
+   *   value for both latitude and longitude will remove this custom attribute from the user.
+   * @param longitude - The longitude of the user's location (valid values are between -180 to 180 degrees). Passing a null
+   *   value for both latitude and longitude will remove this custom attribute from the user.
    *
-   * @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.
+   * @returns Whether the update was successfully enqueued.
    */
-  export function changeUser(userId: string, signature?: string): void;
+  setCustomLocationAttribute(
+    key: string,
+    latitude: number | null,
+    longitude: number | null,
+  ): boolean;
 
   /**
-   * Destroys this `braze` instance, destroying all subscription callbacks and releasing member variables which
-   *    retain memory.
+   * Sets a custom user attribute. This can be any key/value pair and is used to collect extra
+   * information about the user.
+   *
+   * @param key - The identifier of the custom attribute. Limited to 255 characters in length, cannot begin with
+   *    a $, and can only contain alphanumeric characters and punctuation.
+   * @param value - Can be numeric, boolean, a Date object, a string, or an array of strings. Strings are limited to
+   *    255 characters in length, cannot begin with a $, and can only contain alphanumeric characters and punctuation.
+   *    Passing a null value will remove this custom attribute from the user.
+   * @param merge - Whether the value should be merged with the existing value on the backend. If `false` (default), any existing
+   *    attribute will be overwritten. If `true`, existing objects and arrays of objects will be merged. To update an array of objects,
+   *    follow the guidelines in our
+   *    [public docs](https://www.braze.com/docs/user_guide/data_and_analytics/custom_data/custom_attributes/array_of_objects/#usage-examples).
+   *
+   * @returns {boolean} Whether the update was successfully enqueued.
    */
-  export function destroy(): void;
+  setCustomUserAttribute(
+    key: string,
+    value:
+      | number
+      | boolean
+      | Date
+      | string
+      | string[]
+      | object
+      | object[]
+      | null,
+    merge?: boolean,
+  ): boolean;
 
   /**
-   * Get all currently available cards from the last content cards refresh.
+   * Sets the date of birth of the user. Alternatively takes in null values for all parameters
+   *   to set date of birth to null.
    *
-   * @returns - A `ContentCards` object which includes all currently available
-   *    `Card` objects from the last content cards refresh.
+   * @param year
+   * @param month - 1-12
+   * @param day
+   *
+   * @returns Whether the update was successfully enqueued.
    */
-  export function getCachedContentCards(): ContentCards;
+  setDateOfBirth(
+    year: number | null,
+    month: number | null,
+    day: number | null,
+  ): boolean;
 
   /**
-   * Get all unexpired cards from the last news feed refresh.
+   * Sets the email address of the user.
    *
-   * @returns - A `Feed` object which includes all unexpired `Card` objects from the last
-   *    news feed refresh.
+   * @param email - Must pass RFC-5322 email address validation. Accepts an explicit null value to
+   *   null out attribute.
+   *
+   * @returns Whether the update was successfully enqueued.
    */
-  export function getCachedFeed(): Feed;
+  setEmail(email: string | null): boolean;
 
   /**
-   * 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:
+   * Sets whether the user should be sent email campaigns.
    *
-   * ```
-   * braze.getDeviceId(function(deviceId) {
-   *    console.log('The device id is ' + deviceId);
-   * });
-   * ```
+   * @param notificationSubscriptionType - Notification setting (explicitly opted-in, subscribed, or unsubscribed).
+   *    See the `NotificationSubscriptionTypes` enum.
    *
-   * @param callback - Asynchronous callback - this will be invoked with the deviceId.
+   * @returns Whether the update was successfully enqueued.
    */
-  export function getDeviceId(callback: (deviceId: string) => void): void;
+  setEmailNotificationSubscriptionType(
+    notificationSubscriptionType: NotificationSubscriptionTypes,
+  ): boolean;
 
   /**
-   * @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. Returns undefined if the
-   *    SDK has not been initialized.
+   * Sets the first name of the user.
+   *
+   * @param firstName - Limited to 255 characters in length. Accepts an explicit null value to null out attribute.
+   *
+   * @returns Whether the update was successfully enqueued.
    */
-  export function getUser(): User | undefined;
+  setFirstName(firstName: string | null): boolean;
 
   /**
-   * 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.
+   * Sets the gender of the user.
    *
-   * @param apiKey - Your app's Braze API Key. Your API keys can be found
-   *    [here](https://dashboard.braze.com/app_settings/app_settings).
-   * @param options - Configuration options. See `InitializationOptions` for supported options.
+   * @param gender - Generally 'm' or 'f'. Accepts an explicit null value to null out attribute. Use `Genders`
+   *    enum when setting this value.
    *
-   * @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.
+   * @returns Whether the update was successfully enqueued.
    */
-  export function initialize(apiKey: string, options: InitializationOptions): boolean;
+  setGender(gender: Genders | null): 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.
-   *    Returns undefined if the SDK has not been initialized.
+   * Sets the home city for the user.
+   *
+   * @param homeCity - Limited to 255 characters in length. Accepts an explicit null value to null out attribute.
+   *
+   * @returns Whether the update was successfully enqueued.
    */
-  export function isPushBlocked(): boolean | undefined;
+  setHomeCity(homeCity: string | null): boolean;
 
   /**
-   * 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
-   *    `requestPushPermission` may be called without the user being prompted. Useful for migrating existing
-   *    non-Braze push registrations to Braze.
+   * Sets the language for this user. By default, the user's language is detected automatically
+   * from the browser. If you call this method, Braze will ignore the detected language and use
+   * the language you have provided instead.
+   *
+   * @param language - An [ISO 639-1 Language Code](https://www.w3schools.com/tags/ref_language_codes.asp).
+   *   Accepts an explicit null value to null out attribute.
    *
-   * @returns Whether or not the user has granted push permission. If this returns true,
-   *    `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.
+   * @returns {boolean} Whether the update was successfully enqueued.
    */
-  export function isPushPermissionGranted(): boolean | undefined;
+  setLanguage(language: string | null): boolean;
 
   /**
-   * 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.
+   * Sets the last known location for the user.
    *
-   * @returns Whether or not push is supported in this environment. Returns undefined if the SDK has not been initialized.
+   * @param latitude - The latitude of the user's location in (valid values are between -90 to 90 degrees)
+   * @param longitude - The longitude of the user's location (valid values are between -180 to 180 degrees)
+   * @param accuracy - The accuracy of the user's lat/long in meters.
+   * @param altitude - The altitude of the user's location in meters above or below the WGS 84 reference
+   *    ellipsoid.
+   * @param altitudeAccuracy - The accuracy of the user's altitude in meters.
+   *
+   * @returns Whether the update was successfully enqueued.
    */
-  export function isPushSupported(): boolean | undefined;
+  setLastKnownLocation(
+    latitude: number,
+    longitude: number,
+    accuracy?: number,
+    altitude?: number,
+    altitudeAccuracy?: number,
+  ): boolean;
 
   /**
-   * 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.
+   * Sets the last name of the user.
    *
-   * @param card - the `Card` object that received a click
-   * @param forContentCards - whether to log this as a content cards event (as opposed to the legacy news feed)
+   * @param lastName - Limited to 255 characters in length. Accepts an explicit null value to null out attribute.
    *
-   * @returns Whether or not the event was successfully logged (to be flushed later).
+   * @returns Whether the update was successfully enqueued.
    */
-  export function logCardClick(card: Card, forContentCards?: boolean): boolean;
+  setLastName(lastName: string | null): boolean;
 
   /**
-   * 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.
+   * Sets the phone number of the user.
    *
-   * @param card - the `Card` object that received a dismissal
+   * @param phoneNumber - A phone number is considered valid if it is no more than 255 characters in length and
+   *   contains only numbers, whitespace, and the following special characters +.-() Accepts an explicit null value to
+   *   null out attribute.
    *
-   * @returns Whether or not the event was successfully logged (to be flushed later).
+   * @returns Whether the update was successfully enqueued.
    */
-  export function logCardDismissal(card: Card): boolean;
+  setPhoneNumber(phoneNumber: string | null): boolean;
 
   /**
-   * 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.
+   * Sets whether the user should be sent push campaigns.
    *
-   * @param cards - array of `Card` objects that received impressions
-   * @param forContentCards - whether to log this as a content cards event (as opposed to the legacy news feed)
+   * @param notificationSubscriptionType - Notification setting (explicitly opted-in, subscribed, or unsubscribed).
+   *    See the `NotificationSubscriptionTypes` enum.
    *
-   * @returns Whether or not the event was successfully logged (to be flushed later).
+   * @returns Whether the update was successfully enqueued.
    */
-  export function logCardImpressions(
-    cards: Card[],
-    forContentCards?: boolean
+  setPushNotificationSubscriptionType(
+    notificationSubscriptionType: NotificationSubscriptionTypes,
   ): boolean;
+}
 
+export class InAppMessageButton {
   /**
-   * A convenient method to log that the user saw the given Content Cards. This method is equivalent to
-   *    calling [`logCardImpressions` method with `forContentCards` param set to true.
-   *    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 content cards in
-   *    your own code.
-   *
-   * @param contentCards - array of `Card` objects that received impressions
-   *
-   * @returns Whether or not the event was successfully logged (to be flushed later).
+   *  Represents a button on an `ModalMessage` or `FullScreenMessage`.
+   *
+   * @param text - The text to display on this button
+   * @param backgroundColor - The background color for this button. Hex value with opacity (e.g.
+   *    0xff00ff00 is opaque green).
+   * @param textColor - The color for the text of this button. Hex value with opacity (e.g.
+   *    0xff00ff00 is opaque green).
+   * @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
+   *    `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.
    */
-   export function logContentCardImpressions(contentCards: Card[]): boolean;
+  constructor(
+    text: string,
+    backgroundColor?: number,
+    textColor?: number,
+    borderColor?: number,
+    clickAction?: ClickAction,
+    uri?: string,
+    id?: number,
+  );
+
+  /** The text to display on this button */
+  text: string;
 
   /**
-   * A convenient method to log when user clicks on a Content Card. This method is equivalent to
-   *    calling [`logCardClick` method with `forContentCards` param set to true.
-   *    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 content cards in
-   *    your own code.
-   *
-   * @param contentCard - the `Card` object that received a click
-   *
-   * @returns Whether or not the event was successfully logged (to be flushed later).
+   * The background color for this button. Hex value with opacity (e.g.
+   *    0xff00ff00 is opaque green).
    */
-   export function logContentCardClick(contentCard: Card): boolean;
+  backgroundColor: number;
 
   /**
-   * @deprecated This method has been deprecated and is currently a no-op.
+   * The color for the text of this button. Hex value with opacity (e.g.
+   *    0xff00ff00 is opaque green).
    */
-  export function logContentCardsDisplayed(): boolean;
+  textColor: number;
 
   /**
-   * Reports that the current user performed a custom named event.
-   *
-   * @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,
-   *      or null. Total size of event properties cannot exceed 50KB.
-   *
-   * @returns Whether or not the event was successfully logged (to be flushed later).
+   * The color for the border of this button. Hex value with opacity (e.g.
+   *    0xff00ff00 is opaque green).
    */
-  export function logCustomEvent(eventName: string, eventProperties?: object): boolean;
+  borderColor: number;
 
   /**
-   * 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.
+   * Where the user should be brought when clicking on this button. See the
+   *    `ClickAction` enum.
    */
-  export function logFeedDisplayed(): void;
+  clickAction: ClickAction;
 
   /**
-   * 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 `showInAppMessage`,
-   *    and should only be called if you're bypassing that method and manually displaying the message in your own
-   *    code.
-   *
-   * @param button - The button clicked
-   * @param inAppMessage - The message this button belongs to
-   *
-   * @returns Whether or not the event was successfully logged (to be flushed later).
+   * If ```clickAction``` is `ClickAction`.URI, the URI to follow when the
+   *  user clicks on this button.
    */
-  export function logInAppMessageButtonClick(
-    button: InAppMessageButton,
-    inAppMessage: InAppMessage
-  ): boolean;
+  uri?: string;
+
+  /** The id for this button. Used for analytics. */
+  id?: number;
+
+  /** Remove all event subscriptions from this button. */
+  removeAllSubscriptions(): void;
 
   /**
-   * Logs that the user clicked the given in-app message. This is done automatically when the user clicks 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
+   * Remove an event subscription that you previously subscribed to.
    *
-   * @returns Whether or not the event was successfully logged (to be flushed later).
+   * @param subscriptionGuid - The identifier of the subscription you wish to remove, returned by the method
+   *    you initially used to create it.
    */
-  export function logInAppMessageClick(inAppMessage: InAppMessage): boolean;
+  removeSubscription(subscriptionGuid: string): void;
 
   /**
-   * 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 `showInAppMessage`, and should
-   *    only be called if you're bypassing that method and manually displaying the message in your own code.
+   * Subscribe to receive click events on this button. The subscriber callback will be called whenever this button is
+   *  clicked by the user.
    *
-   * @param inAppMessage - The message that was clicked
-   * @param buttonId - A button id to associate this click with for analytics
-   * @param url - The url that was clicked
+   * @param subscriber - The callback function to receive click events. This function will be invoked with
+   *    no arguments when this button records a click.
    *
-   * @returns Whether or not the event was successfully logged (to be flushed later).
+   * @returns The identifier of the subscription created. This can be passed to `removeSubscription`
+   *    to cancel the subscription. Returns null if the subscriber passed is not a function.
    */
-  export function logInAppMessageHtmlClick(
-    inAppMessage: HtmlMessage,
-    buttonId?: string,
-    url?: string
-  ): boolean;
+  subscribeToClickedEvent(subscriber: () => void): string | null;
+}
+
+export interface FeatureFlagStringProperty {
+  type: "string";
+  value: string;
+}
+
+export interface FeatureFlagNumberProperty {
+  type: "number";
+  value: number;
+}
+
+export interface FeatureFlagBooleanProperty {
+  type: "boolean";
+  value: boolean;
+}
+
+export class FeatureFlag {
+  /** Indicates whether or not this feature flag is enabled. */
+  enabled: boolean;
+
+  /** Properties of this feature flag, listed as key-value pairs. */
+  properties: Partial<
+    Record<
+      string,
+      | FeatureFlagStringProperty
+      | FeatureFlagNumberProperty
+      | FeatureFlagBooleanProperty
+    >
+  >;
+
+  /** The ID for this feature flag. */
+  id: string;
 
   /**
-   * 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.
+   * Get value of a feature flag property of type string.
    *
-   * @param inAppMessage
+   * @param key - The key of the property.
    *
-   * @returns Whether or not the event was successfully logged (to be flushed later).
+   * @returns The value of the property if the key is found and is of type string.
+   *    If the key is not found or if there is a type mismatch, this method will return a null.
    */
-  export function logInAppMessageImpression(
-    inAppMessage: InAppMessage | ControlMessage
-  ): boolean;
+  getStringProperty(key: string): string | null;
 
   /**
-   * Reports that the current user made an in-app purchase. Useful for tracking and segmenting users.
-   *
-   * @param productId - A string identifier for the product purchased, e.g. an SKU. Value is limited to
-   *      255 characters in length, cannot begin with a $, and can only contain alphanumeric characters and punctuation.
-   * @param price - The price paid. Base units depend on the currency. As an example, USD should be
-   *      reported as Dollars.Cents, whereas JPY should be reported as a whole number of Yen. All provided
-   *      values will be rounded to two digits with toFixed(2)
-   * @param currencyCode - Default USD. Currencies should be represented as an ISO 4217 currency code. Supported
-   *      currency symbols include: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF,
-   *      BMD, BND, BOB, BRL, BSD, BTC, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUC, CUP, CVE,
-   *      CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD,
-   *      HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW,
-   *      KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MTL,
-   *      MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR,
-   *      RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, STD, SVC, SYP, SZL, THB, TJS, TMT,
-   *      TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XCD, XDR, XOF,
-   *      XPD, XPF, XPT, YER, ZAR, ZMK, ZMW, and ZWL. Any other provided currency symbol will result in a logged
-   *      warning and no other action taken by the SDK.
-   * @param quantity - Default 1. The quantity of items purchased expressed as a whole number. Must be at least 1
-   *      and at most 100.
-   * @param purchaseProperties - Hash of properties for this purchase. 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, or null. Total size of purchase properties cannot exceed 50KB.
-   *
-   * @returns Whether or not the purchase was successfully attached to the session (to be flushed later).
-   */
-  export function logPurchase(
-    productId: string,
-    price: number,
-    currencyCode?: string,
-    quantity?: number,
-    purchaseProperties?: object
-  ): boolean;
-
-  /**
-   * Opens a new session, or resumes the previous session if this browser had activity within the `sessionTimeoutInSeconds` value.
-   * When a new session is opened, this refreshes In-App Messages. Content Cards are refreshed automatically if
-   * the `subscribeToContentCardsUpdates` has been registered prior to `openSession`. If the user has previously
-   * granted the site permission to send push, automatically sends the push registration to the Braze backend.
-   * 
-   * Be sure to call `openSession` at the end of your initialization code section, after any calls to `changeUser` or subscribing to Content Cards, 
-   * In-App Message, and Feature Flag updates. Calling `openSession` before `changeUser` may result in a second session start event.
+   * Get value of a feature flag property of type number.
+   *
+   * @param key - The key of the property.
+   *
+   * @returns The value of the property if the key is found and is of type number.
+   *    If the key is not found or if there is a type mismatch, this method will return a null.
    */
-  export function openSession(): void;
+  getNumberProperty(key: string): number | null;
 
   /**
-   * 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
-   *      `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:
-   *
-   * - Your site must be https
-   * - 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/4.8/service-worker.js');
-   * ```
+   * Get value of a feature flag property of type boolean.
    *
-   * For more details, see [Our Product Documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/push_notifications/integration).
+   * @param key - The key of the property.
    *
-   * @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).
-   * @param deniedCallback - If push permission is denied or an error is encountered while registering, this callback will
-   *    be invoked. If the denial is temporary, it will be invoked with a parameter of `true` - otherwise it will be invoked
-   *    with a parameter of `false`.
+   * @returns The value of the property if the key is found and is of type boolean.
+   *    If the key is not found or if there is a type mismatch, this method will return a null.
    */
-  export function requestPushPermission(
-    successCallback?: (
-      endpoint: string,
-      publicKey: string,
-      userAuth: string
-    ) => void,
-    deniedCallback?: (temporaryDenial: boolean) => void
-  ): void;
-
+  getBooleanProperty(key: string): boolean | null;
+}
+
+/**
+ * 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.
+ */
+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.
+ */
+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.
+ */
+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.
+ */
+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  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
+ * @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;
+
+/**
+ * Defers the display of given in-app message for a future pageload.
+ * The deferred in-app message can be retrieved by calling `getDeferredInAppMessage`,
+ *  and displayed using `showInAppMessage`.
+ *  Deferring an in-app message will overwrite any previously deferred in-app message.
+ *
+ * Note: Be sure to subscribe to clicked / dismissed events on this in-app message only after retrieving it using `getDeferredInAppMessage`.
+ *  Any subscriptions made before calling `deferInAppMessage` will not be persisted.
+ *  Also note that the in-app message deferred here will be cleared out when in-app message triggers have been refreshed from the Braze backend.
+ *
+ * @param inAppMessage - The message to defer for later display.
+ *
+ * @returns Whether or not the message was successfully deferred.
+ * Returns undefined if the SDK has not been initialized.
+ */
+export function deferInAppMessage(
+  inAppMessage: InAppMessage,
+): boolean | undefined;
+
+/**
+ * Retrieves the in-app message that was most recently deferred for display with `deferInAppMessage`.
+ *
+ * Note: Retrieving the deferred in-app message here will clear it from storage.
+ *
+ * @returns The deferred in-app message if it exists, or returns null.
+ * Returns undefined if the SDK has not been initialized.
+ */
+export function getDeferredInAppMessage(): InAppMessage | null | undefined;
+
+/**
+ * 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
+ *    with a unique ID, which enables the following:
+ *
+ *    - If the same user is identified on another device, their user profile, usage history and event history will
+ *        be shared across devices.
+ *    - If your app is used on the same browser by multiple people, you can assign each of them a unique identifier
+ *        to track them separately. Only the most recent user on a particular browser will receive push
+ *        notifications and in-app messages.
+ *
+ * When you request a user switch (which is any call to changeUser where the new user ID is not the same as the
+ *    existing user ID), the current session for the previous user (anonymous or not) is automatically ended and
+ *    a new session is started. Similarly, following a call to changeUser, any events which fire are guaranteed to
+ *    be for the new user -- if an in-flight server request completes for the old user after the user switch no
+ *    events will fire, so you do not need to worry about filtering out events from Braze for old users.
+ *
+ * Additionally, if you identify a user which has never been identified on another device, the entire history of
+ *    that user as an "anonymous" user on this device will be preserved and associated with the newly identified
+ *    user. However, if you identify a user which *has* been identified in another app, any history which was
+ *    already flushed to the server for the anonymous user on this device will become orphaned and will not be
+ *    associated with any future users. These orphaned users are not considered in your user counts and will not
+ *    be messaged.
+ *
+ * Note: Once you identify a user, you cannot revert to the "anonymous" user. The transition from anonymous to
+ *    identified tracking is only allowed once because the initial anonymous user receives special treatment to
+ *    allow for preservation of their history. As a result, we recommend against changing the user ID just because
+ *    your app has entered a "logged out" state because it makes you unable to target the previously logged out user
+ *    with re-engagement campaigns. If you anticipate multiple users on the same device, but only want to target one
+ *    of them when your app is in a logged out state, we recommend separately keeping track of the user ID you want
+ *    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.
+ */
+export function changeUser(userId: string, signature?: string): void;
+
+/**
+ * Destroys this `braze` instance, destroying all subscription callbacks and releasing member variables which
+ *    retain memory.
+ */
+export function destroy(): void;
+
+/**
+ * Get all currently available cards from the last content cards refresh.
+ *
+ * @returns - A `ContentCards` object which includes all currently available
+ *    `Card` objects from the last content cards refresh.
+ */
+export function getCachedContentCards(): ContentCards;
+
+/**
+ * Get all unexpired cards from the last news feed refresh.
+ *
+ * @returns - A `Feed` object which includes all unexpired `Card` objects from the last
+ *    news feed refresh.
+ */
+export function getCachedFeed(): Feed;
+
+/**
+ * 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:
+ *
+ * ```
+ * console.log('The device id is ' + braze.getDeviceId());
+ * ```
+ */
+export function getDeviceId(): string | undefined;
+/**
+ * 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:
+ *
+ * ```
+ * braze.getDeviceId(function(deviceId) {
+ *    console.log('The device id is ' + deviceId);
+ * });
+ * ```
+ * @deprecated - The getDeviceId callback is deprecated. Access the method's return value directly instead.
+ * @param callback - Asynchronous callback - this will be invoked with the deviceId.
+ */
+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. Returns undefined if the
+ *    SDK has not been initialized.
+ */
+export function getUser(): User | undefined;
+
+/**
+ * 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.braze.com/app_settings/app_settings).
+ * @param options - Configuration options. See `InitializationOptions` for supported options.
+ *
+ * @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.
+ */
+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.
+ *    Returns undefined if the SDK has not been initialized.
+ */
+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
+ *    `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,
+ *    `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.
+ */
+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 undefined if the SDK has not been initialized.
+ */
+export function isPushSupported(): boolean | undefined;
+
+/**
+ * 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.
+ *
+ * @param card - the `Card` object that received a click
+ * @param forContentCards - whether to log this as a content cards event (as opposed to the legacy news feed)
+ *
+ * @returns Whether or not the event was successfully logged (to be flushed later).
+ */
+export function logCardClick(card: Card, forContentCards?: boolean): boolean;
+
+/**
+ * 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.
+ *
+ * @param card - the `Card` object that received a dismissal
+ *
+ * @returns Whether or not the event was successfully logged (to be flushed later).
+ */
+export function logCardDismissal(card: Card): boolean;
+
+/**
+ * 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.
+ *
+ * @param cards - array of `Card` objects that received impressions
+ * @param forContentCards - whether to log this as a content cards event (as opposed to the legacy news feed)
+ *
+ * @returns Whether or not the event was successfully logged (to be flushed later).
+ */
+export function logCardImpressions(
+  cards: Card[],
+  forContentCards?: boolean,
+): boolean;
+
+/**
+ * A convenient method to log that the user saw the given Content Cards. This method is equivalent to
+ *    calling [`logCardImpressions` method with `forContentCards` param set to true.
+ *    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 content cards in
+ *    your own code.
+ *
+ * @param contentCards - array of `Card` objects that received impressions
+ *
+ * @returns Whether or not the event was successfully logged (to be flushed later).
+ */
+export function logContentCardImpressions(contentCards: Card[]): boolean;
+
+/**
+ * A convenient method to log when user clicks on a Content Card. This method is equivalent to
+ *    calling [`logCardClick` method with `forContentCards` param set to true.
+ *    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 content cards in
+ *    your own code.
+ *
+ * @param contentCard - the `Card` object that received a click
+ *
+ * @returns Whether or not the event was successfully logged (to be flushed later).
+ */
+export function logContentCardClick(contentCard: Card): boolean;
+
+/**
+ * @deprecated This method has been deprecated and is currently a no-op.
+ */
+export function logContentCardsDisplayed(): boolean;
+
+/**
+ * Reports that the current user performed a custom named event.
+ *
+ * @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,
+ *      or null. Total size of event properties cannot exceed 50KB.
+ *
+ * @returns Whether or not the event was successfully logged (to be flushed later).
+ */
+export function logCustomEvent(
+  eventName: string,
+  eventProperties?: object,
+): boolean;
+
+/**
+ * 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.
+ */
+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 `showInAppMessage`,
+ *    and should only be called if you're bypassing that method and manually displaying the message in your own
+ *    code.
+ *
+ * @param button - The button clicked
+ * @param inAppMessage - The message this button belongs to
+ *
+ * @returns Whether or not the event was successfully logged (to be flushed later).
+ */
+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 `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).
+ */
+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 `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
+ * @param buttonId - A button id to associate this click with for analytics
+ * @param url - The url that was clicked
+ *
+ * @returns Whether or not the event was successfully logged (to be flushed later).
+ */
+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 `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).
+ */
+export function logInAppMessageImpression(
+  inAppMessage: InAppMessage | ControlMessage,
+): boolean;
+
+/**
+ * Reports that the current user made an in-app purchase. Useful for tracking and segmenting users.
+ *
+ * @param productId - A string identifier for the product purchased, e.g. an SKU. Value is limited to
+ *      255 characters in length, cannot begin with a $, and can only contain alphanumeric characters and punctuation.
+ * @param price - The price paid. Base units depend on the currency. As an example, USD should be
+ *      reported as Dollars.Cents, whereas JPY should be reported as a whole number of Yen. All provided
+ *      values will be rounded to two digits with toFixed(2)
+ * @param currencyCode - Default USD. Currencies should be represented as an ISO 4217 currency code. Supported
+ *      currency symbols include: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF,
+ *      BMD, BND, BOB, BRL, BSD, BTC, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUC, CUP, CVE,
+ *      CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD,
+ *      HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW,
+ *      KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MTL,
+ *      MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR,
+ *      RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, STD, SVC, SYP, SZL, THB, TJS, TMT,
+ *      TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XCD, XDR, XOF,
+ *      XPD, XPF, XPT, YER, ZAR, ZMK, ZMW, and ZWL. Any other provided currency symbol will result in a logged
+ *      warning and no other action taken by the SDK.
+ * @param quantity - Default 1. The quantity of items purchased expressed as a whole number. Must be at least 1
+ *      and at most 100.
+ * @param purchaseProperties - Hash of properties for this purchase. 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, or null. Total size of purchase properties cannot exceed 50KB.
+ *
+ * @returns Whether or not the purchase was successfully attached to the session (to be flushed later).
+ */
+export function logPurchase(
+  productId: string,
+  price: number,
+  currencyCode?: string,
+  quantity?: number,
+  purchaseProperties?: object,
+): boolean;
+
+/**
+ * Opens a new session, or resumes the previous session if this browser had activity within the `sessionTimeoutInSeconds` value.
+ * When a new session is opened, this refreshes In-App Messages. Content Cards are refreshed automatically if
+ * the `subscribeToContentCardsUpdates` has been registered prior to `openSession`. If the user has previously
+ * granted the site permission to send push, automatically sends the push registration to the Braze backend.
+ *
+ * Be sure to call `openSession` at the end of your initialization code section, after any calls to `changeUser` or subscribing to Content Cards,
+ * In-App Message, and Feature Flag updates. Calling `openSession` before `changeUser` may result in a second session start event.
+ */
+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
+ *      `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:
+ *
+ * - Your site must be https
+ * - 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/4.10/service-worker.js');
+ * ```
+ *
+ * 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).
+ * @param deniedCallback - If push permission is denied or an error is encountered while registering, this callback will
+ *    be invoked. If the denial is temporary, it will be invoked with a parameter of `true` - otherwise it will be invoked
+ *    with a parameter of `false`.
+ */
+export function requestPushPermission(
+  successCallback?: (
+    endpoint: string,
+    publicKey: string,
+    userAuth: string,
+  ) => void,
+  deniedCallback?: (temporaryDenial: boolean) => void,
+): void;
+
+/**
+ * Remove all event subscriptions.
+ */
+export function removeAllSubscriptions(): void;
+
+/**
+ * Remove an event subscription that you previously subscribed to.
+ *
+ * @param subscriptionGuid - The identifier of the subscription you wish to remove, returned by the method
+ *    you initially used to create it.
+ */
+export function removeSubscription(subscriptionGuid: string): void;
+
+/**
+ * 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.
+ *
+ * @param successCallback - Callback that is invoked when the content cards refresh request has been successfully completed.
+ *   You should use `subscribeToContentCardsUpdates` to be notified of new cards. This callback is useful for determining when
+ *   a request has completed regardless of whether new cards were returned.
+ * @param errorCallback - Callback that is invoked when an error occurs during the refresh.
+ */
+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
+ *    `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` .
+ */
+export function requestFeedRefresh(): void;
+
+/**
+ * Requests an immediate refresh of feature flags from Braze servers. By default, feature flags are refreshed when
+ *    a new session starts. If you want to refresh feature flags from the server at another time you must call this function.
+ *
+ * @param successCallback - Callback that is invoked when the feature flags refresh request has been successfully completed.
+ *   This callback is useful for determining when a request has completed regardless of whether new feature flags were returned.
+ * @param errorCallback - Callback that is invoked when an error occurs during the refresh.
+ */
+export function refreshFeatureFlags(
+  successCallback?: () => void,
+  errorCallback?: () => void,
+): void;
+
+/**
+ * By default, data logged to Braze through the SDK is queued locally (in HTML 5 localStorage when available, and
+ *    in memory otherwise) and sent to Braze's servers asynchronously on a regular interval (10 seconds when localStorage is available
+ *    and not routinely cleared due to browser privacy features, otherwise 3 seconds). This is done to optimize network usage and
+ *    provide resiliency against network or server outages. This method bypasses the interval and immediately flushes queued data.
+ *
+ * @param callback - Invoked when the flush completes with a boolean parameter that returns
+ *    whether or not the flush was successful. If the flush is unsuccessful, pending data will be
+ *    flushed during the next successful flush.
+ */
+export function requestImmediateDataFlush(
+  callback?: (success: boolean) => void,
+): void;
+
+/**
+ * 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.
+ */
+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.
+ *
+ * @param loggerFunction - A function to invoke with log messages. Should accept a single string
+ *    parameter for message.
+ */
+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`.
+ * This signature will only have an effect if the `enableSdkAuthentication` initialization option is set to true.
+ *
+ * @param signature - The signature to add to network requests to authenticate the current user.
+ *
+ * @returns Whether or not the signature is valid.
+ */
+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
+ * and all subsequent analytics to cease being sent to the Braze backend.
+ * 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.
+ */
+export function disableSDK(): void;
+
+/**
+ * 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
+ *   regardless of whether new cards are available, you should use the `successCallback` of `requestContentCardsRefresh`.
+ *
+ * @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.
+ */
+export function subscribeToContentCardsUpdates(
+  subscriber: (cards: ContentCards) => void,
+): string | undefined;
+
+/**
+ * Subscribe to news feed updates. The subscriber callback will be called whenever the news feed is updated.
+ *
+ * @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 undefined if the SDK has not been initialized.
+ */
+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. 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
+ *
+ * ```
+ * 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 `showInAppMessage`
+ *    with the provided message.
+ *
+ * @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.
+ */
+export function subscribeToInAppMessage(
+  callback: (inAppMessage: InAppMessage | ControlMessage) => void,
+): string | undefined;
+
+/**
+ * Subscribe to be notified of network request failures that occured due to an SDK Authentication error. This
+ * method can be used to determine when to call `setSdkAuthenticationSignature` to provide the SDK with a new signature.
+ * If you do not have SDK Authentication enabled on the Braze dashboard, this subscription will never be invoked.
+ *
+ * @param subscriber - The subscriber function that is invoked whenever an SDK Authentication error occurs. It is
+ *   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 undefined if the SDK has not been initialized.
+ */
+export function subscribeToSdkAuthenticationFailures(
+  subscriber: (error: {
+    errorCode: number;
+    reason?: string;
+    userId?: string;
+    signature?: string;
+  }) => void,
+): string | undefined;
+
+/**
+ * By default, Braze silences its logging to prevent spamming production js consoles. Call this method to
+ *    toggle logging.
+ */
+export function toggleLogging(): void;
+
+/**
+ * Unregisters push notifications on this browser.
+ * Note that for Safari, Apple does not offer any unsubscribe mechanism, so on Safari this method leaves the user
+ *    with push permission granted and simply sets their subscription status to unsubscribed.
+ *
+ * @param successCallback - When the unsubscribe is successfully recorded and processed by Braze, this
+ *    callback will be invoked.
+ * @param errorCallback - If the unsubscribe fails for unknown reasons, this callback will be invoked.
+ */
+export function unregisterPush(
+  successCallback?: () => void,
+  errorCallback?: () => void,
+): void;
+
+/**
+ * Removes all locally stored SDK data, causing the user to be seen in subsequent calls as a new anonymous user on a new device.
+ */
+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;
+
+/**
+ * Gets a feature flag by its ID.
+ *
+ * @param id - The ID of the feature flag.
+ * @returns - An object of type `FeatureFlag`.
+ */
+export function getFeatureFlag(id: string): FeatureFlag;
+
+/**
+ * Subscribe to feature flag updates. The subscriber callback will be called whenever feature flags are updated. This method
+ *   should be called before calling `openSession`.
+ *
+ * @param subscriber - The callback function to handle new feature flags. This function is always called first with the
+ *   available cached list of `FeatureFlag` objects, and will also be called when feature flag updates are available.
+ *   If you want to be notified when a refresh has completed
+ *   regardless of whether new feature flags are available, you should use the `successCallback` of `refreshFeatureFlags`.
+ *
+ * @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.
+ */
+export function subscribeToFeatureFlagsUpdates(
+  subscriber: (featureFlags: FeatureFlag[]) => void,
+): string | undefined;
+
+/**
+ * Gets all available feature flags.
+ *
+ * @returns - A list of `FeatureFlag` objects.
+ */
+export function getAllFeatureFlags(): FeatureFlag[];
+
+/**
+ * Logs impression for a given feature flag.
+ *
+ * @param featureFlagId - ID of the feature flag that has received the impression.
+ *
+ * @returns - Whether or not the impression was successfully logged. Returns undefined if the SDK has not been initialized.
+ */
+export function logFeatureFlagImpression(
+  featureFlagId: string,
+): boolean | undefined;
+
+/**
+ * Supported initialization options
+ *
+ */
+export type InitializationOptions = {
   /**
-   * Remove all event subscriptions.
+   * 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.
+   *   However, if you want Braze to log activity from these crawlers instead, you may set this option to true.
    */
-  export function removeAllSubscriptions(): void;
-
+  allowCrawlerActivity?: boolean;
   /**
-   * Remove an event subscription that you previously subscribed to.
-   *
-   * @param subscriptionGuid - The identifier of the subscription you wish to remove, returned by the method
-   *    you initially used to create it.
+   * By default, the Braze Web SDK does not allow user-supplied Javascript click actions, as it allows Braze dashboard
+   *   users to run Javascript on your site. To indicate that you trust the Braze dashboard users to write non-malicious
+   *   Javascript click actions, set this property to true. If `enableHtmlInAppMessages` is true, this option will also be
+   *   set to true.
    */
-  export function removeSubscription(subscriptionGuid: string): void;
-
+  allowUserSuppliedJavascript?: boolean;
   /**
-   * 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.
-   *
-   * @param successCallback - Callback that is invoked when the content cards refresh request has been successfully completed.
-   *   You should use `subscribeToContentCardsUpdates` to be notified of new cards. This callback is useful for determining when
-   *   a request has completed regardless of whether new cards were returned.
-   * @param errorCallback - Callback that is invoked when an error occurs during the refresh.
+   * If you provide a value for this option, user events sent to Braze will be associated with the given version, which can be
+   *   used for user segmentation.
    */
-  export function requestContentCardsRefresh(successCallback?: () => void, errorCallback?: () => void): void;
-
+  appVersion?: string;
   /**
-   * Requests an immediate refresh of the news feed from Braze servers. By default, the news feed is refreshed on
-   *    `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` .
+   * A numerical app version value which can be used for user segmentation. This value must be sent with four fields, such as
+   * "1.2.3.4", otherwise it will be ignored.
    */
-  export function requestFeedRefresh(): void;
-
+  appVersionNumber?: string;
   /**
-   * Requests an immediate refresh of feature flags from Braze servers. By default, feature flags are refreshed when
-   *    a new session starts. If you want to refresh feature flags from the server at another time you must call this function.
-   *
-   * @param successCallback - Callback that is invoked when the feature flags refresh request has been successfully completed.
-   *   This callback is useful for determining when a request has completed regardless of whether new feature flags were returned.
-   * @param errorCallback - Callback that is invoked when an error occurs during the refresh.
+   * This option is required to configure the Braze Web SDK to use the appropriate endpoint for your integration - for example:
+   *  ```
+   *    braze.initialize('YOUR-API-KEY-HERE', { baseUrl: 'sdk.iad-03.braze.com' })
+   *  ```
    */
-  export function refreshFeatureFlags(successCallback?: () => void, errorCallback?: () => void): void;
-
+  baseUrl: string;
   /**
-   * By default, data logged to Braze through the SDK is queued locally (in HTML 5 localStorage when available, and
-   *    in memory otherwise) and sent to Braze's servers asynchronously on a regular interval (10 seconds when localStorage is available
-   *    and not routinely cleared due to browser privacy features, otherwise 3 seconds). This is done to optimize network usage and
-   *    provide resiliency against network or server outages. This method bypasses the interval and immediately flushes queued data.
-   *
-   * @param callback - Invoked when the flush completes with a boolean parameter that returns
-   *    whether or not the flush was successful. If the flush is unsuccessful, pending data will be
-   *    flushed during the next successful flush.
+   * If you provide a value for this option, the Braze SDK will add the nonce to any `<script>` and `<style>` elements created by
+   *   the SDK. This can be used to permit the Braze SDK to work with your website's [Content Security Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP).
+   *   Note that in addition to setting this nonce, you may also need to allow FontAwesome to load, which you can do by either adding
+   *   `use.fontawesome.com` to your Content Security Policy allowlist or by using the `doNotLoadFontAwesome` option and loading it manually.
    */
-  export function requestImmediateDataFlush(
-    callback?: (success: boolean) => void
-  ): void;
-
+  contentSecurityNonce?: string;
   /**
-   * 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.
+   * By default, the Braze SDK automatically detects and collects all device properties in `DeviceProperties`. To override
+   *   this behavior, provide an array of `DeviceProperties`. To disable all properties being sent to Braze servers, provide
+   *   an empty array. Note that without some properties, not all features will function properly. For instance, without the time
+   *   zone, local timezone delivery will not function.
    */
-  export function enableSDK(): void;
-
+  devicePropertyAllowlist?: string[];
   /**
-   * Getter method to determine if the SDK is disabled based on whether the cookie set by `disableSdk` exists
+   * 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.
    */
-  export function isDisabled(): boolean;
-
+  disablePushTokenMaintenance?: boolean;
   /**
-   * By default, Braze logs to the browser console. Call this method to set a custom log action and enable debug-level log statements.
-   *
-   * @param loggerFunction - A function to invoke with log messages. Should accept a single string
-   *    parameter for message.
+   * Braze uses [Font Awesome](http://fontawesome.io) for in-app message icons. By default, Braze will automatically load
+   *   FontAwesome 4.7.0 from the FontAwesome CDN. To disable this behavior (e.g. because your site uses a customized version
+   *   of FontAwesome), set this option to `true`. Note that if you do this, you are responsible for ensuring that FontAwesome
+   *   is loaded on your site - otherwise in-app messages may not render correctly.
    */
-  export function setLogger(loggerFunction: (message: string) => void): void;
-
+  doNotLoadFontAwesome?: boolean;
   /**
-   * Sets the signature to be used to authenticate the current user. You can also set the signature when calling `changeUser`.
-   * This signature will only have an effect if the `enableSdkAuthentication` initialization option is set to true.
-   *
-   * @param signature - The signature to add to network requests to authenticate the current user.
+   * By default, the Braze Web SDK does not enable HTML in-app messages, as they allow Braze dashboard users to run Javascript
+   *   on your site. To indicate that you trust the Braze dashboard users to write non-malicious HTML in-app messages, set this
+   *   property to true. If `allowUserSuppliedJavascript` is set to true, this option will also be set to true.
    *
-   * @returns Whether or not the signature is valid.
+   * @deprecated This initialization option is deprecated in favor of `allowUserSuppliedJavascript`.
    */
-  export function setSdkAuthenticationSignature(signature: string): boolean;
-
+  enableHtmlInAppMessages?: 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.
+   * 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 `setLogger` before you release
+   *   your page to production.
    */
-  export function addSdkMetadata(sdkMetadata: string[]): boolean;
-
+  enableLogging?: boolean;
   /**
-   * Sets a cookie that causes all subsequent calls to the Braze Web SDK to be ignored
-   * and all subsequent analytics to cease being sent to the Braze backend.
-   * 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.
+   * Set to true to enable the SDK Authentication feature. For more information about SDK Authentication, see our
+   * [Product Documentation](https://www.braze.com/docs/developer_guide/platform_wide/sdk_authentication/).
    */
-  export function disableSDK(): void;
-
+  enableSdkAuthentication?: boolean;
   /**
-   * 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
-   *   regardless of whether new cards are available, you should use the `successCallback` of `requestContentCardsRefresh`.
-   *
-   * @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.
+   * 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.
    */
-  export function subscribeToContentCardsUpdates(
-    subscriber: (cards: ContentCards) => void
-  ): string | undefined;
-
+  inAppMessageZIndex?: number;
   /**
-   * Subscribe to news feed updates. The subscriber callback will be called whenever the news feed is updated.
-   *
-   * @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 undefined if the SDK has not been initialized.
+   * By default, any SDK-generated user-visible messages will be displayed in the user's browser language. Provide a value for this
+   *   option to override that behavior and force a specific language. The value for this option should be a
+   *   [ISO 639-1 Language Code](https://www.w3schools.com/tags/ref_language_codes.asp). If a desired localization is not available,
+   *   the SDK will default to English. See also `User.setLanguage` for setting the language you use within the Braze dashboard to
+   *   localize your own messaging content.
    */
-  export function subscribeToFeedUpdates(
-    subscriber: (feed: Feed) => void
-  ): string | undefined;
-
+  localization?: string;
   /**
-   * Subscribe to receive in-app messages. The subscriber callback will be called whenever a new in-app message is
-   *    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
-   *
-   * ```
-   * 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 `showInAppMessage`
-   *    with the provided message.
-   *
-   * @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.
+   * 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
+   *   `requestPushPermission`, and ensure that it contains Braze's service worker code, either with
+   *   `self.importScripts('https://js.appboycdn.com/web-sdk-develop/4.10/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.
    */
-  export function subscribeToInAppMessage(
-    callback: (
-      inAppMessage: InAppMessage | ControlMessage
-    ) => void
-  ): string | undefined;
-
+  manageServiceWorkerExternally?: boolean;
   /**
-   * Subscribe to be notified of network request failures that occured due to an SDK Authentication error. This
-   * method can be used to determine when to call `setSdkAuthenticationSignature` to provide the SDK with a new signature.
-   * If you do not have SDK Authentication enabled on the Braze dashboard, this subscription will never be invoked.
-   *
-   * @param subscriber - The subscriber function that is invoked whenever an SDK Authentication error occurs. It is
-   *   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 undefined if the SDK has not been initialized.
+   * By default, a trigger action will only fire if at least 30 seconds have elapsed since the last trigger action. Provide a
+   *   value for this configuration option to override that default with a value of your own. We do not recommend making this
+   *   value any smaller than 10 to avoid spamming the user with notifications.
    */
-  export function subscribeToSdkAuthenticationFailures(subscriber: (
-    error: {
-      errorCode: number,
-      reason?: string,
-      userId?: string,
-      signature?: string
-    }
-  ) => void): string | undefined;
-
-  /**
-   * By default, Braze silences its logging to prevent spamming production js consoles. Call this method to
-   *    toggle logging.
-   */
-  export function toggleLogging(): void;
-
+  minimumIntervalBetweenTriggerActionsInSeconds?: number;
   /**
-   * Unregisters push notifications on this browser.
-   * Note that for Safari, Apple does not offer any unsubscribe mechanism, so on Safari this method leaves the user
-   *    with push permission granted and simply sets their subscription status to unsubscribed.
-   *
-   * @param successCallback - When the unsubscribe is successfully recorded and processed by Braze, this
-   *    callback will be invoked.
-   * @param errorCallback - If the unsubscribe fails for unknown reasons, this callback will be invoked.
+   * By default, the Braze SDK will store small amounts of data (user ids, session ids), in cookies. This is done to allow Braze
+   *   to recognize users and sessions across different subdomains of your site. If this presents a problem for you, pass `true`
+   *   for this option to disable cookie storage and rely entirely on HTML 5 localStorage to identify users and sessions. The downside
+   *   of this configuration is that you will be unable to recognize users across subdomains of your site.
    */
-  export function unregisterPush(
-    successCallback?: () => void,
-    errorCallback?: () => void
-  ): void;
-
+  noCookies?: boolean;
   /**
-   * Removes all locally stored SDK data, causing the user to be seen in subsequent calls as a new anonymous user on a new device.
+   * By default, links from in-app message clicks load in the current tab or a new tab as specified in the dashboard on a
+   *   message-by-message basis. Set this option to `true` to force all links from in-app message clicks open in a new tab or window.
    */
-  export function wipeData(): void;
-
+  openInAppMessagesInNewTab?: boolean;
   /**
-   * 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.
+   * By default, links from `Card` objects load in the current tab or window. Set this option to `true` to make links from
+   *   cards open in a new tab or window.
    */
-  export function handleBrazeAction(url: string, openLinkInNewTab?: boolean): void;
-
+  openCardsInNewTab?: boolean;
   /**
-   * Gets a feature flag by its ID.
-   *
-   * @param id - The ID of the feature flag.
-   * @returns - An object of type `FeatureFlag`.
+   * By default, when an in-app message is showing, pressing the escape button or a click on the greyed-out background of the
+   *   page will dismiss the message. Set this option to `true` to prevent this behavior and require an explicit button click
+   *   to dismiss messages.
    */
-   export function getFeatureFlag(id: string): FeatureFlag;
-
+  requireExplicitInAppMessageDismissal?: boolean;
   /**
-   * Subscribe to feature flag updates. The subscriber callback will be called whenever feature flags are updated. This method
-   *   should be called before calling `openSession`.
-   *
-   * @param subscriber - The callback function to handle new feature flags. This function is always called first with the
-   *   available cached list of `FeatureFlag` objects, and will also be called when feature flag updates are available.
-   *   If you want to be notified when a refresh has completed
-   *   regardless of whether new feature flags are available, you should use the `successCallback` of `refreshFeatureFlags`.
-   *
-   * @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.
+   * If you support Safari push, you must specify this option with the website push ID that you provided to Apple when creating
+   *   your Safari push certificate (starts with "web", e.g. "web.com.example.domain").
    */
-   export function subscribeToFeatureFlagsUpdates(
-    subscriber: (featureFlags: FeatureFlag[]) => void
-  ): string | undefined;
-
+  safariWebsitePushId?: string;
   /**
-   * Gets all available feature flags.
-   *
-   * @returns - A list of `FeatureFlag` objects.
+   * By default, when registering users for web push notifications Braze will look for the required service worker file in the
+   *   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, `requestPushPermission`
+   *   MAY ONLY BE CALLED from web pages that start with `http://yoursite.com/mycustompath/`.
    */
-   export function getAllFeatureFlags(): FeatureFlag[];
-
+  serviceWorkerLocation?: string;
   /**
-   * Supported initialization options
-   *
+   * By default, sessions time out after 30 minutes of inactivity. Provide a value for this configuration option to override that
+   *   default with a value of your own.
    */
-  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.
-     *   However, if you want Braze to log activity from these crawlers instead, you may set this option to true.
-     */
-    allowCrawlerActivity?: boolean;
-    /**
-     * By default, the Braze Web SDK does not allow user-supplied Javascript click actions, as it allows Braze dashboard
-     *   users to run Javascript on your site. To indicate that you trust the Braze dashboard users to write non-malicious
-     *   Javascript click actions, set this property to true. If `enableHtmlInAppMessages` is true, this option will also be
-     *   set to true.
-     */
-    allowUserSuppliedJavascript?: boolean;
-    /**
-     * If you provide a value for this option, user events sent to Braze will be associated with the given version, which can be
-     *   used for user segmentation.
-     */
-    appVersion?: string;
-    /**
-     * This option is required to configure the Braze Web SDK to use the appropriate endpoint for your integration - for example:
-     *  ```
-     *    braze.initialize('YOUR-API-KEY-HERE', { baseUrl: 'sdk.iad-03.braze.com' })
-     *  ```
-     */
-    baseUrl: string;
-    /**
-     * If you provide a value for this option, the Braze SDK will add the nonce to any `<script>` and `<style>` elements created by
-     *   the SDK. This can be used to permit the Braze SDK to work with your website's [Content Security Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP).
-     *   Note that in addition to setting this nonce, you may also need to allow FontAwesome to load, which you can do by either adding
-     *   `use.fontawesome.com` to your Content Security Policy allowlist or by using the `doNotLoadFontAwesome` option and loading it manually.
-     */
-    contentSecurityNonce?: string;
-    /**
-     * By default, the Braze SDK automatically detects and collects all device properties in `DeviceProperties`. To override
-     *   this behavior, provide an array of `DeviceProperties`. To disable all properties being sent to Braze servers, provide
-     *   an empty array. Note that without some properties, not all features will function properly. For instance, without the time
-     *   zone, local timezone delivery will not function.
-     */
-    devicePropertyAllowlist?: string[];
-    /**
-     * 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.
-     */
-    disablePushTokenMaintenance?: boolean;
-    /**
-     * Braze uses [Font Awesome](http://fontawesome.io) for in-app message icons. By default, Braze will automatically load
-     *   FontAwesome 4.7.0 from the FontAwesome CDN. To disable this behavior (e.g. because your site uses a customized version
-     *   of FontAwesome), set this option to `true`. Note that if you do this, you are responsible for ensuring that FontAwesome
-     *   is loaded on your site - otherwise in-app messages may not render correctly.
-     */
-    doNotLoadFontAwesome?: boolean;
-    /**
-     * By default, the Braze Web SDK does not enable HTML in-app messages, as they allow Braze dashboard users to run Javascript
-     *   on your site. To indicate that you trust the Braze dashboard users to write non-malicious HTML in-app messages, set this
-     *   property to true. If `allowUserSuppliedJavascript` is set to true, this option will also be set to true.
-     *
-     * @deprecated This initialization option is deprecated in favor of `allowUserSuppliedJavascript`.
-     */
-    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 `setLogger` before you release
-     *   your page to production.
-     */
-    enableLogging?: boolean;
-    /**
-     * Set to true to enable the SDK Authentication feature. For more information about SDK Authentication, see our
-     * [Product Documentation](https://www.braze.com/docs/developer_guide/platform_wide/sdk_authentication/).
-     */
-    enableSdkAuthentication?: boolean
-    /**
-     * 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
-    /**
-     * By default, any SDK-generated user-visible messages will be displayed in the user's browser language. Provide a value for this
-     *   option to override that behavior and force a specific language. The value for this option should be a
-     *   [ISO 639-1 Language Code](https://www.w3schools.com/tags/ref_language_codes.asp). If a desired localization is not available,
-     *   the SDK will default to English. See also `User.setLanguage` for setting the language you use within the Braze dashboard to
-     *   localize your own messaging content.
-     */
-    localization?: string;
-    /**
-     * 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
-     *   `requestPushPermission`, and ensure that it contains Braze's service worker code, either with
-     *   `self.importScripts('https://js.appboycdn.com/web-sdk-develop/4.8/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;
-    /**
-     * By default, a trigger action will only fire if at least 30 seconds have elapsed since the last trigger action. Provide a
-     *   value for this configuration option to override that default with a value of your own. We do not recommend making this
-     *   value any smaller than 10 to avoid spamming the user with notifications.
-     */
-    minimumIntervalBetweenTriggerActionsInSeconds?: number;
-    /**
-     * By default, the Braze SDK will store small amounts of data (user ids, session ids), in cookies. This is done to allow Braze
-     *   to recognize users and sessions across different subdomains of your site. If this presents a problem for you, pass `true`
-     *   for this option to disable cookie storage and rely entirely on HTML 5 localStorage to identify users and sessions. The downside
-     *   of this configuration is that you will be unable to recognize users across subdomains of your site.
-     */
-    noCookies?: boolean;
-    /**
-     * By default, links from in-app message clicks load in the current tab or a new tab as specified in the dashboard on a
-     *   message-by-message basis. Set this option to `true` to force all links from in-app message clicks open in a new tab or window.
-     */
-    openInAppMessagesInNewTab?: boolean;
-    /**
-     * By default, links from `Card` objects load in the current tab or window. Set this option to `true` to make links from
-     *   cards open in a new tab or window.
-     */
-    openCardsInNewTab?: boolean;
-    /**
-     * By default, when an in-app message is showing, pressing the escape button or a click on the greyed-out background of the
-     *   page will dismiss the message. Set this option to `true` to prevent this behavior and require an explicit button click
-     *   to dismiss messages.
-     */
-    requireExplicitInAppMessageDismissal?: boolean;
-    /**
-     * If you support Safari push, you must specify this option with the website push ID that you provided to Apple when creating
-     *   your Safari push certificate (starts with "web", e.g. "web.com.example.domain").
-     */
-    safariWebsitePushId?: string;
-    /**
-     * By default, when registering users for web push notifications Braze will look for the required service worker file in the
-     *   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, `requestPushPermission`
-     *   MAY ONLY BE CALLED from web pages that start with `http://yoursite.com/mycustompath/`.
-     */
-    serviceWorkerLocation?: string;
-    /**
-     * By default, sessions time out after 30 minutes of inactivity. Provide a value for this configuration option to override that
-     *   default with a value of your own.
-     */
-    sessionTimeoutInSeconds?: number;
-  };
+  sessionTimeoutInSeconds?: number;
+};