dub
TypeScript icon, indicating that this package has built-in type declarations

0.29.8 • Public • Published
Dub.co TypeScript SDK to interact with APIs.

Dub.co TypeScript SDK


Learn more about the Dub.co TypeScript SDK in the official documentation.

SDK Installation

NPM

npm add dub

Yarn

yarn add dub

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example 1

import { Dub } from "dub";

const dub = new Dub({
    token: "DUB_API_KEY",
    workspaceId: "<value>",
});

async function run() {
    const result = await dub.links.create({
        url: "https://google/com",
    });

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

run();

Example 2

import { Dub } from "dub";

const dub = new Dub({
    token: "DUB_API_KEY",
    workspaceId: "<value>",
});

async function run() {
    const result = await dub.links.upsert({
        url: "https://google/com",
    });

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

run();

Available Resources and Operations

  • get - Retrieve a QR code
  • timeseries - Retrieve timeseries click analytics ⚠️ Deprecated Use timeseries instead.
  • country - Retrieve top countries by clicks ⚠️ Deprecated Use countries instead.
  • city - Retrieve top cities by clicks ⚠️ Deprecated Use cities instead.
  • device - Retrieve top devices by clicks ⚠️ Deprecated Use devices instead.
  • browser - Retrieve top browsers by clicks ⚠️ Deprecated Use browsers instead.
  • os - Retrieve top OS by clicks ⚠️ Deprecated Use os instead.
  • referer - Retrieve top referers by clicks ⚠️ Deprecated Use referers instead.
  • topLinks - Retrieve top links by clicks ⚠️ Deprecated Use topLinks instead.
  • topUrls - Retrieve top URLs by clicks ⚠️ Deprecated Use topUrls instead.
  • count - Retrieve the total clicks count
  • timeseries - Retrieve timeseries click analytics
  • countries - Retrieve top countries by clicks
  • cities - Retrieve top cities by clicks
  • devices - Retrieve top devices by clicks
  • browsers - Retrieve top browsers by clicks
  • os - Retrieve top OS by clicks
  • referers - Retrieve top referers by clicks
  • topLinks - Retrieve top links by clicks
  • topUrls - Retrieve top URLs by clicks
  • getClicksCountDeprecated - Retrieve the total clicks count ⚠️ Deprecated Use count instead.
  • list - Retrieve a list of workspaces
  • create - Create a workspace
  • get - Retrieve a workspace
  • list - Retrieve a list of tags
  • create - Create a new tag
  • get - Retrieve the metatags for a URL

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.BadRequest 400 application/json
errors.Unauthorized 401 application/json
errors.Forbidden 403 application/json
errors.NotFound 404 application/json
errors.Conflict 409 application/json
errors.InviteExpired 410 application/json
errors.UnprocessableEntity 422 application/json
errors.RateLimitExceeded 429 application/json
errors.InternalServerError 500 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 { Dub } from "dub";
import * as errors from "dub/models/errors";

const dub = new Dub({
    token: "DUB_API_KEY",
    workspaceId: "<value>",
});

async function run() {
    let result;
    try {
        result = await dub.links.list({});
    } catch (err) {
        switch (true) {
            case err instanceof errors.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.BadRequest: {
                console.error(err); // handle exception
                return;
            }
            case err instanceof errors.Unauthorized: {
                console.error(err); // handle exception
                return;
            }
            case err instanceof errors.Forbidden: {
                console.error(err); // handle exception
                return;
            }
            case err instanceof errors.NotFound: {
                console.error(err); // handle exception
                return;
            }
            case err instanceof errors.Conflict: {
                console.error(err); // handle exception
                return;
            }
            case err instanceof errors.InviteExpired: {
                console.error(err); // handle exception
                return;
            }
            case err instanceof errors.UnprocessableEntity: {
                console.error(err); // handle exception
                return;
            }
            case err instanceof errors.RateLimitExceeded: {
                console.error(err); // handle exception
                return;
            }
            case err instanceof errors.InternalServerError: {
                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://api.dub.co None
import { Dub } from "dub";

const dub = new Dub({
    serverIdx: 0,
    token: "DUB_API_KEY",
    workspaceId: "<value>",
});

async function run() {
    const result = await dub.links.list({});

    // 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 { Dub } from "dub";

const dub = new Dub({
    serverURL: "https://api.dub.co",
    token: "DUB_API_KEY",
    workspaceId: "<value>",
});

async function run() {
    const result = await dub.links.list({});

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

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme
token http HTTP Bearer

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

import { Dub } from "dub";

const dub = new Dub({
    token: "DUB_API_KEY",
    workspaceId: "<value>",
});

async function run() {
    const result = await dub.links.list({});

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

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

Readme

Keywords

none

Package Sidebar

Install

npm i dub

Weekly Downloads

291

Version

0.29.8

License

none

Unpacked Size

3.02 MB

Total Files

508

Last publish

Collaborators

  • steventey