chore: 🐝 Update Specs - Merge speakeasy code samples

.env.local

@@ -0,0 +1 @@
+NEXT_PUBLIC_INTERCOM_ID=fqe0apnx

.eslintrc.json

@@ -0,0 +1,15 @@
+{
+  "extends": [
+    "eslint:recommended",
+    "plugin:mdx/recommended"
+  ],
+  // optional, if you want to lint code blocks at the same time
+  "settings": {
+    "mdx/code-blocks": false
+  },
+  "rules": {
+    "no-undef": "off",
+    "no-unused-expressions": "off",
+    "no-unused-vars": "off"
+  }
+}

.github/workflows/invalidate-framework-snippet.yml

@@ -0,0 +1,18 @@
+name: Invalidate Framework Snippet Cache
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - next
+      - main
+    paths:
+      - "framework-terminal.js"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - run: "curl -X GET https://purge.jsdelivr.net/gh/novuhq/docs/framework-terminal.min.js"
+      - run: "curl -X GET https://purge.jsdelivr.net/gh/novuhq/docs/framework-terminal.js"

.github/workflows/merge_speakeasy_code_samples.yaml

@@ -0,0 +1,25 @@
+name: Merge speakeasy code samples
+permissions:
+  checks: write
+  contents: write
+  pull-requests: write
+  statuses: write
+"on":
+  workflow_dispatch:
+    inputs:
+      force:
+        description: Force merge OpenAPI spec and code samples
+        type: boolean
+        default: false
+  schedule:
+    - cron: 0 0 * * *
+jobs:
+  generate:
+    uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
+    with:
+      force: ${{ github.event.inputs.force }}
+      mode: pr
+      speakeasy_version: latest
+    secrets:
+      github_access_token: ${{ secrets.GITHUB_TOKEN }}
+      speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}

.gitignore

@@ -0,0 +1,5 @@
+node_modules
+package-lock.json
+package.json 
+.idea
+.DS_Store

.nvmrc

@@ -0,0 +1 @@
+18.17.0

.prettierignore

@@ -0,0 +1,3 @@
+# Ignore all HTML files:
+script.js
+hubspot.js

.speakeasy/workflow.lock

@@ -0,0 +1,24 @@
+speakeasyVersion: 1.507.0
+sources:
+    openapi-with-code-samples:
+        sourceNamespace: openapi-with-code-samples
+        sourceRevisionDigest: sha256:e6ec39d2339730190a00be1dcd156556b7445abfea19c77c6b45dd17b8bf233d
+        sourceBlobDigest: sha256:74f4428e678bcc42a7a4bcbf97885069d7a6b0173368590c2453a07e3b00f4cf
+        tags:
+            - latest
+            - speakeasy-sdk-regen-1721694309
+            - "1.0"
+targets: {}
+workflow:
+    workflowVersion: 1.0.0
+    speakeasyVersion: latest
+    sources:
+        openapi-with-code-samples:
+            inputs:
+                - location: registry.speakeasyapi.dev/novu/novu/json-development:main
+            overlays:
+                - location: registry.speakeasyapi.dev/novu/novu/code-samples-typescript:main
+            output: ./openapi.json
+            registry:
+                location: registry.speakeasyapi.dev/novu/novu/openapi-with-code-samples
+    targets: {}

.speakeasy/workflow.yaml

@@ -0,0 +1,12 @@
+workflowVersion: 1.0.0
+speakeasyVersion: latest
+sources:
+    openapi-with-code-samples:
+        inputs:
+            - location: registry.speakeasyapi.dev/novu/novu/json-development:main
+        overlays:
+            - location: registry.speakeasyapi.dev/novu/novu/code-samples-typescript:main
+        output: ./openapi.json
+        registry:
+            location: registry.speakeasyapi.dev/novu/novu/openapi-with-code-samples
+targets: {}

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "cSpell.words": [
+        "topbar"
+    ],
+    "editor.tabSize": 2,
+    "editor.insertSpaces": true
+}

.vscode/tasks.json

@@ -0,0 +1,13 @@
+{
+    // For more information, visit: https://go.microsoft.com/fwlink/?LinkId=733558
+    "version": "2.0.0",
+    "tasks": [
+      {
+        "type": "shell",
+        "command": "mintlify dev",
+        "isBackground": true,
+        "label": "DOCS"
+      }
+    ]
+  }
+

README.md

@@ -1,34 +1,82 @@
-# Mintlify Starter Kit - Novu docs
+<div align="center">
+  <a href="https://novu.co" target="_blank">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/2233092/213641039-220ac15f-f367-4d13-9eaf-56e79433b8c1.png" />
+    <img src="https://user-images.githubusercontent.com/2233092/213641043-3bbb3f21-3c53-4e67-afe5-755aeb222159.png" width="280" alt="Logo"/>
+  </picture>
+  </a>
+</div>
 
-Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including
+<h1 align="center">The open-source notification infrastructure for developers</h1>
 
-- Guide pages
-- Navigation
-- Customizations
-- API Reference pages
-- Use of popular components
+<div align="center">
+The ultimate service for managing multi-channel notifications with a single API.
+</div>
 
-### 👩‍💻 Development
+  <p align="center">
+    <br />
+    <a href="https://docs.novu.co" rel="dofollow"><strong>Explore the docs »</strong></a>
+    <br />
+ </p>
 
-Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command
+  <br/>
+
+  <p align="center">  
+    <a href="https://discord.novu.co">Join Our Discord</a>
+    ·
+    <a href="https://roadmap.novu.co">Roadmap</a>
+    ·
+    <a href="https://twitter.com/novuhq">X</a>
+    ·
+    <a href="https://notifications.directory">Notifications Directory</a>
+  </p>
+
+  <p align="center">
+  Available in: <a href="https://github.com/novuhq/novu-ts">Node.js</a>
+  · <a href="https://github.com/novuhq/novu-py">Python</a>
+  · <a href="https://github.com/novuhq/novu-go">Go</a>
+  · <a href="https://github.com/novuhq/novu-php">PHP</a>
+
+
+  </p>
+
+### 👩‍💻 Docs Contribution
+
+First, install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) locally. To install, use the following command
 
 ```
 npm i -g mintlify
 ```
 
-Run the following command at the root of your documentation (where mint.json is)
+**Note**: Please install Node.js (version 18 or higher) before proceeding.
+
+Run the following command at the root of the documentation (where mint.json is) to preview the documentation changes
 
 ```
 mintlify dev
 ```
 
 ### 😎 Publishing Changes
 
-Changes will be deployed to production automatically after pushing to the default branch.
-
-You can also preview changes using PRs, which generates a preview link of the docs.
+All changes to the docs should be submitted against the `main` branch. Once reviewed and merged, the changes will be deployed to production automatically.
 
-#### Troubleshooting
+### Troubleshooting
 
 - Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
-- Page loads as a 404 - Make sure you are running in a folder with `mint.json`
+- Page loads as a 404 - Make sure you are running in a folder with `docs.json`
+
+### Community SDKs
+
+These SDKs are maintained by the community.
+
+- <a href="https://github.com/novuhq/novu-ruby">Ruby</a>
+-  <a href="https://github.com/novuhq/novu-laravel">Laravel</a>
+- <a href="https://github.com/novuhq/novu-java">Java</a>
+- <a href="https://github.com/novuhq/novu-dotnet">.NET</a>
+- <a href="https://github.com/novuhq/elixir">Elixir</a>
+- <a href="https://github.com/novuhq/rust">Rust</a>
+- <a href="https://github.com/novuhq/novu-kotlin">Kotlin</a>
+
+### Report an issue
+
+If you have found a bug, please report it by opening an issue on this [GitHub repository](https://github.com/novuhq/docs/issues) or by contacting us via email at [email protected].

account/authentication.mdx

@@ -0,0 +1,44 @@
+---
+title: "Authentication"
+description: "Novu supports advanced user authentication capabilities like OAuth, SSO, MFA and more, providing enterprise customers with a robust, secure, and user-friendly authentication solution."
+---
+
+<Note>
+This feature is only available to Enterprise customers on our [Cloud platform](https://dashboard-v2.novu.co/?utm_campaign=docs_account_authentication). For more information, please see our [Enterprise plan](https://novu.co/pricing) in the pricing page.
+</Note>
+
+## Key capabilities
+
+### Out-of-the-box OAuth providers
+
+Currently providing authentication via Github, with the plan to expand to a number of other providers such as:
+- Google
+- Facebook
+- Apple
+- Microsoft
+- LinkedIn
+
+### SSO, SAML and OpenID connect
+
+Novu provides a streamlined implementation of SAML and OpenID Connect protocols, allowing integration with a wide range of enterprise IdPs. Arrange setup of known providers like Okta, Microsoft Entra ID, Google workspace or a custom SSO provider. 
+
+Novu adheres to industry-standard security protocols to ensure secure and reliable user authentication.
+
+### Advanced security features
+
+- **Multi-Factor Authentication (MFA):** Robust MFA options including SMS passcodes, authenticator apps, hardware keys, and recovery codes, enhancing security and reducing the risk of unauthorized access.
+
+- **Session Management:** Comprehensive session management features including active device monitoring, session revocation, and adaptive session durations to balance security and user convenience.
+
+### User management and customization
+
+- Roles and permissions: Detailed control over user roles and permissions to tailor access levels and ensure appropriate access control.
+- User invitations and Onboarding: Smooth onboarding processes with customizable invitation workflows, ensuring a positive initial user experience.
+- Profile management: Intuitive profile management for users to update their information and authentication methods easily.
+
+### Enterprise benefits
+
+- Scalability and flexibility: Solutions that grow with your enterprise, offering flexibility to adapt to evolving needs.
+- Streamlined user management: Centralized user access control reduces administrative effort and complexity.
+- Compliance and security: Meets stringent security standards, protecting sensitive data and ensuring regulatory compliance.
+- Enhanced User experience: Simplified and secure authentication processes improve productivity and user satisfaction.

account/billing.mdx

@@ -0,0 +1,22 @@
+---
+title: "Billing and Payments"
+sidebarTitle: "Billing"
+description: "Manage your billing and payment information, view invoices, and upgrade your subscription plan."
+---
+
+
+## Frequently Asked Questions
+
+### How do I purchase the business or enterprise tier?
+Business or enterprise tier subscriptions can be purchased from billing settings in the Novu dashboard. Click on the avatar icon in the top right corner of the dashboard, then click on **Billing Plans** in the left side menu to access the billing settings. From there, you can select the desired subscription tier and complete the purchase.
+
+<Frame caption="Upgrade subscription from billing settings">
+  <img src="/images/account/billing/purchase-business-tier.gif" />
+</Frame>
+
+### How to access past invoices?
+Past invoices can be accessed from the billing settings in the Novu dashboard. Click on the avatar icon in the top right corner of the dashboard, then click on **Billing Plans** on the side menu to access the billing settings. From there, click on the **Manage Subscription** option in your subscribed tier to view past invoices.
+
+<Frame caption="Access past invoices using manage subscription option">
+  <img src="/images/account/billing/manage-invoices.gif" />
+</Frame>

account/sso.mdx

@@ -0,0 +1,19 @@
+---
+title: "Single Sign-On (SSO) for your account"
+sidebarTitle: "SAML SSO"
+description: "Learn how to enable Single Sign-On (SSO) for your account."
+---
+
+<Note>
+This feature is only available to Enterprise customers on our Cloud platform. For more information, please visit our [Enterprise Plan](https://novu.co/pricing) page.
+</Note>
+
+Novu provides a SAML SSO (Single Sign-On) integration, enabling you to authenticate your organization's users with your existing SAML infrastructure.
+
+Novu is compatible with any SAML 2.0 compliant Identity Provider (IdP), including but not limited to:
+- Okta
+- Microsoft Entra ID (formerly Azure AD)
+- Google Workspace
+- Any other SAML 2.0 compliant IdP
+
+To enable SAML SSO for your account, please reach out to your account manager or contact us at [[email protected]](mailto:[email protected]).

additional-resources/data-migrations.mdx

@@ -0,0 +1,42 @@
+---
+title: "Data Migrations"
+description: "Learn how to update your database data through migrations."
+icon: "database"
+---
+
+On occasion, Novu may introduce features that require changes to the database schema or data.
+This usually happens when a feature has a hard dependency on some data being available on a database entity.
+You can use migrations to make these changes to your database.
+
+## Running Migrations
+
+To run data migrations, enter the following sequence of commands in your terminal from the [`novuhq/novu`](https://github.com/novuhq/novu) repository root:
+
+```bash
+npm run setup:project
+cd apps/api
+npm run migration -- ./migrations/<MIGRATION_PATH>.ts
+# e.g. npm run migration -- ./migrations/add-user-contact/add-user-phone.ts
+```
+
+Some features may have multiple migrations, in which case you will need to run each migration in the order shown below.
+
+## Migrations History
+
+Below you will find a list of migrations introduced in previous versions of Novu, alongside the migration path to use in the script above.
+
+In some cases, it's necessary for Novu to remodel the data access layer to improve application performance as new data access patterns emerge. It is therefore important that each migration at the specified release tag commit is performed sequentially during version upgrades to ensure the necessary application code is available for the migration to succeed.
+
+| Version                                                      | Feature                   | Migration Path(s)                                                                                                                         |
+| ------------------------------------------------------------ | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
+| [v2.1](https://github.com/novuhq/novu/releases/tag/v2.1.0)   | Preference centralization | `./preference-centralization/preference-centralization-migration.ts`                                                                                        |
+| [v0.23](https://github.com/novuhq/novu/releases/tag/v0.23.0) | API keys encryption       | `./encrypt-api-keys/encrypt-api-keys-migration.ts`                                                                                        |
+| [v0.18](https://github.com/novuhq/novu/releases/tag/v0.18.0) | Multi-Provider            | `./integration-scheme-update/add-primary-priority-migration.ts`<br/>`./integration-scheme-update/add-integration-identifier-migration.ts` |
+|                                                              | Integration Store         | `./novu-integrations/novu-integrations.migration.ts`                                                                                      |
+| [v0.16](https://github.com/novuhq/novu/releases/tag/v0.16.0) | In-App Integration        | `./in-app-integration/in-app-integration.migration.ts`                                                                                    |
+|                                                              | Secure Flag Fix           | `./secure-to-boolean/secure-to-boolean-migration.ts`                                                                                      |
+| [v0.15](https://github.com/novuhq/novu/releases/tag/v0.15.0) | Database TTL              | `./expire-at/expire-at.migration.ts`                                                                                                      |
+| [v0.12](https://github.com/novuhq/novu/releases/tag/v0.12.0) | Organization Invite Fix   | `./normalize-users-email/normalize-users-email.migration.ts`                                                                              |
+| [v0.9](https://github.com/novuhq/novu/releases/tag/v0.9.0)   | Seen/Read Support         | `./seen-read-support/seen-read-support.migration.ts`                                                                                      |
+| [v0.8](https://github.com/novuhq/novu/releases/tag/v0.8.0)   | Secure Credentials        | `./fcm-credentials/fcm-credentials-migration.ts`<br/>`./encrypt-credentials/encrypt-credentials-migration.ts`                             |
+| [v0.4](https://github.com/novuhq/novu/releases/tag/v0.4.0)   | Change Promotion          | `./changes-migration.ts`                                                                                                                  |