npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

workhubclient

v1.0.4

Published

WorkHub API client for conversational AI

Downloads

6

Readme

# 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');

Authenticating

Authenticate using your Workhub credentials to start making API calls:

await client.login('[email protected]', 'your_password');

Fetching Company Information

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

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

Managing Conversations

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);

Polling for Bot Messages

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);

Error Handling

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.

Contributing

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

License

This project is released under the MIT license.