@botmock-api/client


> nodejs client for interacting with the botmock api

1.x

master now tracks version 1.x of the package. For 0.1.x see branch legacy.

Table of Contents

* Overview
* Installation
* API
* Batcher
* batchRequest
* Botmock
* methods
* error handling

$3

> Note: In order to get started with this client, you'll need to get your access token from https://app.botmock.com. After you sign in, go to the Account Settings page by clicking on your profile picture on the top right. Then click on "Developer API" from the dropdown menu. Give your token a name, check the box, and hit "Create". Remember to note down your token since it will not be shown after it is generated.

``bash
npm i @botmock-api/client
`

$3

#### Batcher

`ts
import { Batcher } from "@botmock-api/client";

const config = {
token: process.env.BOTMOCK_TOKEN,
teamId: process.env.BOTMOCK_TEAM_ID,
projectId: process.env.BOTMOCK_PROJECT_ID,
boardId: process.env.BOTMOCK_BOARD_ID,
};

const { data } = await new Batcher(config).batchRequest([
"project",
"board",
"intents",
"entities",
"variables",
]);
`

##### batchRequest

batcher.batchRequest(string[]): Promise

Fetches an array of Botmock project resources using the fetcher

#### Botmock

`ts
import { Botmock } from "@botmock-api/client";

const client = new Botmock({ token: process.env.BOTMOCK_TOKEN });
`

##### Methods

client.getProject(opt): Promise

Gets project from a teamId and projectId within opt

`ts
const project = await client.getProject({ teamId, projectId });
`

client.getTeam(teamId): Promise

Gets team from a teamId

`ts
const team = await client.getTeam(teamId);
`

client.getBoard(opt): Promise

Gets board data from a teamId, projectId and boardId

`ts
const board = await client.getBoard({ teamId, projectId, boardId });
`

client.getIntents(opt): Promise

Gets all intents from a teamId and projectId

`ts
const intents = await client.getIntents({ teamId, projectId });
`

client.getVariables(opt): Promise

Gets all variables from a teamId and projectId

`ts
const variables = await client.getVariables({ teamId, projectId });
`

client.getEntities(opt): Promise

Gets all entities from a teamId and projectId

`ts
const entities = await client.getEntities({ teamId, projectId });
`

#### Error Handling

Events containing errors and also successes can be listened to in the following ways.

`ts
const client = new Botmock({ token: process.env.BOTMOCK_TOKEN });

client.on("error", ({ error, endpoint }: { error: FetchError, endpoint: string }) => {
console.error(error, endpoint);
});

client.on("success", ({ endpoint, timestamp }: { endpoint: string, timestamp: number }) => {
console.error(endpoint, timestamp);
});
`

$3

To test the package, simply enter the command below into the command line:

`shell
npm test
``