Skip to content

ZoriHQ/zori-typescript-sdk

BranchesTags

Repository files navigation

zorihq

Developer-friendly & type-safe Typescript SDK specifically catered to leverage zorihq API.

Built by Speakeasy License: MIT



Important

This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

For more information about the API: Zori API Documentation

Table of Contents

SDK Installation

Tip

To finish publishing your SDK to npm and others you must run your first generation action.

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

NPM

npm add https://github.com/ZoriHQ/zori-typescript-sdk

PNPM

pnpm add https://github.com/ZoriHQ/zori-typescript-sdk

Bun

bun add https://github.com/ZoriHQ/zori-typescript-sdk

Yarn

yarn add https://github.com/ZoriHQ/zori-typescript-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 { ZoriHq } from "zorihq";

const zoriHq = new ZoriHq({
  serverURL: "https://api.example.com",
  apiKeyAuth: process.env["ZORIHQ_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await zoriHq.analytics.getApiV1AnalyticsEventsFilterOptions({
    customerId: "cus_xyz789",
    projectId: "proj_123",
    referrer: "https://google.com",
    utmtag: "utm_source",
    utmtagValue: "google",
    visitorId: "visitor_abc123",
  });

  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 ZORIHQ_API_KEY_AUTH

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

import { ZoriHq } from "zorihq";

const zoriHq = new ZoriHq({
  serverURL: "https://api.example.com",
  apiKeyAuth: process.env["ZORIHQ_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await zoriHq.analytics.getApiV1AnalyticsEventsFilterOptions({
    customerId: "cus_xyz789",
    projectId: "proj_123",
    referrer: "https://google.com",
    utmtag: "utm_source",
    utmtagValue: "google",
    visitorId: "visitor_abc123",
  });

  console.log(result);
}

run();

Available Resources and Operations

Available methods

analytics

authentication

paymentProviders

projects

revenue

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.

Available standalone functions

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 { ZoriHq } from "zorihq";

const zoriHq = new ZoriHq({
  serverURL: "https://api.example.com",
  apiKeyAuth: process.env["ZORIHQ_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await zoriHq.analytics.getApiV1AnalyticsEventsFilterOptions({
    customerId: "cus_xyz789",
    projectId: "proj_123",
    referrer: "https://google.com",
    utmtag: "utm_source",
    utmtagValue: "google",
    visitorId: "visitor_abc123",
  }, {
    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 { ZoriHq } from "zorihq";

const zoriHq = new ZoriHq({
  serverURL: "https://api.example.com",
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiKeyAuth: process.env["ZORIHQ_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await zoriHq.analytics.getApiV1AnalyticsEventsFilterOptions({
    customerId: "cus_xyz789",
    projectId: "proj_123",
    referrer: "https://google.com",
    utmtag: "utm_source",
    utmtagValue: "google",
    visitorId: "visitor_abc123",
  });

  console.log(result);
}

run();

Error Handling

ZoriHqError 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

Example

import { ZoriHq } from "zorihq";
import * as errors from "zorihq/models/errors";

const zoriHq = new ZoriHq({
  serverURL: "https://api.example.com",
  apiKeyAuth: process.env["ZORIHQ_API_KEY_AUTH"] ?? "",
});

async function run() {
  try {
    const result = await zoriHq.analytics.getApiV1AnalyticsEventsFilterOptions({
      customerId: "cus_xyz789",
      projectId: "proj_123",
      referrer: "https://google.com",
      utmtag: "utm_source",
      utmtagValue: "google",
      visitorId: "visitor_abc123",
    });

    console.log(result);
  } catch (error) {
    if (error instanceof errors.ZoriHqError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);
    }
  }
}

run();

Error Classes

Primary error:

  • ZoriHqError: The base class for HTTP error responses.
Less common errors (6)

Network errors:

Inherit from ZoriHqError:

  • 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.

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 { ZoriHq } from "zorihq";
import { HTTPClient } from "zorihq/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 ZoriHq({ 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 { ZoriHq } from "zorihq";

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

You can also enable a default debug logger by setting an environment variable ZORIHQ_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

About

No description, website, or topics provided.

Resources

Readme

Contributing

Contributing
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases 1

typescript - v0.0.2 - 2025-11-16 18:19:58 Latest
Nov 16, 2025

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages