❤
npm
Sign UpSign In

hibob
TypeScript icon, indicating that this package has built-in type declarations

4.4.3 • Public • Published

hibob

SDK Installation

NPM

npm add hibob

Yarn

yarn add hibob

SDK Example Usage

Example

import { Hibob } from "hibob";
import { ImportMethod } from "hibob/sdk/models/operations";

async function run() {
    const sdk = new Hibob({
        security: {
            password: "<YOUR_PASSWORD_HERE>",
        },
    });

    const result = await sdk.attendance.postAttendanceImportImportMethod({
        importAttendanceData: {
            dateTimeFormat: "yyyy-MM-dd hh:mm a",
            idType: "<value>",
            requests: [
                {
                    clockIn: "2022-06-12T08:00",
                    clockOut: "2022-06-12T17:00",
                    id: "12356733644",
                },
            ],
        },
        importMethod: ImportMethod.Immediate,
    });

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

run();

Available Resources and Operations

attendance

people

metadata

reports

documents

tasks

objects

onboarding

payroll

customTables

tables

timeOff

Error Handling

All SDK methods 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 /

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.

import { Hibob } from "hibob";
import * as errors from "hibob/sdk/models/errors";
import { ImportMethod } from "hibob/sdk/models/operations";

async function run() {
    const sdk = new Hibob({
        security: {
            password: "<YOUR_PASSWORD_HERE>",
        },
    });

    let result;
    try {
        result = await sdk.attendance.postAttendanceImportImportMethod({
            importAttendanceData: {
                dateTimeFormat: "yyyy-MM-dd hh:mm a",
                idType: "<value>",
                requests: [
                    {
                        clockIn: "2022-06-12T08:00",
                        clockOut: "2022-06-12T17:00",
                        id: "12356733644",
                    },
                ],
            },
            importMethod: ImportMethod.Immediate,
        });
    } catch (err) {
        switch (true) {
            case err instanceof errors.SDKValidationError: {
                // Validation errors can be pretty-printed
                console.error(err.pretty());
                // Raw value may also be inspected
                console.error(err.rawValue);
                return;
            }
            default: {
                throw err;
            }
        }
    }

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

run();

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx 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.hibob.com/v1 None
1 https://api.sandbox.hibob.com/v1 None 
import { Hibob } from "hibob";
import { ImportMethod } from "hibob/sdk/models/operations";

async function run() {
    const sdk = new Hibob({
        serverIdx: 1,
        security: {
            password: "<YOUR_PASSWORD_HERE>",
        },
    });

    const result = await sdk.attendance.postAttendanceImportImportMethod({
        importAttendanceData: {
            dateTimeFormat: "yyyy-MM-dd hh:mm a",
            idType: "<value>",
            requests: [
                {
                    clockIn: "2022-06-12T08:00",
                    clockOut: "2022-06-12T17:00",
                    id: "12356733644",
                },
            ],
        },
        importMethod: ImportMethod.Immediate,
    });

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

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL optional parameter when initializing the SDK client instance. For example:

import { Hibob } from "hibob";
import { ImportMethod } from "hibob/sdk/models/operations";

async function run() {
    const sdk = new Hibob({
        serverURL: "https://api.hibob.com/v1",
        security: {
            password: "<YOUR_PASSWORD_HERE>",
        },
    });

    const result = await sdk.attendance.postAttendanceImportImportMethod({
        importAttendanceData: {
            dateTimeFormat: "yyyy-MM-dd hh:mm a",
            idType: "<value>",
            requests: [
                {
                    clockIn: "2022-06-12T08:00",
                    clockOut: "2022-06-12T17:00",
                    id: "12356733644",
                },
            ],
        },
        importMethod: ImportMethod.Immediate,
    });

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

import { Hibob } from "hibob";
import { HTTPClient } from "hibob/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 Hibob({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

Name Type Scheme
password http HTTP Basic
username http HTTP Basic

You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

import { Hibob } from "hibob";
import { ImportMethod } from "hibob/sdk/models/operations";

async function run() {
    const sdk = new Hibob({
        security: {
            password: "<YOUR_PASSWORD_HERE>",
        },
    });

    const result = await sdk.attendance.postAttendanceImportImportMethod({
        importAttendanceData: {
            dateTimeFormat: "yyyy-MM-dd hh:mm a",
            idType: "<value>",
            requests: [
                {
                    clockIn: "2022-06-12T08:00",
                    clockOut: "2022-06-12T17:00",
                    id: "12356733644",
                },
            ],
        },
        importMethod: ImportMethod.Immediate,
    });

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

run();

Per-Operation Security Schemes

Some operations in this SDK require the security scheme to be specified at the request level. For example:

import { Hibob } from "hibob";

async function run() {
    const sdk = new Hibob();

    const operationSecurity = {
        bearer: "<YOUR_API_KEY_HERE>",
    };

    const result = await sdk.people.getMyAvatar(operationSecurity);

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

run();

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

[!TIP]

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

  • Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
  • Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
  • Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
  • Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.
import { Hibob } from "hibob";
import { openAsBlob } from "node:fs";

async function run() {
    const sdk = new Hibob({
        security: {
            password: "<YOUR_PASSWORD_HERE>",
        },
    });

    const result = await sdk.documents.postDocsPeopleIdConfidentialUpload({
        requestBody: {
            file: await openAsBlob("./sample-file"),
        },
        id: "<id>",
    });

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

run();

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

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

SDK Created by Speakeasy

Readme

Keywords

none

Package Sidebar

Install

npm i hibob

Repository

github.com/speakeasy-sdks/hibob

Homepage

github.com/speakeasy-sdks/hibob#readme

Weekly Downloads

66

Version

4.4.3

License

none

Unpacked Size

3.97 MB

Total Files

1063

Last publish

Collaborators

  • roopakv
Try on RunKit
Report malware