@intuned/client
Advanced tools
Consume your browser automation projects and perform file operations with the Intuned API using this TypeScript SDK.
Intuned Client: Intuned API Client to call APIs exposed by the Intuned Platform (https://docs.intunedhq.com/).
For more information about the API: Find out more about Intuned
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
npm add @intuned/client
pnpm add @intuned/client
bun add @intuned/client
yarn add @intuned/client zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
For supported JavaScript runtimes, please consult RUNTIMES.md.
To get started, please refer to the client API overview section in our docs.
To authenticate with the API, you will need an API key. How to create an API key.
The SDK runs within the context of a workspace. You will need to provide the workspace ID when initializing the SDK client instance. How to get your workspace ID.
import { IntunedClient } from "@intuned/client";
const intunedClient = new IntunedClient({
apiKey: "<YOUR_API_KEY_HERE>",
workspaceId: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
});
async function run() {
const result = await intunedClient.files.extractStructuredData.sync({
type: "pdf",
source: {
type: "url",
data: "http://unconscious-margin.name",
},
}, {
"key": "<value>",
});
// Handle the result
console.log(result);
}
run();
Successful operations will return a response object. If an error occurs, the SDK will throw an error that can be caught and handled by the calling code. The error object will contain information about the error that occurred.
import { IntunedClient } from "@intuned/client";
import { FileUrlSourceType, PdfFileType } from "@intuned/client/models/components";
import * as errors from "@intuned/client/models/errors";
const intunedClient = new IntunedClient({
apiKey: "<YOUR_API_KEY_HERE>",
workspaceId: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
});
async function run() {
let result;
try {
result = await intunedClient.files.extractStructuredData.sync(
{
type: PdfFileType.Pdf,
source: {
type: FileUrlSourceType.Url,
data: "http://unconscious-margin.name",
},
},
{
key: "<value>",
}
);
} catch (err) {
switch (true) {
case err instanceof errors.ApiErrorInvalidInput: {
console.error(err); // handle exception
return;
}
case err instanceof errors.ApiErrorUnauthorized: {
console.error(err); // handle exception
return;
}
default: {
throw err;
}
}
}
// Handle the result
console.log(result);
}
run();
If you encounter a validation error, please contact us.
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 { IntunedClient } from "@intuned/client";
import { HTTPClient } from "@intuned/client/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 IntunedClient({ httpClient });
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:
import { IntunedClient } from "@intuned/client";
const intunedClient = new IntunedClient({
apiKey: "<YOUR_API_KEY_HERE>",
workspaceId: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
});
async function run() {
const result = await intunedClient.files.extractStructuredData.sync({
type: "pdf",
source: {
type: "url",
data: "http://unconscious-margin.name",
},
}, {
"key": "<value>",
}, {
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:
import { IntunedClient } from "@intuned/client";
const intunedClient = new IntunedClient({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
apiKey: "<YOUR_API_KEY_HERE>",
workspaceId: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
});
async function run() {
const result = await intunedClient.files.extractStructuredData.sync({
type: "pdf",
source: {
type: "url",
data: "http://unconscious-margin.name",
},
}, {
"key": "<value>",
});
// Handle the result
console.log(result);
}
run();
A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
For example, you can set workspaceId to "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" at SDK initialization and then you do not have to pass the same value on calls to operations like sync. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
The following global parameter is available.
| Name | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | Your workspace ID. How to find it? |
import { IntunedClient } from "@intuned/client";
const intunedClient = new IntunedClient({
apiKey: "<YOUR_API_KEY_HERE>",
workspaceId: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
});
async function run() {
const result = await intunedClient.files.extractStructuredData.sync({
type: "pdf",
source: {
type: "url",
data: "http://unconscious-margin.name",
},
}, {
"key": "<value>",
});
// Handle the result
console.log(result);
}
run();
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.
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.
import { IntunedClient } from "@intuned/client";
const sdk = new IntunedClient({ debugLogger: console });
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.
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!
FAQs
<!-- TODO: add logo -->
We found that @intuned/client demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers have discovered multiple malicious npm packages targeting Solana private keys, abusing Gmail to exfiltrate the data and drain Solana wallets.
Security News
PEP 770 proposes adding SBOM support to Python packages to improve transparency and catch hidden non-Python dependencies that security tools often miss.
Security News
Socket CEO Feross Aboukhadijeh discusses open source security challenges, including zero-day attacks and supply chain risks, on the Cyber Security Council podcast.