@or-sdk/hitl

Installation:

$ npm i @or-sdk/hitl

Usage (except migrations API)

Example for inside of a flow usage

const HitlApi = require('@or-sdk/hitl').HITL;

// with direct api url
const hitlApi = new HitlApi({
  token: `FLOW ${this.config.flowToken}`,
  hitlUrl: this.config.env.HITL_API_URL,
});

// with service discovery(slower)
const hitlApi = new HitlApi({
  token: `FLOW ${this.config.flowToken}`,
  discoveryUrl: this.config.env.SERVICE_DISCOVERY_API_URL,
});

const contactRuleGroupsList = await hitlApi.contactRuleGroups.searchContactRuleGroups();

After initializing HitL SDK various parts of the SDK become available to be used to make requests to HitL API (all available HitL API part could be found in the api folder)

Examples

Basic usage

const HitlApi = require('@or-sdk/hitl').HITL;

const { agents, cannedMessages, filters } = new HitlApi({
  token: `FLOW ${this.config.flowToken}`,
  discoveryUrl: this.config.env.SERVICE_DISCOVERY_API_URL,
});

const agentsList = await agents.getAgents();
const cannedMessages = cannedMessages.getCannedMessages({ id });

Usage for HitL migrations API

Example for inside of a flow usage

const HitlMigrationsApi = require('@or-sdk/hitl').EKS;

// with direct api url
const hitlMigrationsApi = new HitlEksApi({
  token: `FLOW ${this.config.flowToken}`,
  hitlEksUrl: 'https://hitl.svc.<client-env>.api.onereach.ai',
});

// with service discovery(slower)
const hitlMigrationsApi = new HitlEksApi({
  token: `FLOW ${this.config.flowToken}`,
  discoveryUrl: this.config.env.SERVICE_DISCOVERY_API_URL,
});

await hitlMigrationsApi.migrations.runAllMigrations();
const status = await hitlMigrationsApi.migrations.getRunMigrationsStatus();