idalia

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

Summary

API Documentation: This is the OpenAPI specification for your project.

Table of Contents

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

SDK Installation

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

NPM

npm add idalia

PNPM

pnpm add idalia

Bun

bun add idalia

Yarn

yarn add idalia

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

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Idalia } from "idalia";

const idalia = new Idalia({
  apiKeyAuth: process.env["IDALIA_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await idalia.assetCategories.get();

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable | | ------------ | ------ | ------- | --------------------- | | apiKeyAuth | apiKey | API key | IDALIA_API_KEY_AUTH |

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

import { Idalia } from "idalia";

const idalia = new Idalia({
  apiKeyAuth: process.env["IDALIA_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await idalia.assetCategories.get();

  console.log(result);
}

run();

Available Resources and Operations

assetCategories

• get - Get asset categories
• create - Create asset categories

assets

• get - Get assets
• create - Create assets
• getById - Get asset by ID
• update - Update asset

assetTypes

• get - Get asset types
• create - Create asset types
• deleteAssetTypes - Delete asset types
• getById - Get asset type by ID

companies

• get - Get companies
• create - Create companies

locations

• get - Get locations
• create - Create locations

projects

• get - Get projects
• create - Create projects
• delete - Delete projects
• update - Update project

purchaseOrders

• get - Get purchase orders
• create - Create purchaseOrders

transportOrders

• get - Get transport orders
• create - Create transport orders
• delete - Delete transport orders

workOrders

• get - Get work orders
• create - Create work orders
• delete - Delete work orders
• update - Update work order

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.

• assetCategoriesCreate - Create asset categories
• assetCategoriesGet - Get asset categories
• assetsCreate - Create assets
• assetsGet - Get assets
• assetsGetById - Get asset by ID
• assetsUpdate - Update asset
• assetTypesCreate - Create asset types
• assetTypesDeleteAssetTypes - Delete asset types
• assetTypesGet - Get asset types
• assetTypesGetById - Get asset type by ID
• companiesCreate - Create companies
• companiesGet - Get companies
• locationsCreate - Create locations
• locationsGet - Get locations
• projectsCreate - Create projects
• projectsDelete - Delete projects
• projectsGet - Get projects
• projectsUpdate - Update project
• purchaseOrdersCreate - Create purchaseOrders
• purchaseOrdersGet - Get purchase orders
• transportOrdersCreate - Create transport orders
• transportOrdersDelete - Delete transport orders
• transportOrdersGet - Get transport orders
• workOrdersCreate - Create work orders
• workOrdersDelete - Delete work orders
• workOrdersGet - Get work orders
• workOrdersUpdate - Update work order

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:

import { Idalia } from "idalia";

const idalia = new Idalia({
  apiKeyAuth: process.env["IDALIA_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await idalia.assetCategories.get({
    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:

import { Idalia } from "idalia";

const idalia = new Idalia({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiKeyAuth: process.env["IDALIA_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await idalia.assetCategories.get();

  console.log(result);
}

run();

Error Handling

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

Example

import { Idalia } from "idalia";
import * as errors from "idalia/models/errors";

const idalia = new Idalia({
  apiKeyAuth: process.env["IDALIA_API_KEY_AUTH"] ?? "",
});

async function run() {
  try {
    const result = await idalia.assetCategories.get();

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

run();

Error Classes

Primary errors:

• IdaliaError: The base class for HTTP error responses.
  • FourHundredError: Bad Request. Status code 400.
  • FiveHundredError: Internal Server Error. Status code 500.

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

• 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

Override Server URL Per-Client

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:

import { Idalia } from "idalia";

const idalia = new Idalia({
  serverURL: "https://idalia.app/api",
  apiKeyAuth: process.env["IDALIA_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await idalia.assetCategories.get();

  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 { Idalia } from "idalia";
import { HTTPClient } from "idalia/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 Idalia({ httpClient: httpClient });

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.

import { Idalia } from "idalia";

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

You can also enable a default debug logger by setting an environment variable IDALIA_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.

SDK Created by Speakeasy