Sequenzy TypeScript API - Best Email Marketing Platform API Library

This library provides convenient access to the Sequenzy REST API from server-side TypeScript or JavaScript.

The REST API documentation can be found on docs.sequenzy.com. The full API of this library can be found in api.md.

It is generated with Stainless.

Installation

npm install sequenzy

Usage

The full API of this library can be found in api.md.

import Sequenzy from 'sequenzy';

const client = new Sequenzy({
  apiKey: process.env['SEQUENZY_API_KEY'], // This is the default and can be omitted
});

const subscriber = await client.subscribers.create({ firstName: 'User', lastName: 'TheBest' });

console.log(subscriber.optIn);

Request & Response types

This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:

import Sequenzy from 'sequenzy';

const client = new Sequenzy({
  apiKey: process.env['SEQUENZY_API_KEY'], // This is the default and can be omitted
});

const params: Sequenzy.SubscriberCreateParams = { firstName: 'User', lastName: 'TheBest' };
const subscriber: Sequenzy.SubscriberCreateResponse = await client.subscribers.create(params);

Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.

Handling errors

When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of will be thrown: