workhubclient

# Workhub API Client for Node.js

The Workhub API Client for Node.js is a comprehensive package designed to facilitate interactions with the Workhub API from Node.js applications. It provides a straightforward way to handle user authentication, retrieve company information, manage conversations, and send or receive messages within the Workhub platform.

## Quick Start

To begin using the Workhub API Client, you first need to install the package in your Node.js project:

```bash
npm install workhubclient --save

Then, initialize the client with your API credentials:

const WorkhubClient = require('WorkHubClient');

const client = new WorkhubClient();

By default, the client uses standard API endpoints. If you need to use custom endpoints, you can specify them when initializing the client:

const client = new WorkhubClient('https://api-admin.workhub.ai', 'https://api-teamgpt.workhub.ai');

Authenticate using your Workhub credentials to start making API calls:

await client.login('your_email@example.com', 'your_password');

Retrieve your company's information and automatically set the active company UUID:

const companyInfo = await client.getCompanyInfo();
console.log(companyInfo);

You can fetch existing conversations, create new ones, or send messages:

• Fetch Conversations

  const conversations = await client.fetchConversations();
  console.log(conversations);

• Create a New Conversation

  const newConversation = await client.createConversation();
  console.log(newConversation);

• Send a Message

  const messageResponse = await client.sendUserMessage('conversation_uuid', 'Hello, team!');
  console.log(messageResponse);

Poll for messages from a bot in a conversation, adjusting the timeout as necessary:

const botMessage = await client.pollForBotMessage('conversation_uuid', 'bot_message_uuid', 'user_message_uuid');
console.log(botMessage);

The client leverages JavaScript promises and async/await for error handling. Be sure to catch exceptions appropriately in your code to handle API call failures and other errors effectively.

We welcome contributions to the Workhub API Client for Node.js. Feel free to submit pull requests or issues to help improve the project.

This project is released under the MIT license.