// Importing required modules
const yaml = require("js-yaml");
const fs = require("fs");
const path = require("path");
const axios = require("axios");

// Function to create all OpenAPI files
const createAllOpenApiFiles = async () => {
  console.log("Creating new openapi files...");
  const folderName = "api-reference";

  // Function to read OpenAPI documentation from URL
  const readDoc = async () => {
    try {
      const response = await axios.get(
        "https://app.dynamic.xyz/api-docs/api.yaml"
      );

      fs.writeFileSync(
        path.join(__dirname, "../../openapi.yaml"),
        response.data
      );

      const doc = yaml.load(fs.readFileSync("openapi.yaml", "utf8"));
      return doc;
    } catch (e) {
      console.log(e);
      return null;
    }
  };

  // Function to delete output folder
  const deleteOutputFolder = () => {
    if (fs.existsSync(path.join(__dirname, `/${folderName}`))) {
      fs.rmSync(path.join(__dirname, `/${folderName}`), { recursive: true });
    }
  };

  // Read OpenAPI documentation
  const doc = await readDoc();

  // Delete output folder
  deleteOutputFolder();

  // // Loop through each path in the OpenAPI documentation
  for (const [key, value] of Object.entries(doc.paths)) {
    const url = key;
    const availableMethods = value;
    const innerFolderName = url.split("/")[1].toLowerCase();

    // Create output folder if it doesn't exist
    if (!fs.existsSync(path.join(__dirname, `/${folderName}`))) {
      fs.mkdirSync(path.join(__dirname, `/${folderName}`));
    }

    // Loop through each available method for the path
    for (const [key, value] of Object.entries(availableMethods)) {
      const method = key.toUpperCase();

      // Don't create file for OPTIONS method calls
      if (method !== "OPTIONS") {
        const description = value.summary;
        const id = value.operationId;
        const tags = value.tags;
        const tag = tags[0].toLowerCase();

        // Create inner folder for tag if it doesn't exist
        if (!fs.existsSync(path.join(__dirname, `/${folderName}/${tag}`))) {
          fs.mkdirSync(path.join(__dirname, `/${folderName}/${tag}`));
        }

        // Format string for output file
        const formattedString =
          "---\ntitle: " +
          description +
          "\nopenapi: " +
          method +
          " " +
          url +
          "\n---";

        // Write output file
        fs.writeFileSync(
          path.join(__dirname, `/${folderName}/${tag}/${id}.mdx`),
          formattedString,
          { flag: "wx" }
        );
      }
    }
  }
};

// Function to move overview file into OpenAPI folder
const moveOverviewIntoOpenApiFolder = () => {
  console.log("copying overview file into OpenAPI folder...");
  const folderName = "api-reference";
  const overviewFileName = "overview.mdx";

  // Copy overview file into OpenAPI folder
  if (fs.existsSync(path.join(__dirname, `./${folderName}`))) {
    fs.copyFileSync(
      path.join(__dirname, `../${overviewFileName}`),
      path.join(__dirname, `./${folderName}/${overviewFileName}`)
    );
  }

  return;
};

const createNewOpenApiFiles = async () => {
  // Call functions to create all OpenAPI files and move overview file into OpenAPI folder
  await createAllOpenApiFiles();
  await moveOverviewIntoOpenApiFolder();

  console.log("New openapi files created!");
  return;
};

module.exports = createNewOpenApiFiles;


Overview

Dynamic

Welcome to Dynamic! We're so excited that you're here!

Welcome

Let's get you up and running with a full signup/login UI! Just [sign up](https://app.dynamic.xyz) and follow the guide below!

Quickstart

Example apps

Go Live Checklist

Best Practices

AI Use Cases

The `DynamicBridgeWidget` component allows you to handle multi chain bridging

Bridge Widget

Rate Limits

This page hosts the keys that you'll need to setup the SDK, validate the JWT, and generate tokens for API usage.

SDK and API Keys

Every project you create in Dynamic comes with a Sandbox and a Live environment. Both these environments behave similarly but we've customized the Sandbox environment to make it ideal for testing and exploring features.

Sandbox vs Live

Analytics

Test Accounts allow you to log in with a static OTP

Test Accounts

Migrating to Dynamic

Integrate your Wallet

Integrate your Chain

V1 Embedded Wallets Overview

Working with environments that have both v1 and v2 embedded wallets

The SDK allows you to build authentication and authorization into your application in a few lines of code.

Introduction to the SDK

SDK/User Loading States

Examples

Introduction to the React Native SDK

Setting up the Dynamic Client

Adding React Native support

Email and SMS verification

Social authentication

Install & Setup Passkey

Embedded wallets

Rendering client state to React

Managing your User's Wallets

Viem integration

Solana integration

Using Dynamic's UI

Account Abstraction with ZeroDev

Listening to events

Deeplink URLs

Signing in with Third-party Authentication

Troubleshooting Common Issues

Dynamic Package

Social Authentication

Web3Dart Package

Introduction

Get the global wallet settings for environment

Updates the global wallet settings for the environment

Creates the global wallet settings for the environment

Enable global wallet for this environment

Disabled global wallet for this environment

Get the name service for the environment and chain

Create a new name service for the environment and chain

delete the name service for the environment and chain

Get the unsigned chain-specific message needed to be signed by the wallet owner using the wallet private key

Enable name service for this environment and chain

Disabled name service for this environment and chain

Get the test account for this environemnt

Create a new test account for this environment

Delete the test account for this environment

Delete the custom hostname

Get the custom hostnames for this environemnt

Create a new custom hostname for this environment

Get the exports for an environment

Create a new export request for the project environment

Download an export by ID

Get an export using the ID

Get the gates for an environment

Creates a new gate for the project environment

Gets a gate

Updates a gate

Delete a gate

Enable the gate for the environment

Disable the gate for the environment

Get the providers for an environment

Creates a new provider for the project environment

Get the URLs for the environment providers

Gets a provider

Updates a provider

Delete a provider by providerId

Enable the provider for the environment

Disable the provider for the environment

Get environments analyticswallets

Get environments analyticsvisits

Fetches all the active organizations that the user has access to

Creates organization

Find the subscription of an organization using its ID

Upgrade organziation to advanced plan

Add coupon to subscription

Find an organization by ID

Update an organization by ID

Find an project by ID

Update a project

Deletes a project by ID

Fetches all the active projects the belong to the organization

Creates a new project

Get all custom networks for an organization

Create a custom network for an organization

Get a specific custom network

Update a custom network

Delete a custom network

Find the Chainalysis configuration for an environment.

Enable the Sanctions API

Disables the Sanctions API

Find an environment by ID

Updates the environment settings

Get the unique number of visitors for an environment by environment ID

Get keys for an environment given environmentId

Get Live and Sandbox environments by projectId

Revoke a session

Creates a new embedded wallet for a user given an email or userId. If an email is provided and it is not associated with an existing user this call will also create a new user.

Creates a new embedded wallet for a user given an identifier

Creates a new embedded wallet. This API is meant to be called from a frame server.

Get wallets by user

Creates a new wallet for the user. Note that this API is not meant for creating embedded wallets. To create embedded wallets use the /embeddedWallets endpoint.

Creates a new wallet for the user. Note that if the user already has an embedded wallet linked, this call will fail.

Get a wallet using the ID

Delete wallet

Get a user by Id

Update a user

Delete user

Get the access token for a user OAuth account

Get all users for an environment

Creates a new user

Revoke sessions by user ID

Creates many new users

Get all visitors for an environment

Update a given members role

Delete user membership from being an admin of an organization

Get all users that are admins for an organization

Retrieve the list of project environments that the user is a member of.

Get Membership Environment IDs

Get all mfa settings for an organization

Enable the given mfa device for the organization

Disable the given mfa device for the organization

Get all the user invites

Update invite for user (accept/reject)

Delete invite for user

Fetches all the Invites the belong to the organization

Creates an invite to the organization

Check if the external provided JWT is valid for the specified environment

Get all the allowed origins for a project environment

Adds an allowed origin for this project environment

Delete a origin by id

Get all the tokens for a project environment (does not include the raw token)

Create a new API Token

Delete a token by token id

Get all allowlists for a environment

Create new allowlist for a environment

Get allowlist by id

Update the outcome, scope, or name of an allowlist entry by ID

Delete an allowlist

Enable the allowlist

Disable the allow list

Get all entries for an allowlist

Create a new entry for an allowlist

Delete an allowlist entry

Get tokens for passed chainName.

Get the sdk views for an environment

Get a sdk view given a type and environment

Updates the configs for the sdk view and project environment

Get event types

Get environment events

Get the Webhooks for an environment

Creates a new Webhooks for the project environment

Get the Webhook for an environment

Update the Webhook for an environment

Delete the Webhook for an environment

Get the Messages for an webhook

Get the Message deliveries for a webhook

Redeliver message for an webhook

Get exchangerates

Check if the unique field value is already taken. For example, an enabled unique username or unique email. This also works with enabled unique custom fields.

Check user field uniqueness

This endpoint initializes a secure oauth authentication sequence by providing the state and current url path to the API.

Initialize oauth auth sequence

Check that session is valid

Scan a URL for potential malicious activity

Simulate a Solana transaction

Simulate an EVM transaction

Simulate an EVM AA UserOp

Endpoint to sign-in using a token issued by an external auth provider

Add fees to a Solana transaction

[DEPRECATED] Please use /externalAuth/signin instead

Get auth token for given embedded wallet type

Return the passcode for the pregenerated embedded wallet of the authenticated user

When a user selects a wallet to be the primary wallet in a multi-wallet enabled environment, this endpoint is called to record this on the backend.

Update wallet in a multi-wallet selection

Claim a pregenerated embedded wallet

Return the backup key for the embedded wallet of the authenticated user

Update V1 embedded wallet to V2

Introduction

The Basics

Beyond The Basics

Developer Dashboard

Tutorials

Migrating to Dynamic

For Wallets & Chains

Legacy: V1 Embedded Wallets

Overview

Magic

Blocto

Crossmint

Co:create