apideck

Developer-friendly & type-safe Typescript SDK specifically catered to leverage apideck API.

> [!IMPORTANT]
> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Apideck: The Apideck OpenAPI Spec: SDK Optimized

For more information about the API: Apideck Developer Docs

Table of Contents

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

SDK Installation

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

$3

``bash
npm add @apideck/sdk
`

$3

`bash
pnpm add @apideck/sdk
`

$3

`bash
bun add @apideck/sdk
`

$3

`bash
yarn add @apideck/sdk zod

Note that Yarn does not install peer dependencies automatically. You will need

`typescript
import { Apideck } from "@apideck/sdk";

const apideck = new Apideck({
apiKey: process.env["APIDECK_API_KEY"] ?? "",
consumerId: "test-consumer",
appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
});

async function run() {
const result = await apideck.accounting.taxRates.list({
serviceId: "salesforce",
filter: {
assets: true,
equity: true,
expenses: true,
liabilities: true,
revenue: true,
},
passThrough: {
"search": "San Francisco",
},
fields: "id,updated_at",
});

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

run();

`


Available Resources and Operations

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
`typescript
import { Apideck } from "@apideck/sdk";

const apideck = new Apideck({
apiKey: process.env["APIDECK_API_KEY"] ?? "",
consumerId: "test-consumer",
appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
});

async function run() {
const result = await apideck.accounting.taxRates.list({
serviceId: "salesforce",
filter: {
assets: true,
equity: true,
expenses: true,
liabilities: true,
revenue: true,
},
passThrough: {
"search": "San Francisco",
},
fields: "id,updated_at",
}, {
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:
`typescript
import { Apideck } from "@apideck/sdk";

const apideck = new Apideck({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
apiKey: process.env["APIDECK_API_KEY"] ?? "",
consumerId: "test-consumer",
appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
});

async function run() {
const result = await apideck.accounting.taxRates.list({
serviceId: "salesforce",
filter: {
assets: true,
equity: true,
expenses: true,
liabilities: true,
revenue: true,
},
passThrough: {
"search": "San Francisco",
},
fields: "id,updated_at",
});

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

run();

`


Error Handling

All SDK methods return a response object or throw an error. By default, an API error will throw a errors.APIError.

If a HTTP request fails, an operation my also throw an error from the models/errors/httpclienterrors.ts module:

| HTTP Client Error | Description |
| ---------------------------------------------------- | ---------------------------------------------------- |
| RequestAbortedError | HTTP request was aborted by the client |
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
| ConnectionError | HTTP client was unable to make a request to a server |
| InvalidRequestError | Any input used to create a request is invalid |
| UnexpectedClientError | Unrecognised or unexpected error |

In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation. For example, the list method may throw the following errors:

| Error Type | Status Code | Content Type |
| ------------------------------ | ----------- | ---------------- |
| errors.BadRequestResponse | 400 | application/json |
| errors.UnauthorizedResponse | 401 | application/json |
| errors.PaymentRequiredResponse | 402 | application/json |
| errors.NotFoundResponse | 404 | application/json |
| errors.UnprocessableResponse | 422 | application/json |
| errors.APIError | 4XX, 5XX | \/\ |

`typescript
import { Apideck } from "@apideck/sdk";
import {
BadRequestResponse,
NotFoundResponse,
PaymentRequiredResponse,
SDKValidationError,
UnauthorizedResponse,
UnprocessableResponse,
} from "@apideck/sdk/models/errors";

const apideck = new Apideck({
apiKey: process.env["APIDECK_API_KEY"] ?? "",
consumerId: "test-consumer",
appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
});

async function run() {
let result;
try {
result = await apideck.accounting.taxRates.list({
serviceId: "salesforce",
filter: {
assets: true,
equity: true,
expenses: true,
liabilities: true,
revenue: true,
},
passThrough: {
"search": "San Francisco",
},
fields: "id,updated_at",
});

// Handle the result
console.log(result);
} 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 BadRequestResponse): {
// Handle err.data$: BadRequestResponseData
console.error(err);
return;
}
case (err instanceof UnauthorizedResponse): {
// Handle err.data$: UnauthorizedResponseData
console.error(err);
return;
}
case (err instanceof PaymentRequiredResponse): {
// Handle err.data$: PaymentRequiredResponseData
console.error(err);
return;
}
case (err instanceof NotFoundResponse): {
// Handle err.data$: NotFoundResponseData
console.error(err);
return;
}
case (err instanceof UnprocessableResponse): {
// Handle err.data$: UnprocessableResponseData
console.error(err);
return;
}
default: {
throw err;
}
}
}
}

run();

`

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.


Server Selection

$3

The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:
`typescript
import { Apideck } from "@apideck/sdk";

const apideck = new Apideck({
serverURL: "https://unify.apideck.com",
apiKey: process.env["APIDECK_API_KEY"] ?? "",
consumerId: "test-consumer",
appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
});

async function run() {
const result = await apideck.accounting.taxRates.list({
serviceId: "salesforce",
filter: {
assets: true,
equity: true,
expenses: true,
liabilities: true,
revenue: true,
},
passThrough: {
"search": "San Francisco",
},
fields: "id,updated_at",
});

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

run();

`

$3

The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
`typescript
import { Apideck } from "@apideck/sdk";

const apideck = new Apideck({
apiKey: process.env["APIDECK_API_KEY"] ?? "",
consumerId: "test-consumer",
appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
});

async function run() {
const result = await apideck.fileStorage.uploadSessions.create({
serviceId: "salesforce",
createUploadSessionRequest: {
name: "Documents",
parentFolderId: "1234",
driveId: "1234",
size: 1810673,
passThrough: [
{
serviceId: "",
extendPaths: [
{
path: "$.nested.property",
value: {
"TaxClassificationRef": {
"value": "EUC-99990201-V1-00020000",
},
},
},
],
},
],
},
}, {
serverURL: "https://upload.apideck.com",
});

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

`typescript
import { Apideck } from "@apideck/sdk";
import { HTTPClient } from "@apideck/sdk/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 Apideck({ httpClient });
`


Authentication

$3

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable |
| -------- | ------ | ------- | -------------------- |
| apiKey | apiKey | API key | APIDECK_API_KEY |

To authenticate with the API the apiKey parameter must be set when initializing the SDK client instance. For example:
`typescript
import { Apideck } from "@apideck/sdk";

const apideck = new Apideck({
apiKey: process.env["APIDECK_API_KEY"] ?? "",
consumerId: "test-consumer",
appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
});

async function run() {
const result = await apideck.accounting.taxRates.list({
serviceId: "salesforce",
filter: {
assets: true,
equity: true,
expenses: true,
liabilities: true,
revenue: true,
},
passThrough: {
"search": "San Francisco",
},
fields: "id,updated_at",
});

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

run();

`


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 { Apideck } from "@apideck/sdk";

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

You can also enable a default debug logger by setting an environment variable APIDECK_DEBUG` to true.

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.

$3