openapi

🏗 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:

• 🛠 Make your SDK feel handcrafted by customizing it
• ♻️ Refine your SDK quickly by iterating locally with the Speakeasy CLI
• 🎁 Publish your SDK to package managers by configuring automatic publishing
• ✨ When ready to productionize, delete this section from the README

SDK Installation

NPM

npm add <UNSET>

Yarn

yarn add <UNSET>

SDK Example Usage

Example

import { SDK } from "openapi";

async function run() {
    const sdk = new SDK({
        bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    });

    const res = await sdk.getV1Liveness();

    if (res?.statusCode !== 200) {
        throw new Error("Unexpected status code: " + res?.statusCode || "-");
    }

    // handle response
}

run();

Available Resources and Operations

SDK

• getV1Liveness
• getV1KeysGetKey
• postV1KeysDeleteKey
• postV1KeysCreateKey
• postV1KeysVerifyKey
• postV1KeysUpdateKey
• postV1KeysUpdateRemaining
• getV1KeysGetVerifications
• getVxKeysGetVerifications
• getV1ApisGetApi
• postV1ApisCreateApi
• getV1ApisListKeys
• postV1ApisDeleteApi
• putV1KeysKeyId
• getV1KeysKeyId
• deleteV1KeysKeyId
• postV1Keys
• postV1KeysVerify
• postV1Apis
• getV1ApisApiId
• deleteV1ApisApiId
• getV1ApisApiIdKeys

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.ErrBadRequest	400	application/json
errors.ErrUnauthorized	401	application/json
errors.ErrForbidden	403	application/json
errors.ErrNotFound	404	application/json
errors.ErrConflict	409	application/json
errors.ErrTooManyRequests	429	application/json
errors.ErrInternalServerError	500	application/json
errors.SDKError	4xx-5xx	/

Example

import { SDK } from "openapi";
import * as errors from "openapi/models/errors";

async function run() {
    const sdk = new SDK({
        bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    });

    const res = await sdk.getV1Liveness().catch((err) => {
        if (err instanceof errors.ErrBadRequest) {
            console.error(err); // handle exception
            return null;
        } else if (err instanceof errors.ErrUnauthorized) {
            console.error(err); // handle exception
            return null;
        } else if (err instanceof errors.ErrForbidden) {
            console.error(err); // handle exception
            return null;
        } else if (err instanceof errors.ErrNotFound) {
            console.error(err); // handle exception
            return null;
        } else if (err instanceof errors.ErrConflict) {
            console.error(err); // handle exception
            return null;
        } else if (err instanceof errors.ErrTooManyRequests) {
            console.error(err); // handle exception
            return null;
        } else if (err instanceof errors.ErrInternalServerError) {
            console.error(err); // handle exception
            return null;
        } else {
            throw err;
        }
    });

    if (res?.statusCode !== 200) {
        throw new Error("Unexpected status code: " + res?.statusCode || "-");
    }

    // handle response
}

run();

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number 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://api.unkey.dev	None

Override Server URL Per-Client

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

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 { SDK } from "openapi";
import { HTTPClient } from "openapi/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 SDK({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
bearerAuth	http	HTTP Bearer

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

import { SDK } from "openapi";

async function run() {
    const sdk = new SDK({
        bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    });

    const res = await sdk.getV1Liveness();

    if (res?.statusCode !== 200) {
        throw new Error("Unexpected status code: " + res?.statusCode || "-");
    }

    // handle response
}

run();

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. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy