Skip to content

anle-statsig/statsig-capi-ts

BranchesTags

Repository files navigation

Statsig Typescript SDK

🏗 Welcome to your new SDK! 🏗

It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:

SDK Installation

NPM

npm add https://github.com/speakeasy-sdks/statsig-ts

PNPM

pnpm add https://github.com/speakeasy-sdks/statsig-ts

Bun

bun add https://github.com/speakeasy-sdks/statsig-ts

Yarn

yarn add https://github.com/speakeasy-sdks/statsig-ts zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Statsig } from "statsig";

const statsig = new Statsig({
    statsigApiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
    const result = await statsig.dynamicConfigs.create({
        dynamicConfigCreateDto: {
            idType: "userID",
            name: "<value>",
        },
    });

    // Handle the result
    console.log(result);
}

run();

Available Resources and Operations

dynamicConfigs

holdouts

gates

experiments

experimentsWarehouseNative

segments

events

  • list - List Events
  • getMetrics - Get metrics using event name
  • get - Get specific events

autotunes

layers

metrics

metricSources

  • create - Create Metric Source
  • get - Read Metric Source
  • delete - Delete Metric Source
  • update - Update Metric Source
  • list - List metric source

metricValues

  • list - List All Metric Values

users

teams

tags

reports

  • list - Get Reports

usage

targetApps

ingestions

configs

keys

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 { Statsig } from "statsig";

const statsig = new Statsig({
    statsigApiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
    const result = await statsig.dynamicConfigs.create(
        {
            dynamicConfigCreateDto: {
                idType: "userID",
                name: "<value>",
            },
        },
        {
            retries: {
                strategy: "backoff",
                backoff: {
                    initialInterval: 1,
                    maxInterval: 50,
                    exponent: 1.1,
                    maxElapsedTime: 100,
                },
                retryConnectionErrors: false,
            },
        }
    );

    // Handle the result
    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 { Statsig } from "statsig";

const statsig = new Statsig({
    retryConfig: {
        strategy: "backoff",
        backoff: {
            initialInterval: 1,
            maxInterval: 50,
            exponent: 1.1,
            maxElapsedTime: 100,
        },
        retryConnectionErrors: false,
    },
    statsigApiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
    const result = await statsig.dynamicConfigs.create({
        dynamicConfigCreateDto: {
            idType: "userID",
            name: "<value>",
        },
    });

    // Handle the result
    console.log(result);
}

run();

Error Handling

All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.

Error Object Status Code Content Type
errors.ConsoleV1DynamicConfigControllerGenCreateResponseBody 400 application/json
errors.ConsoleV1DynamicConfigControllerGenCreateDynamicConfigsResponseBody 401 application/json
errors.ConsoleV1DynamicConfigControllerGenCreateDynamicConfigsResponseResponseBody 403 application/json
errors.SDKError 4xx-5xx /

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.

import { Statsig } from "statsig";
import { SDKValidationError } from "statsig/models/errors";

const statsig = new Statsig({
    statsigApiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
    let result;
    try {
        result = await statsig.dynamicConfigs.create({
            dynamicConfigCreateDto: {
                idType: "userID",
                name: "<value>",
            },
        });
    } catch (err) {
        switch (true) {
            case err instanceof SDKValidationError: {
                // Validation errors can be pretty-printed
                console.error(err.pretty());
                // Raw value may also be inspected
                console.error(err.rawValue);
                return;
            }
            case err instanceof errors.ConsoleV1DynamicConfigControllerGenCreateResponseBody: {
                console.error(err); // handle exception
                return;
            }
            case err instanceof
                errors.ConsoleV1DynamicConfigControllerGenCreateDynamicConfigsResponseBody: {
                console.error(err); // handle exception
                return;
            }
            case err instanceof
                errors.ConsoleV1DynamicConfigControllerGenCreateDynamicConfigsResponseResponseBody: {
                console.error(err); // handle exception
                return;
            }
            default: {
                throw err;
            }
        }
    }

    // Handle the result
    console.log(result);
}

run();

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

# Server Variables
0 https://statsigapi.net None 
import { Statsig } from "statsig";

const statsig = new Statsig({
    serverIdx: 0,
    statsigApiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
    const result = await statsig.dynamicConfigs.create({
        dynamicConfigCreateDto: {
            idType: "userID",
            name: "<value>",
        },
    });

    // Handle the result
    console.log(result);
}

run();

Override Server URL Per-Client

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

import { Statsig } from "statsig";

const statsig = new Statsig({
    serverURL: "https://statsigapi.net",
    statsigApiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
    const result = await statsig.dynamicConfigs.create({
        dynamicConfigCreateDto: {
            idType: "userID",
            name: "<value>",
        },
    });

    // Handle the result
    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 { Statsig } from "statsig";
import { HTTPClient } from "statsig/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 Statsig({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme
statsigApiKey apiKey API key

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

import { Statsig } from "statsig";

const statsig = new Statsig({
    statsigApiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
    const result = await statsig.dynamicConfigs.create({
        dynamicConfigCreateDto: {
            idType: "userID",
            name: "<value>",
        },
    });

    // Handle the result
    console.log(result);
}

run();

Debugging

To log HTTP 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 { Statsig } from "statsig";

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

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](https://www.speakeasy.com/?utm_source=&utm_campaign=typescript)

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages