OneBlink SDK | Usage

Requirements

• Node.js 16.0 or newer
• NPM 8.0 or newer

Installation

npm install @oneblink/sdk --save
Copy

Tenants

This SDK is the entry point for all OneBlink Productivity instances. The default instance is the OneBlink Console. To use a different tenant to the default, change the require path to include the desired tenant. The available tenants are:

• OneBlink Console

  const OneBlink = require('@oneblink/sdk')
  // or
  const OneBlink = require('@oneblink/sdk/tenants/oneblink')
  Copy

• CivicOptimize Productivity

  const CivicPlus = require('@oneblink/sdk/tenants/civicplus')
  Copy

Once the SDK has been required, all class documentation below applies to all tenants. However, all of the examples use the default tenant. If you copy and paste from the examples, please don't forget to change (replacing my-tenant with a valid tenant path):

const OneBlink = require('@oneblink/sdk')
// to
const MyTenant = require('@oneblink/sdk/tenants/my-tenant')
Copy

Typescript

This SDK also supports Typescript Modules:

import * as OneBlink from '@oneblink/sdk'
Copy

Various Types used in this package can also be imported:

import * as Types from '@oneblink/sdk/types'
Copy