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

Table of Contents

* SDK Installation
* Requirements
* SDK Example Usage
* Available Resources and Operations
* Error Handling
* Server Selection
* Custom HTTP Client
* Authentication
* Retries
* Pagination
* Standalone functions
* Debugging
* Development
* Contributions

SDK Installation

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

$3

``bash
npm add dub
`

$3

`bash
pnpm add dub
`

$3

`bash
bun add dub
`

$3

`bash
yarn add dub
`

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





Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.





SDK Example Usage

$3

`typescript
import { Dub } from "dub";

const dub = new Dub({
token: "DUB_API_KEY",
});

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

console.log(result);
}

run();

`

$3

`typescript
import { Dub } from "dub";

const dub = new Dub({
token: "DUB_API_KEY",
});

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

console.log(result);
}

run();

`





Available Resources and Operations

Available methods

$3

* retrieve - Retrieve analytics for a link, a domain, or the authenticated workspace.

$3

* listSubmissions - List bounty submissions
* approveSubmission - Approve a bounty submission
* rejectSubmission - Reject a bounty submission

$3

* list - Get commissions for a program.
* update - Update a commission.

$3

* list - Retrieve a list of customers
* get - Retrieve a customer
* update - Update a customer
* delete - Delete a customer

$3

* create - Create a domain
* list - Retrieve a list of domains
* update - Update a domain
* delete - Delete a domain
* register - Register a domain
* checkStatus - Check the availability of one or more domains

$3

* referrals - Create a referrals embed token

$3

* list - Retrieve a list of events

$3

* create - Create a folder
* list - Retrieve a list of folders
* update - Update a folder
* delete - Delete a folder

$3

* create - Create a link
* list - Retrieve a list of links
* count - Retrieve links count
* get - Retrieve a link
* update - Update a link
* delete - Delete a link
* createMany - Bulk create links
* updateMany - Bulk update links
* deleteMany - Bulk delete links
* upsert - Upsert a link

$3

* create - Create or update a partner
* list - List all partners
* createLink - Create a link for a partner
* retrieveLinks - Retrieve a partner's links.
* upsertLink - Upsert a link for a partner
* analytics - Retrieve analytics for a partner
* ban - Ban a partner
* deactivate - Deactivate a partner

$3

* get - Retrieve a QR code

$3

* create - Create a tag
* list - Retrieve a list of tags
* update - Update a tag
* delete - Delete a tag

$3

* lead - Track a lead
* sale - Track a sale

Error Handling

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

$3


`typescript
import { Dub } from "dub";
import * as errors from "dub/models/errors";

const dub = new Dub({
token: "DUB_API_KEY",
});

async function run() {
try {
const result = await dub.links.create();

console.log(result);
} catch (error) {
// The base class for HTTP error responses
if (error instanceof errors.DubError) {
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.BadRequest) {
console.log(error.data$.error); // errors.ErrorT
}
}
}
}

run();

`

$3


Primary errors:
* DubError: The base class for HTTP error responses.
* BadRequest: The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). Status code 400.
* Unauthorized: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. Status code 401.
* Forbidden: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server. Status code 403.
* NotFound: The server cannot find the requested resource. Status code 404.
* Conflict: This response is sent when a request conflicts with the current state of the server. Status code 409.
* InviteExpired: This response is sent when the requested content has been permanently deleted from server, with no forwarding address. Status code 410.
* UnprocessableEntity: The request was well-formed but was unable to be followed due to semantic errors. Status code 422.
* RateLimitExceeded: The user has sent too many requests in a given amount of time ("rate limiting"). Status code 429.
* InternalServerError: The server has encountered a situation it does not know how to handle. Status code 500.

Less common errors (6)

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 DubError:
* 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.

Server Selection

$3

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:
`typescript
import { Dub } from "dub";

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

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

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:

`typescript
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: httpClient });
`





Authentication

$3

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:
`typescript
import { Dub } from "dub";

const dub = new Dub({
token: "DUB_API_KEY",
});

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

console.log(result);
}

run();

`





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:
`typescript
import { Dub } from "dub";

const dub = new Dub({
token: "DUB_API_KEY",
});

async function run() {
const result = await dub.links.create({
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:
`typescript
import { Dub } from "dub";

const dub = new Dub({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
token: "DUB_API_KEY",
});

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

console.log(result);
}

run();

`





Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you
make your SDK calls as usual, but the returned response object will also be an
async iterable that can be consumed using the [for await...of][for-await-of]
syntax.

[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of

Here's an example of one such pagination call:

`typescript
import { Dub } from "dub";

const dub = new Dub({
token: "DUB_API_KEY",
});

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

for await (const page of result) {
console.log(page);
}
}

run();

`





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

- analyticsRetrieve - Retrieve analytics for a link, a domain, or the authenticated workspace.
- bountiesApproveSubmission - Approve a bounty submission
- bountiesListSubmissions - List bounty submissions
- bountiesRejectSubmission - Reject a bounty submission
- commissionsList - Get commissions for a program.
- commissionsUpdate - Update a commission.
- customersDelete - Delete a customer
- customersGet - Retrieve a customer
- customersList - Retrieve a list of customers
- customersUpdate - Update a customer
- domainsCheckStatus - Check the availability of one or more domains
- domainsCreate - Create a domain
- domainsDelete - Delete a domain
- domainsList - Retrieve a list of domains
- domainsRegister - Register a domain
- domainsUpdate - Update a domain
- embedTokensReferrals - Create a referrals embed token
- eventsList - Retrieve a list of events
- foldersCreate - Create a folder
- foldersDelete - Delete a folder
- foldersList - Retrieve a list of folders
- foldersUpdate - Update a folder
- linksCount - Retrieve links count
- linksCreate - Create a link
- linksCreateMany - Bulk create links
- linksDelete - Delete a link
- linksDeleteMany - Bulk delete links
- linksGet - Retrieve a link
- linksList - Retrieve a list of links
- linksUpdate - Update a link
- linksUpdateMany - Bulk update links
- linksUpsert - Upsert a link
- partnersAnalytics - Retrieve analytics for a partner
- partnersBan - Ban a partner
- partnersCreate - Create or update a partner
- partnersCreateLink - Create a link for a partner
- partnersDeactivate - Deactivate a partner
- partnersList - List all partners
- partnersRetrieveLinks - Retrieve a partner's links.
- partnersUpsertLink - Upsert a link for a partner
- qrCodesGet - Retrieve a QR code
- tagsCreate - Create a tag
- tagsDelete - Delete a tag
- tagsList - Retrieve a list of tags
- tagsUpdate - Update a tag
- trackLead - Track a lead
- trackSale - Track a sale

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.

`typescript
import { Dub } from "dub";

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

Summary

Dub API: Dub is the modern link attribution platform for short links, conversion tracking, and affiliate programs.

Development

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!

$3