chatady-node
v1.1.3
Published
The `ChatADy` package is a Node.js wrapper for the ChatADy API, designed to facilitate easy interaction with ChatADy's services from Node.js applications. It offers methods to retrieve ad contents and send in messages.
Downloads
14
Readme
ChatADy Package for Node.js
The ChatADy
package is a Node.js wrapper for the ChatADy API, designed to facilitate easy interaction with ChatADy's services from Node.js applications. It offers methods to retrieve ad contents and send in messages.
Installation
You can install the ChatADy package using npm:
npm install chatady-node
Or using yarn:
yarn add chatady-node
Usage
Import the ChatADy
class from the package and initialize it with your publisher ID and key to start interacting with the ChatADy API.
Quick Start
Below is a quick example to help you get started:
import { ChatADy } from 'chatady-node';
// Initialize the ChatADy client
const client = new ChatADy('your_publisher_id', 'your_api_key');
// Send in chat message
client.newChat('unique_id_identifying_conversation', 'your_entry_message', 'boolean_human_or_bot')
.then(() => console.log('New chat message stored'))
.catch(error => console.error(error));
// Get ad contents
client.getContents('unique_id_identifying_conversation')
.then(response => console.log(response))
.catch(error => console.error(error));
Initializing the Client
To interact with the API, create an instance of ChatADy
:
const client = new ChatADy('your_publisher_id', 'your_api_key');
You can also pass additional options as the third argument to configure the client:
const options = { environment: 'production', noDelay: true, timeout: 1000 };
const client = new ChatADy('your_publisher_id', 'your_api_key', options);
Retrieving ad contents
To retrieve contents, use the getContents
method with the chat ID. You can also specify options for better targeting:
client.getContents('unique_id_identifying_conversation', { humansex: 'male', botsex: 'female' })
.then(response => console.log(response))
.catch(error => console.error(error));
Sending in a new chat message
To send in new chat message, use the newChat
method with the chat ID, entry message, and human identifier:
client.newChat('unique_id_identifying_conversation', 'Hello, ChatADy!', 'boolean_human_or_bot')
.then(() => console.log('New chat message stored'))
.catch(error => console.error(error));
Support
For issues, questions, or contributions, please open an issue on the GitHub repository.
License
This project is licensed under the MIT License - see the LICENSE file for details.