hushh-button-test v0.1.12

Hushh Button SDK

This is a library for integrating Hushh Button to your ReactJS and NextJS websites and web applications

Purpose:

The Hushh SDK provides functions to interact with the Hushh API and retrieve user data.

Getting Started

To begin using this component library, follow these steps:

1. Install NPM Library: Start by installing this using the following command.

npm i hushh-button

2. Generate API Key:

• Go to Hushh Button Brand Dashboard
• Sign up using your details
• Click on "Generate API Key"
• Copy the API Key

3. Import the Hushh Button: Import the Hushh Button UI Component into your project file using the following code:

import {HushhButton} from "hushh-button"

4. Create a questions array: Create an array with questions to be passed as a prop in the component: For ex:

const questionsArray = [
  {
    question: "What are your plans for today?",
    options: ["Our products", "Our team", "Get recruited at Hushh", "Partner with us"],
    answer: ""
  },
  {
    question: "What explains you the best?",
    options: ["User", "Agent", "Brand representative", "Fellow Developer", "Applicant"],
    answer: ""
  },
  {
    question: "What product you want to explore first?",
    options: ["Hushh Button (This very thing :)", "Hushh Wallet App", "Hushh For Students", "Browser Companion", "Vibe Search", "Concierge App", "Valet Chat", "Hushh Developer APIs"],
    answer: ""
  }
]

5. Passing the "questions" prop: Pass the array create as a prop in the "HushhButton" component like following:

<HushhButton questions={questionsArray} />

Functions:

getUserData(email: string, apiKey: string): Promise<any>

Retrieves user data from the Hushh API based on the provided email address.

• email: A string representing the email address of the user.
• apiKey: A string representing the API key used for authentication.
• Returns: A Promise that resolves to an object containing the user data.
• Throws an error if the request to fetch user data fails.

getAllUsers(brand: string, apiKey: string): Promise<any>

Retrieves user data for all users of a particular brand from the Hushh API.

• brand: A string representing the brand name.
• apiKey: A string representing the API key used for authentication.
• Returns: A Promise that resolves to an array containing user data for all users of the specified brand.
• Throws an error if the request to fetch user data fails.

Example Usage:

import { getUserData, getAllUsers } from 'hushh-sdk';

const email = 'example@example.com';
const apiKey = 'your_api_key';
const brand = 'your_brand_name';

(async () => {
  try {
    const userData = await getUserData(email, apiKey);
    console.log('User Data:', userData);
    
    const allUsersData = await getAllUsers(brand, apiKey);
    console.log('All Users Data:', allUsersData);
  } catch (error) {
    console.error('Error:', error.message);
  }
})();

Keywords

• Hushh

• Hushh Button

• Button

• HushhButton

• Hushh.ai