@fern-api/stytch v0.0.4

Stytch Node Library

Documentation

API documentation is available at https://stytch.com/docs/api.

Usage

import { StytchApi } from "@fern-api/stytch";

const stytch = new StytchApi.Client({
  _origin: "api.stytch.com",
  _credentials: {
    username: process.env.STYTCH_PROJECT_ID,
    password: process.env.STYTCH_TOKEN
  }
});

const createResponse = await stytch.magicLinks.sendMagicLinkByEmail({
  email: "user@example.com",
  loginExpirationMinutes: 60,
  userId: "user_abc123",
});

if (!createResponse.ok) {
  console.error("Failed to create magic link", createResponse.error)
} else {
  console.log(`Created magic link! The request ID is ${createResponse.body.requestId}`);
}

Sample app

Check out the sample app which consumes this SDK!

export STYTCH_PROJECT_ID=...
export STYTCH_TOKEN=...

cd .sample-app
yarn install
yarn start

# if you want to check out the IDE experience,
# be sure that the sample app is the root of the VSCode workspace
code . 

SDK Examples

Below are a few examples of how to use the SDK to hit different endpoints. Check out our API Reference to see all of our endpoints.

Beta status

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your package.json file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!