VoyadoEngage TypeScript SDK 1.0.0
Welcome to the VoyadoEngage SDK documentation. This guide will help you get started with integrating and using the VoyadoEngage SDK in your project.
Versions
- API version:
v2 - SDK version:
1.0.0
About the API
The Voyado Engage API enables developers to interact with Voyado's customer experience platform, allowing for the management and personalization of marketing efforts.
Table of Contents
Setup & Configuration
Supported Language Versions
This SDK is compatible with the following versions: TypeScript >= 4.8.4
Installation
To get started with the SDK, we recommend installing using npm:
npm install voyado_engage
Authentication
Access Token Authentication
The VoyadoEngage API uses an Access Token for authentication.
This token must be provided to authenticate your requests to the API.
Setting the Access Token
When you initialize the SDK, you can set the access token as follows:
const sdk = new VoyadoEngage({ token: 'YOUR_TOKEN' });
If you need to set or update the access token after initializing the SDK, you can use:
const sdk = new VoyadoEngage();
sdk.token = 'YOUR_TOKEN';
Services
The SDK provides various services to interact with the API.
Below is a list of all available services with links to their detailed documentation:
Models
The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
Below is a list of all available models with links to their detailed documentation:
License
This SDK is licensed under the MIT License.
See the LICENSE file for more details.
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs