@emilgroup/tenant-sdk-node

Emil Tenant SDK for Nodejs

This TypeScript/JavaScript client utilizes axios. The generated Node module can be used with Nodejs based applications.

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

Although this package can be used in both TypeScript and JavaScript, it is intended to be used with TypeScript. The definition should be automatically resolved via package.json. (Reference). For more information, you can go to Emil Api documentation.

Consuming

Navigate to the folder of your consuming project and run one of the following commands:

npm install @emilgroup/tenant-sdk-node@1.18.0 --save

or

yarn add @emilgroup/tenant-sdk-node@1.18.0

And then you can import UsersApi.

import { UsersApi } from '@emilgroup/tenant-sdk-node'

const usersApi = new UsersApi();

Credentials

To use authentication protected endpoints, you have to first authorize. To do so, the easiest way is to provide a configuration file under ~/.emil/credentials with the following content:

emil_username=[e-mail]
emil_password=XXXXXXXXXXXXXX

It is also possible to provide environment variables instead:

export EMIL_USERNAME=[e-mail]
export EMIL_PASSWORD=XXXXXXXXXXXXXX

Base path

To select the basic path for using the API, we can use two approaches. The first is to use one of the predefined environments, and the second is to specify the domain as a string.

import { UsersApi, Environment } from '@emilgroup/tenant-sdk-node'

const usersApi = new UsersApi();

// Allows you to simply choose environment. It will usually be Environment.Production.
usersApi.selectEnvironment(Environment.Production);

// For advanced users, use the custom baseUrl of the website you need to connect to.
usersApi.selectBasePath('https://my-custom-domain.com');

Example

Here is a basic functionning example:

async function listUsers(): Promise<Void> {
    try {
        const usersApi = new UsersApi();

        await usersApi.initialize(); // should be called only once per Api.

        const { data: { items } } = await usersApi.listUsers();

        console.log(items);
    } catch(error) {
      // process error
  }
}