Vascular Javascript SDK
The Vascular Js SDK allows using Vascular's APIs in Javascript based applications.
Installation
npm i -S vascular-js
Or
yarn add vascular-js
Usage
import Vascular, { Language } from 'vascular-js';
const vascular = new Vascular("APP_KEY", "USER_ID", [Language.enUk]);
const user = await vascular.createUser("USER_ID")
const user = await vascular.getUser("USER_ID")
const inbox = await vascular.inbox();
const inbox = await vascular.inboxNext();
const message = await vascular.getMessageById("MESSAGE_ID");
vascular.readMessages(inbox.newMessagesIds);
vascular.openMessages(inbox.readMessagesIds);
vascular.deleteMessage(inbox.messages[0].uuid);
vascular.addTags(["music", "sport"]);
vascular.deleteTags(["music", "sport"]);
const tags = await vascular.tags();
Inbox data structure
{
messages: [INBOX-MESSAGE]
newMessagesIds: [STRING],
readMessagesIds: [STRING],
next: {
createdAt: TIMESTAMP
uuid: STRING
},
newInbox: INTEGER
}
Inbox message data structure
{
"uuid": STRING,
"status": INTEGER,
"message":{
"enUs":{
"title": STRING,
"body": STRING,
"media":{
"thumbnail": STRING,
"image": STRING"
},
"actions":{
"name": STRING,
"value": STRING
},
"metadata":{
"meta": STRING
},
"subTitle": STRING
"language": LANGUAGE-ENUM
}
},
"provider": PROVIDER-ENUM,
"createdAt": STRING,
"expdate": STRING
}
LANGUAGE-ENUM
{
enUs
enUk
nb
}
PROVIDER-ENUM
{
api
sfmc
dashboard
}