Note: This is a customized version of the vtiger library. It includes additional functions and features tailored for specific use cases. This library is built upon the original vtiger library to extend its functionality and provide more versatility.

Original vtiger Library

This library extends the functionality of the original vtiger library. You can find more information about the original library here: vtiger on npm.

Install

npm install ss-vtiger

Usage examples

let CRM = require('ss-vtiger')
let connection = new CRM.Connection('https://example.org', 'username', 'ACCESSKEY')

Login

connection.login()
 .then(()=>{
     //login successful
 })
 .catch((error)=>{
     //catch error
     console.error(error.message)
 })

Create

connection.login()
 .then(()=>connection.create('Product', {productname: 'Test'}))
 .then(product=>{
     //creation successful
     console.log(product)
 })
 .catch((error)=>{
     //catch error
     console.error(error.message)
 })

Retrieve

To retrieve an element you need to specify its entity id.

connection.login()
 .then(()=>connection.retrieve('14x404'))
 .then(element=>{
     console.log(element)
 })
 .catch((error)=>{
     //catch error
     console.error(error.message)
 })

Update

connection.login()
 .then(()=>connection.retrieve('14x404'))
 .then(element=>{
     element.unit_price=100
     return connection.update(element)
 })
 .then(element=>{
     console.log(element)
 })
 .catch((error)=>{
     //catch error
     console.error(error.message)
 })

Delete

connection.login()
 .then(()=>connection.delete('14x404'))
 .then(()=>{
     //deleted
 })
 .catch((error)=>{
     //catch error
     console.error(error.message)
 })

Query

connection.login()
 .then(()=>connection.query('SELECT * FROM Products WHERE unit_price >= 100;'))
 .then((products)=>{
     console.log(products)
 })
 .catch((error)=>{
     //catch error
     console.error(error.message)
 })

Others

Some other available functions:

• listTypes
• describe
• retrieveRelated
• relatedTypes
• queryRelated
• deleteRelated
• addRelated
• doVerifyEmail
• doGetAttachment
• doGetImage
• doDeleteAttachment
• doUploadAttachment
• doGetPolicy
• doAddDependent
• doListDependent
• doOtpEmail
• doGetFieldBlock