@waizer/sdk

Waizer's SDK to leverage its public API

Summary

Waizer Public API: The Waizer API provides a robust way to send messages to a project, manage users and run analysis jobs. Use your API key to authenticate requests.

Table of Contents

• @waizer/sdk
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @waizer/sdk

PNPM

pnpm add @waizer/sdk

Bun

bun add @waizer/sdk

Yarn

yarn add @waizer/sdk

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Waizer } from "@waizer/sdk";

const waizer = new Waizer({
  apiKeyAuth: process.env["WAIZER_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await waizer.messages.post({
    projectId: "cmk4s",
    body: [
      {
        threadId: "9831d5c5-f6e2-48fe-bb48-095dd1fb536e",
        type: "text/plain",
        direction: "SENT",
        content: "My name is John Doe. How can I assist you?",
        agentId: "[email protected]",
        timestamp: new Date("2025-09-10T10:39:44.000Z"),
        metadata: {
          error: "Failed to deliver message due to network error.",
          humanAssigneeId: "[email protected]",
        },
      },
    ],
  });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable | | ------------ | ------ | ------- | --------------------- | | apiKeyAuth | apiKey | API key | WAIZER_API_KEY_AUTH |

To authenticate with the API the apiKeyAuth parameter must be set when initializing the SDK client instance. For example:

import { Waizer } from "@waizer/sdk";

const waizer = new Waizer({
  apiKeyAuth: process.env["WAIZER_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await waizer.messages.post({
    projectId: "cmk4s",
    body: [
      {
        threadId: "9831d5c5-f6e2-48fe-bb48-095dd1fb536e",
        type: "text/plain",
        direction: "SENT",
        content: "My name is John Doe. How can I assist you?",
        agentId: "[email protected]",
        timestamp: new Date("2025-09-10T10:39:44.000Z"),
        metadata: {
          error: "Failed to deliver message due to network error.",
          humanAssigneeId: "[email protected]",
        },
      },
    ],
  });

  console.log(result);
}

run();

Available Resources and Operations

Jobs

• get - Get job details
• create - Create new job

Messages

• post - Ingest API messages

Users

• list - List organization users
• add - Add user to organization
• updateRole - Update user role
• delete - Remove user from organization
• getByEmail - Get user by email

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

• jobsCreate - Create new job
• jobsGet - Get job details
• messagesPost - Ingest API messages
• usersAdd - Add user to organization
• usersDelete - Remove user from organization
• usersGetByEmail - Get user by email
• usersList - List organization users
• usersUpdateRole - Update user role

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Waizer } from "@waizer/sdk";

const waizer = new Waizer({
  apiKeyAuth: process.env["WAIZER_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await waizer.messages.post({
    projectId: "cmk4s",
    body: [
      {
        threadId: "9831d5c5-f6e2-48fe-bb48-095dd1fb536e",
        type: "text/plain",
        direction: "SENT",
        content: "My name is John Doe. How can I assist you?",
        agentId: "[email protected]",
        timestamp: new Date("2025-09-10T10:39:44.000Z"),
        metadata: {
          error: "Failed to deliver message due to network error.",
          humanAssigneeId: "[email protected]",
        },
      },
    ],
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Waizer } from "@waizer/sdk";

const waizer = new Waizer({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiKeyAuth: process.env["WAIZER_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await waizer.messages.post({
    projectId: "cmk4s",
    body: [
      {
        threadId: "9831d5c5-f6e2-48fe-bb48-095dd1fb536e",
        type: "text/plain",
        direction: "SENT",
        content: "My name is John Doe. How can I assist you?",
        agentId: "[email protected]",
        timestamp: new Date("2025-09-10T10:39:44.000Z"),
        metadata: {
          error: "Failed to deliver message due to network error.",
          humanAssigneeId: "[email protected]",
        },
      },
    ],
  });

  console.log(result);
}

run();

Error Handling

WaizerError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { Waizer } from "@waizer/sdk";
import * as errors from "@waizer/sdk/models/errors";

const waizer = new Waizer({
  apiKeyAuth: process.env["WAIZER_API_KEY_AUTH"] ?? "",
});

async function run() {
  try {
    const result = await waizer.messages.post({
      projectId: "cmk4s",
      body: [
        {
          threadId: "9831d5c5-f6e2-48fe-bb48-095dd1fb536e",
          type: "text/plain",
          direction: "SENT",
          content: "My name is John Doe. How can I assist you?",
          agentId: "[email protected]",
          timestamp: new Date("2025-09-10T10:39:44.000Z"),
          metadata: {
            error: "Failed to deliver message due to network error.",
            humanAssigneeId: "[email protected]",
          },
        },
      ],
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.WaizerError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.BadRequestError) {
        console.log(error.data$.error); // string
      }
    }
  }
}

run();

Error Classes

Primary errors:

• WaizerError: The base class for HTTP error responses.
  • UnauthorizedError: Invalid or missing API key. Status code 401.
  • InternalServerError: Internal Server Error. Status code 500.

Network errors:

• ConnectionError: HTTP client was unable to make a request to a server.
• RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
• RequestAbortedError: HTTP request was aborted by the client.
• InvalidRequestError: Any input used to create a request is invalid.
• UnexpectedClientError: Unrecognised or unexpected error.

Inherit from WaizerError:

• NotFoundError: Project or integration not found. Status code 404. Applicable to 6 of 8 methods.*
• BadRequestError: Invalid request body. Status code 400. Applicable to 5 of 8 methods.*
• ConflictError: User already exists in the organization. Status code 409. Applicable to 1 of 8 methods.*
• TooManyRequestsError: Rate limit exceeded. Status code 429. Applicable to 1 of 8 methods.*
• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Waizer } from "@waizer/sdk";

const waizer = new Waizer({
  serverURL: "https://api.analyzer.whitewall.dev/api/v1",
  apiKeyAuth: process.env["WAIZER_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await waizer.messages.post({
    projectId: "cmk4s",
    body: [
      {
        threadId: "9831d5c5-f6e2-48fe-bb48-095dd1fb536e",
        type: "text/plain",
        direction: "SENT",
        content: "My name is John Doe. How can I assist you?",
        agentId: "[email protected]",
        timestamp: new Date("2025-09-10T10:39:44.000Z"),
        metadata: {
          error: "Failed to deliver message due to network error.",
          humanAssigneeId: "[email protected]",
        },
      },
    ],
  });

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { Waizer } from "@waizer/sdk";
import { HTTPClient } from "@waizer/sdk/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Waizer({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Waizer } from "@waizer/sdk";

const sdk = new Waizer({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable WAIZER_DEBUG to true.

Development

Maturity

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

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy