unified-to/unified-typescript-sdk

SDK for Unified.to API

Installation

NPM

npm add @unified-api/typescript-sdk

Yarn

yarn add @unified-api/typescript-sdk

SDK Example Usage

Example

import { UnifiedTo } from "@unified-api/typescript-sdk";

async function run() {
    const sdk = new UnifiedTo({
        security: {
            jwt: "<YOUR_API_KEY_HERE>",
        },
    });

    const res = await sdk.accounting.listAccountingAccounts({
        connectionId: "<value>",
    });

    if (res.statusCode == 200) {
        // handle response
        console.log(res.accountingAccounts);
    }
}

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.unified.to	None
1	https://api-eu.unified.to	None

Example

import { UnifiedTo } from "@unified-api/typescript-sdk";
import { Status, TypeT } from "@unified-api/typescript-sdk/dist/sdk/models/shared";

async function run() {
    const sdk = new UnifiedTo({
        serverIdx: 1,
        security: {
            jwt: "<YOUR_API_KEY_HERE>",
        },
    });

    const res = await sdk.accounting.createAccountingAccount({
        accountingAccount: {
            raw: {
                key: "<value>",
            },
        },
        connectionId: "<value>",
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

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:

import { UnifiedTo } from "@unified-api/typescript-sdk";
import { Status, TypeT } from "@unified-api/typescript-sdk/dist/sdk/models/shared";

async function run() {
    const sdk = new UnifiedTo({
        serverURL: "https://api.unified.to",
        security: {
            jwt: "<YOUR_API_KEY_HERE>",
        },
    });

    const res = await sdk.accounting.createAccountingAccount({
        accountingAccount: {
            raw: {
                key: "<value>",
            },
        },
        connectionId: "<value>",
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Custom HTTP Client

The Typescript SDK makes API calls using the axios HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom AxiosInstance object.

For example, you could specify a header for every request that your sdk makes as follows:

import { @unified-api/typescript-sdk } from "UnifiedTo";
import axios from "axios";

const httpClient = axios.create({
    headers: {'x-custom-header': 'someValue'}
})

const sdk = new UnifiedTo({defaultClient: httpClient});

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
jwt	apiKey	API key

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

import { UnifiedTo } from "@unified-api/typescript-sdk";
import { Status, TypeT } from "@unified-api/typescript-sdk/dist/sdk/models/shared";

async function run() {
    const sdk = new UnifiedTo({
        security: {
            jwt: "<YOUR_API_KEY_HERE>",
        },
    });

    const res = await sdk.accounting.createAccountingAccount({
        accountingAccount: {
            raw: {
                key: "<value>",
            },
        },
        connectionId: "<value>",
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Error Handling

Handling errors in this SDK should largely match your expectations. All operations 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.SDKError	4xx-5xx	/

Example

import { UnifiedTo } from "@unified-api/typescript-sdk";
import { Status, TypeT } from "@unified-api/typescript-sdk/dist/sdk/models/shared";

async function run() {
    const sdk = new UnifiedTo({
        security: {
            jwt: "<YOUR_API_KEY_HERE>",
        },
    });

    let res;
    try {
        res = await sdk.accounting.createAccountingAccount({
            accountingAccount: {
                raw: {
                    key: "<value>",
                },
            },
            connectionId: "<value>",
        });
    } catch (err) {
        if (err instanceof errors.SDKError) {
            console.error(err); // handle exception
            throw err;
        }
    }

    if (res.statusCode == 200) {
        // handle response
    }
}

run();